{ "info": { "author": "Brecht Machiels", "author_email": "brecht@mos6581.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Environment :: Other Environment", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: Education", "Intended Audience :: End Users/Desktop", "Intended Audience :: Legal Industry", "Intended Audience :: Other Audience", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Documentation", "Topic :: Printing", "Topic :: Software Development :: Documentation", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "===========\nciteproc-py\n===========\n\n.. image:: http://img.shields.io/pypi/v/citeproc-py.svg\n :target: https://pypi.python.org/pypi/citeproc-py\n :alt: PyPI\n\n.. image:: https://travis-ci.org/brechtm/citeproc-py.svg\n :target: https://travis-ci.org/brechtm/citeproc-py\n :alt: Build status\n\n.. image:: https://coveralls.io/repos/brechtm/citeproc-py/badge.svg?branch=master&service=github\n :target: https://coveralls.io/github/brechtm/citeproc-py?branch=master\n :alt: Code coverage\n\n.. image:: https://www.quantifiedcode.com/api/v1/project/61fcd880bcd04d478d659f2a8a1034ae/badge.svg\n :target: https://www.quantifiedcode.com/app/project/61fcd880bcd04d478d659f2a8a1034ae\n :alt: Code issues\n\nciteproc-py is a `CSL`_ processor for Python. It aims to implement the\n`CSL 1.0.1 specification`_. citeproc-py can output styled citations and\nbibliographies in a number of different output formats. Currently\nsupported are plain text, reStructuredText and HTML. Other formats can\nbe added easily.\n\nciteproc-py uses `semantic versioning`_. Currently, its major version\nnumber is still at 0, meaning the API is not yet stable. However, you\nshould not expect to see any major API changes soon.\n\n.. _CSL: http://citationstyles.org/\n.. _CSL 1.0.1 specification: http://citationstyles.org/downloads/specification.html\n.. _semantic versioning: http://semver.org/\n\n\nRequirements\n------------\n\nciteproc-py was originally developed for Python 3 but now also runs on Python\n2.6+. It depends on `lxml`_ for parsing and navigating the CSL style and locale\nfiles.\n\n.. _lxml: http://lxml.de/\n\n\nInstallation\n------------\n\nThe recommended way of installing citeproc-py is by using `pip`_::\n\n pip install citeproc-py\n\nIf lxml isn't installed, pip will try to install it for you.\n\n.. _pip: https://pip.pypa.io/en/latest/\n\nIf you insist, you can manually install citeproc-py from distribution packages\nhosted at `PyPI`_. Please ignore the release archives offered by GitHub.\n\n.. _PyPI: https://pypi.python.org/pypi/citeproc-py/\n\n\nGetting Started\n---------------\n\nTo get started with citeproc-py, take a look at the examples under\n``examples/``. Two examples are provided, one parsing references from a\nJSON representation of references as supported by citeproc-js, another\nparsing the references from a BibTeX file. Both show and explain how to\ncite references and render the bibliography.\n\n\nCSL Compatibility\n-----------------\n\nCurrently, citeproc-py passes almost 60% of the (relevant) tests in the\n`citeproc-test suite`_. However, it is more than 60% complete, as\nciteproc-py doesn't take care of double spaces and repeated punctuation\nmarks yet, making a good deal of the tests fail. In addition, the\nfollowing features have not yet been implemented (there are probably\nsome I forgot though):\n\n- disambiguation/year-suffix\n- et-al-subsequent-min/et-al-subsequent-use-first\n- collapsing\n- punctuation-in-quote\n- display\n\nAlso, some `citeproc-js`_ functionality that is not part of the CSL spec\nis not (yet) supported:\n\n- raw dates\n- static-ordering\n- literal names\n\n.. _citeproc-test suite: https://bitbucket.org/bdarcus/citeproc-test\n.. _citeproc-js: http://bitbucket.org/fbennett/citeproc-js/wiki/Home\n\n\nRunning the Tests\n-----------------\n\nFirst clone the `citeproc-test suite`_ so that it sits next to the\nciteproc-py directory. Now you can run ``citeproc-test.py`` (in the ``tests``\ndirectory). Run ``citeproc-test.py --help`` to see its usage information.\n\n.. _citeproc-test suite: https://bitbucket.org/bdarcus/citeproc-test\n\n\nChangelog\n---------\n\nRelease 0.4.0 (2017-06-23)\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nNew features:\n\n* allow specifying the encoding of a BibTeX database file (#20 and #25)\n* BibTeX 'month' field: support integers and \" \" values\n* BibTeX 'pages' field: support \"10\", \"10+\", \"10-12\" and \"10--12\" formats\n* BibTeX entry types: map the non-standard 'thesis' and 'report' entries\n* update the CSL schema to version 1.0.1 (#5)\n* update the CSL locales to commit 49bf3fc0\n\nBug fixed:\n\n* avoid crash when there is nothing to affix (David Lesieur)\n* fix BibTeX month to CSL month mapping (#24)\n* strip leading/trailing whitespace from BibTeX values (#37)\n\nRelease 0.3.0 (2014-11-07)\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nMajor improvements to the BibTeX parser:\n\n* split names into parts and assign them to the equivalent CSL name parts\n* fixed handling of accent macros and escaped characters\n* more compatible (La)TeX macro handling in general (but still basic)\n* handle standard Computer Modern ligatures such as --, ---, and <<\n* added unit tests for the BibTeX and LaTeX parsers\n\nOther changes:\n\n* disable RelaxNG validation of CSL styles by default (API change)\n\nRelease 0.2.0 (2014-10-25)\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* bad cite callback function can determine how a bad cite is displayed (hetsch)\n* added option to disable RelaxNG validation (Jasper Op de Coul)\n* distutils was replaced with setuptools (Joshua Carp)\n* bug fixes (Yaroslav Halchenko, David Lesieur)\n* CitationStylesBibliography.bibliography() now returns the list of entries\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/brechtm/citeproc-py", "keywords": "csl citation html rst bibtex xml", "license": "2-clause BSD License", "maintainer": "", "maintainer_email": "", "name": "citeproc-py", "package_url": "https://pypi.org/project/citeproc-py/", "platform": "", "project_url": "https://pypi.org/project/citeproc-py/", "project_urls": { "Homepage": "https://github.com/brechtm/citeproc-py" }, "release_url": "https://pypi.org/project/citeproc-py/0.4.0/", "requires_dist": null, "requires_python": "", "summary": "Citations and bibliography formatter", "version": "0.4.0" }, "last_serial": 2973772, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "b8edfd642e49e45538cf68707957759c", "sha256": "e3f500fa8d04cf05b500bf3fbc536e73e45bd3fe4a8d177122ce3e5a287b712b" }, "downloads": -1, "filename": "citeproc-py-0.1.0.win32.exe", "has_sig": false, "md5_digest": "b8edfd642e49e45538cf68707957759c", "packagetype": "bdist_wininst", "python_version": "any", "requires_python": null, "size": 352774, "upload_time": "2013-09-16T20:03:59", "url": "https://files.pythonhosted.org/packages/a7/d3/9c404c2371a27e389438fd2bd7b1287b0161f370f7bd67d57665d576e1cd/citeproc-py-0.1.0.win32.exe" }, { "comment_text": "", "digests": { "md5": "cdb3b32b1d8f1625eb9b25f3406dc989", "sha256": "aee987cfbcbe6d8e9f4055314d80549ac6b353b4fbc9a8a7f88100fc8fa2157a" }, "downloads": -1, "filename": "citeproc-py-0.1.0.zip", "has_sig": false, "md5_digest": "cdb3b32b1d8f1625eb9b25f3406dc989", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 158613, "upload_time": "2013-09-16T20:03:53", "url": "https://files.pythonhosted.org/packages/1c/b5/0d0852d044ca5a415a47565bb1e145dbc42e7401b788546f23dbb18cd3f5/citeproc-py-0.1.0.zip" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "7cee46375084fb0a709057043eff5361", "sha256": "1bc46701352ed0435c5f5ae03aa73c7f283f874080f2aceba018b8ce408338d9" }, "downloads": -1, "filename": "citeproc_py-0.2.0-py2.7.egg", "has_sig": false, "md5_digest": "7cee46375084fb0a709057043eff5361", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 199411, "upload_time": "2014-10-25T10:07:09", "url": "https://files.pythonhosted.org/packages/23/62/a0c5300a109cc2f2f649e82367c1a83d1fc7e2ae9baa058c76c5930e2b60/citeproc_py-0.2.0-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "c684f0cf92bb787eba8158d62c26fdcf", "sha256": "26a17fce814d6828ba4b696c63dc0171ecdba984f9f0fe3892368a1c75ba11dc" }, "downloads": -1, "filename": "citeproc_py-0.2.0-py2-none-any.whl", "has_sig": false, "md5_digest": "c684f0cf92bb787eba8158d62c26fdcf", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 159410, "upload_time": "2014-10-25T10:36:10", "url": "https://files.pythonhosted.org/packages/ab/f4/8b6229a42c8307b092bf0a41f79417097862711d81a9e6104462d0709fd8/citeproc_py-0.2.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6fa6e3ed6616eb77febdeb7ff9c4580b", "sha256": "872c9ead80dd9e0ea20fae58317d0f567e935fcf20f4525fcd633ae112a34486" }, "downloads": -1, "filename": "citeproc_py-0.2.0-py3.4.egg", "has_sig": false, "md5_digest": "6fa6e3ed6616eb77febdeb7ff9c4580b", "packagetype": "bdist_egg", "python_version": "3.4", "requires_python": null, "size": 202187, "upload_time": "2014-10-25T10:08:38", "url": "https://files.pythonhosted.org/packages/b3/88/a6fa0655d518938761912e54c87a27ea8a946c45fa6709190e22cb7ede06/citeproc_py-0.2.0-py3.4.egg" }, { "comment_text": "", "digests": { "md5": "c623f1823af2b0831dbd3ff62e0b8456", "sha256": "51ecb6d060e84578645b00fefed358385d3a350c72995451a114b5c355c7ca98" }, "downloads": -1, "filename": "citeproc_py-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "c623f1823af2b0831dbd3ff62e0b8456", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 159435, "upload_time": "2014-10-25T10:36:47", "url": "https://files.pythonhosted.org/packages/5d/2d/4d546285fec631e3018ca88aa12daa9b04e65d1b2267265addf713769610/citeproc_py-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e9709b97b549c341ee5ab161f71adcb3", "sha256": "0e0b6c84be6be6a9e9be65e973ec8db3dea401329a5bad29bf87bb6f0443c140" }, "downloads": -1, "filename": "citeproc-py-0.2.0.tar.gz", "has_sig": false, "md5_digest": "e9709b97b549c341ee5ab161f71adcb3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 89499, "upload_time": "2014-10-25T10:07:05", "url": "https://files.pythonhosted.org/packages/7d/02/307fedd505d35ea3cde9c7606cc81344372377e8526b200aa12ee0d7564c/citeproc-py-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "f32f775333a120a3a96c019a06696471", "sha256": "bf6db2a57ad71e2aa1b71e2326672789158d8fcc24a67426b2af88d857066d86" }, "downloads": -1, "filename": "citeproc_py-0.3.0-py2.7.egg", "has_sig": false, "md5_digest": "f32f775333a120a3a96c019a06696471", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 207963, "upload_time": "2014-11-07T15:38:02", "url": "https://files.pythonhosted.org/packages/2a/73/755147c73f1e0831564015acd8738eef49e5b36bfc36cf50f259cf9ce846/citeproc_py-0.3.0-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "acfeaa820b9517b78df6608d79e30882", "sha256": "07dddd9ca6730e84c3795893d8692ecb4456b7319818497c6410d5d68ed9dbb7" }, "downloads": -1, "filename": "citeproc_py-0.3.0-py2-none-any.whl", "has_sig": false, "md5_digest": "acfeaa820b9517b78df6608d79e30882", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 162404, "upload_time": "2014-11-07T15:38:06", "url": "https://files.pythonhosted.org/packages/47/ef/770a11c1226189f219727ab6bc88c170eeeb5ddb3cba1566668c670c39af/citeproc_py-0.3.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "92701a03310035d40c6d709ab1657850", "sha256": "acbef90d16731320af5b2abf88fb31cc0bee30c29110f113639843fe8f1b8447" }, "downloads": -1, "filename": "citeproc_py-0.3.0-py3.4.egg", "has_sig": false, "md5_digest": "92701a03310035d40c6d709ab1657850", "packagetype": "bdist_egg", "python_version": "3.4", "requires_python": null, "size": 210985, "upload_time": "2014-11-07T15:36:42", "url": "https://files.pythonhosted.org/packages/9e/61/c5a0e3551d938cf07112914d5f91f71749b9f2c1a85741e6e7202bf182ee/citeproc_py-0.3.0-py3.4.egg" }, { "comment_text": "", "digests": { "md5": "08f277ab0af7d38af8c45342379ac692", "sha256": "08444fd263f84af4fb3a50ea74a2ce50a119f5e5186f022271c83d0615f107b7" }, "downloads": -1, "filename": "citeproc_py-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "08f277ab0af7d38af8c45342379ac692", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 162425, "upload_time": "2014-11-07T15:36:52", "url": "https://files.pythonhosted.org/packages/06/1d/f55e49699ab6e88d371d61bbf900e6f6406e2fb0bb2ca147a487c3dc6ba6/citeproc_py-0.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e23da3b6c75485f82e1e5a725235731e", "sha256": "dbd484c66e985330d51f782c4ef0f17489da641661f80d8caf6f9ff779ff6ac1" }, "downloads": -1, "filename": "citeproc-py-0.3.0.tar.gz", "has_sig": false, "md5_digest": "e23da3b6c75485f82e1e5a725235731e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 91543, "upload_time": "2014-11-07T15:36:37", "url": "https://files.pythonhosted.org/packages/1a/f5/761e30e9470525b197594a7e9008a9f456223d7d34bfeea08772f909eeed/citeproc-py-0.3.0.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "50a8065e57acc3bcd059fedd43b06669", "sha256": "ee1569e8b1f2c057c7893bbb067986bc362a6c861009d310700a12a1a0107b57" }, "downloads": -1, "filename": "citeproc_py-0.4.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "50a8065e57acc3bcd059fedd43b06669", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 155887, "upload_time": "2017-06-23T13:58:29", "url": "https://files.pythonhosted.org/packages/22/9a/d3383c4af068d0e82ec71fd88c74ae55e85b49c0acaf9951b3075c8a3b40/citeproc_py-0.4.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "017535e49bb57cbf80d60f0cc4c0fa86", "sha256": "ed513dbc76f782b5e98126d6bebbd1284841fcf199ec9dda552e2bce864adadf" }, "downloads": -1, "filename": "citeproc-py-0.4.0.tar.gz", "has_sig": false, "md5_digest": "017535e49bb57cbf80d60f0cc4c0fa86", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 109786, "upload_time": "2017-06-23T13:58:26", "url": "https://files.pythonhosted.org/packages/7d/dc/e905fdd6fea087b0cae77b87a28aa0ea26899946e7f9f2537c9cf618a23c/citeproc-py-0.4.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "50a8065e57acc3bcd059fedd43b06669", "sha256": "ee1569e8b1f2c057c7893bbb067986bc362a6c861009d310700a12a1a0107b57" }, "downloads": -1, "filename": "citeproc_py-0.4.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "50a8065e57acc3bcd059fedd43b06669", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 155887, "upload_time": "2017-06-23T13:58:29", "url": "https://files.pythonhosted.org/packages/22/9a/d3383c4af068d0e82ec71fd88c74ae55e85b49c0acaf9951b3075c8a3b40/citeproc_py-0.4.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "017535e49bb57cbf80d60f0cc4c0fa86", "sha256": "ed513dbc76f782b5e98126d6bebbd1284841fcf199ec9dda552e2bce864adadf" }, "downloads": -1, "filename": "citeproc-py-0.4.0.tar.gz", "has_sig": false, "md5_digest": "017535e49bb57cbf80d60f0cc4c0fa86", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 109786, "upload_time": "2017-06-23T13:58:26", "url": "https://files.pythonhosted.org/packages/7d/dc/e905fdd6fea087b0cae77b87a28aa0ea26899946e7f9f2537c9cf618a23c/citeproc-py-0.4.0.tar.gz" } ] }