Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.16 KB

README.rst

File metadata and controls

55 lines (33 loc) · 2.16 KB

python-bibtexparser

Python 3 library to parse bibtex files.

Our documentation includes the installation procedure, a tutorial, the API and advices to report a bug: Documentation on readthedocs.io

Please, read the changelog before upgrading regarding API modifications.

Dual license (at your choice):

  • LGPLv3.
  • BSD

See COPYING for details.

The original source code was part of bibserver from OKFN. This project is released under the AGPLv3. OKFN and the original authors kindly provided the permission to use a subpart of their project (ie the bibtex parser) under LGPLv3. Many thanks to them!

The parser evolved to a new core based on pyparsing.

Since 2022, after a long stale period, this library has a new maintainer (@MiWeiss).

Version 1.x, is trusted and used by more than 1300 projects, with much of its code being ~10 years old. Our primary objective in maintaining v1.x is to provide stability and backwards compatibility to these projects - such that they can safely and easily migrate to new versions.

Still, there's much room for large-scale improvements and changes to modernize bibtexparser. Hence, we are working on a new version 2.0.0 which is a complete rewrite of the library, providing amongst other the following advantages:

  • Order of magnitudes faster
  • Type-Hints and extensive documentation
  • Easily customizable parsing and writing
  • Access to raw, unparsed bibtex.
  • Fault-Tolerant: Able to parse files with syntax errors
  • Massively simplified, robuster handling of de- and encoding (special chars, ...).

Check out the v2 dev branch and the v2 coordination issue to get a sneak preview. Also - if you're keen - we're always looking for contributors. Do not hesitate to get in contact with us.