citeproc-py
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.
Requirements
citeproc-py has been developed for Python 3 but also runs on Python 2.6+. It depends on lxml for parsing and navigating the CSL style and locale files.
Getting Started
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.
CSL Compatibility
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):
disambiguation/year-suffix
et-al-subsequent-min/et-al-subsequent-use-first
collapsing
punctuation-in-quote
display
Also, some citeproc-js functionality that is not part of the CSL spec is not (yet) supported:
raw dates
static-ordering
literal names
Running the Tests
First clone the citeproc-test suite so that it sits next to the citeproc-py directory. Then run the processor.py script to generate the test fixtures (using Python 2.x). After that, you can run citeproc-test.py (in the tests directory). Run citeproc-test.py --help to see its usage information.
Metadata
Release files for citeproc-py 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| citeproc-py-0.3.0.tar.gz | 91.5 kB | Without provenance | Details for citeproc-py-0.3.0.tar.gz |
Built distributions (wheels)
| File | Actions Reset | |||
|---|---|---|---|---|
| citeproc_py-0.3.0-py3.4.egg | Legacy Egg format | - | - | Details for citeproc_py-0.3.0-py3.4.egg |
| citeproc_py-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for citeproc_py-0.3.0-py3-none-any.whl |
| citeproc_py-0.3.0-py2.7.egg | Legacy Egg format | - | - | Details for citeproc_py-0.3.0-py2.7.egg |
| citeproc_py-0.3.0-py2-none-any.whl | Python 2 | none | any | Details for citeproc_py-0.3.0-py2-none-any.whl |
Total release size: 835.3 kB
Release files / citeproc-py-0.3.0.tar.gz
| Download URL | citeproc-py-0.3.0.tar.gz |
|---|---|
| Size | 91.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dbd484c66e985330d51f782c4ef0f17489da641661f80d8caf6f9ff779ff6ac1
|
|
BLAKE2b-256 checksum How to use checksums |
1af5761e30e9470525b197594a7e9008a9f456223d7d34bfeea08772f909eeed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / citeproc_py-0.3.0-py3.4.egg
| Download URL | citeproc_py-0.3.0-py3.4.egg |
|---|---|
| Size | 211.0 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
acbef90d16731320af5b2abf88fb31cc0bee30c29110f113639843fe8f1b8447
|
|
BLAKE2b-256 checksum How to use checksums |
9e61c5a0e3551d938cf07112914d5f91f71749b9f2c1a85741e6e7202bf182ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / citeproc_py-0.3.0-py3-none-any.whl
| Download URL | citeproc_py-0.3.0-py3-none-any.whl |
|---|---|
| Size | 162.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
08444fd263f84af4fb3a50ea74a2ce50a119f5e5186f022271c83d0615f107b7
|
|
BLAKE2b-256 checksum How to use checksums |
061df55e49699ab6e88d371d61bbf900e6f6406e2fb0bb2ca147a487c3dc6ba6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / citeproc_py-0.3.0-py2.7.egg
| Download URL | citeproc_py-0.3.0-py2.7.egg |
|---|---|
| Size | 208.0 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
bf6db2a57ad71e2aa1b71e2326672789158d8fcc24a67426b2af88d857066d86
|
|
BLAKE2b-256 checksum How to use checksums |
2a73755147c73f1e0831564015acd8738eef49e5b36bfc36cf50f259cf9ce846
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / citeproc_py-0.3.0-py2-none-any.whl
| Download URL | citeproc_py-0.3.0-py2-none-any.whl |
|---|---|
| Size | 162.4 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
07dddd9ca6730e84c3795893d8692ecb4456b7319818497c6410d5d68ed9dbb7
|
|
BLAKE2b-256 checksum How to use checksums |
47ef770a11c1226189f219727ab6bc88c170eeeb5ddb3cba1566668c670c39af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for citeproc-py 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.