Welcome to libJournal's documentation!
======================================

.. toctree::
   :maxdepth: 3
   :caption: An open source library that lets you create and manage a digital journal:

   changelog
   version_documentation
   roadmap


Libjournal is a free and open-source library that is currently in development. It allows you to create a digital journal, add, delete, edit, and search entries that are organized by time, date, name, and unique identifier numbers. Many features are to come, and for a list of coming features visit the roadmap!

Here is a simple example of libJournal (2.0.0)::

  # Import the library
  from libjournal.libj import libJournal

  # Create new object
  libj = libJournal()

  # Create the database in which the data is stored and set it as the location
  libj.setup_db("meow.db")
  libj.set_db_location("meow.db")

  # Creates an entry with the name "Meow" and the content "Cats". The time, date, and identifier number are automatically added
  libj.entry_new("Meow", "I like cats")

Features
--------
 - Create a database, format, and set location *once*
 - Add entries with titles, can be repeated, and content
 - Search up entries using name, date, or identifier
 - Read entries using name, date, or identifier
 - Delete entries based on unique identifier

Installation
------------

Install libjournal through pip by running::

  pip install libjournal

You can also download libJournal manually through Github releases, or through pypi:
 - Github_
 - pypi_

 .. _Github: https://github.com/undystopia/libjournal/releases
 .. _pypi: https://pypi.python.org/pypi/libjournal/2.1.0

Contribute
----------

- Issue Tracker: https://github.com/undystopia/libjournal/issues
- Source Code: https://github.com/undystopia/libjournal

License
-------

libJournal is licensed under GPL 3.0

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`