=======
Pybtex!
=======

.. container:: download-links

    - `Codeberg page`_
    - |download_url|_ (`what's new`_)
    - docs_


.. meta::
    :description: Pybtex is a BibTeX-compatible bibliography processor written in Python.
    :keywords: Python, BibTeX


Pybtex is a BibTeX-compatible bibliography processor written in Python.\ |br|
You can simply type ``pybtex`` instead of ``bibtex``.

.. rst-class:: doc-links

    For more details, see the docs_.


How Pybtex is different from BibTeX
===================================

Pybtex aims to be 100% compatible with BibTeX.
It accepts the same command line options, fully supports BibTeX's ``.bst``
styles and produces byte-identical output (if not, please `file a bug
report`_).

Additionally,

* Pybtex is Unicode-aware.

* Pybtex supports `bibliography formats`_ other than BibTeX.

* It is possible to write formatting styles in Python.\ |br|
  As a bonus, Pythonic styles can produce HTML, Markdown and other markup
  besides the usual LaTeX.

Pybtex also includes a `Python API`_ for managing
bibliographies from Python.


Download and install
====================

Release tarballs are available from our `PyPI page
<https://pypi.org/project/pybtex>`_.

Pybtex can be also installed with pip:

.. sourcecode:: bash

    pip install pybtex

Development sources are available from our `Git repository at Codeberg
<Codeberg page_>`_:

.. sourcecode:: bash

    git clone https://codeberg.org/pybtex/pybtex

If something goes wrong, just `file a bug report`_.

Have fun!


.. _file a bug report: https://codeberg.org/pybtex/pybtex/issues
.. _Codeberg page: https://codeberg.org/pybtex/pybtex
.. _docs: https://docs.pybtex.org/
.. _what's new: https://docs.pybtex.org/history.html
.. _Bibliography formats: https://docs.pybtex.org/formats.html
.. _Python API: https://docs.pybtex.org/api/index.html
