citeproc-py is a CSL processor for Python. It aims to implement the CSL 1.0.1 specification. citeproc-py can output styled citations and bibliographies in a number of different output formats. Currently supported are plain text, reStructuredText and HTML. Other formats can be added easily.
citeproc-py uses semantic versioning. Currently, its major version number is still at 0, meaning the API is not yet stable. However, you should not expect to see any major API changes soon.
Call for Maintainers
Unfortunately, the current maintainers lack the spare time to properly support citeproc-py at the moment. Even though there are not many bugs being reported, these are currently not being addressed. If you are an active user of this package, consider volunteering to help with maintainership. Please create a ticket to get the ball rolling. Thanks!
citeproc-py supports Python 3.6 and up. It depends on lxml for parsing and navigating the CSL style and locale files.
The recommended way of installing citeproc-py is by using pip:
pip install citeproc-py
If lxml isn't installed, pip will try to install it for you.
If you insist, you can manually install citeproc-py from distribution packages hosted at PyPI. Please ignore the release archives offered by GitHub.
To get started with citeproc-py, take a look at the examples under
examples/. Two examples are provided, one parsing references from a
JSON representation of references as supported by citeproc-js, another
parsing the references from a BibTeX file. Both show and explain how to
cite references and render the bibliography.
Currently, citeproc-py passes almost 60% of the (relevant) tests in the citeproc-test suite. However, it is more than 60% complete, as citeproc-py doesn't take care of double spaces and repeated punctuation marks yet, making a good deal of the tests fail. In addition, the following features have not yet been implemented (there are probably some I forgot though):
Also, some citeproc-js functionality that is not part of the CSL spec is not (yet) supported:
- raw dates
- literal names
Running the Tests
First clone the citeproc-test suite so that it sits next to the
citeproc-py directory. Now you can run
citeproc-test.py (in the
citeproc-test.py --help to see its usage information.