==================================
Welcome to BibLib's documentation!
==================================

*A python library to handle BibTeX bibliographic data.*


.. toctree::
    :hidden:
    :maxdepth: 2
    :caption: Contents

    intro
    tutorial
    Package API <biblib>
    changelog
    license


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

You can install the latest version from the `Python package index`_.
From the command line, enter (in some cases you have to precede the command with :command:`sudo`):


.. code-block:: bash

	$ pip install biblib


More information about the usage and how to get and install ``pip`` you find in the `PIP documentation`_.

To install it manual, `download`_ the archive, unpack it, and type
(in some cases you have to precede the command with :command:`sudo`):


.. code-block:: bash

	$ python setup.py install

Requirements
------------

* Python 2.7, 3.3+
* `pybtex`_ for BibTeX parsing
* `isbnlib`_ for retrieving citation entries via ISBN number
* `python-magic`_ for detecting character encoding
* `unidecode`_ for robust generation of citation-keys


Thanks
------

Thanks to `Jackalope`_ for his support while planing and designing *biblib*,
and for his contribution of the :ref:`Storage Module <storageMod>`.


Links
-----

* The official resource of `BibTeX at CTAN`_.
* The BibTeX documentation: `BibTeXing`_ by Oren Patashnik.
* `BibTeX at Wikipedia`_
* My favorite GUI tool to manage my bibliography is `JabRef`_.


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

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


.. _Python package index: https://pypi.python.org/pypi
.. _download: https://pypi.python.org/pypi/biblib
.. _isbnlib: https://pypi.python.org/pypi/isbnlib
.. _sourceforge: https://sourceforge.net/projects/pybiblib
.. _python-magic: https://pypi.python.org/pypi/python-magic
.. _PIP documentation: https://pip.pypa.io/en/stable/#
.. _Jackalope: http://www.jackalope.eu
.. _bibtex.org: http://www.bibtex.org
.. _BibTeX at CTAN: https://www.ctan.org/pkg/bibtex
.. _BibTeXing: http://ftp.fau.de/ctan/biblio/bibtex/base/btxdoc.pdf
.. _BibTeX at Wikipedia: https://en.wikipedia.org/wiki/BibTeX
.. _JabRef: http://www.jabref.org
.. _pybtex: https://pypi.python.org/pypi/pybtex/
.. _unidecode: https://pypi.python.org/pypi/Unidecode