Skip to main content

CSL styles.

Project description

https://img.shields.io/github/tag/inveniosoftware/citeproc-py-styles.svg https://img.shields.io/pypi/dm/citeproc-py-styles.svg https://img.shields.io/github/license/inveniosoftware/citeproc-py-styles.svg

About

This module is meant to be used as a static resources package, in order to make it easy to include the required Citation Style files (.csl) when using citeproc-py.

In order to avoid always installing ~40MB of files each time you include it in a project you could specify it as an extra in your setup.py, and only use it in the production environment or as an optional feature of your module. (Example setup.py)

The included files are originally hosted on the CSL Style Repository which belongs to the CSL Project

Note: The style files are referenced as a git submodule. This means that this repository/package is pinned on a specific commit of the CSL Style Repository, and thus may not include any fixes or new styles that may have been added. Next versions of this repository will of course ‘bump’ the styles version to the latest commit, but this will not happen on a scheduled basis for the time being.

Installation

citeproc-py-styles is on PyPI so all you need is:

pip install citeproc-py-styles

Usage

This is a minimal example of how one could use citeproc-py-styles to render a citation with citeproc-py:

from citeproc import (Citation, CitationItem, CitationStylesBibliography,
                      CitationStylesStyle, formatter)
from citeproc.source.json import CiteProcJSON
from citeproc_styles import get_style_filepath

csl_data = json.loads("...")
source = CiteProcJSON(csl_data)

style_path = get_style_filepath('apa')
style = CitationStylesStyle(style_path)

bib = CitationStylesBibliography(style, source, formatter.plain)
bib.register(Citation([CitationItem('data_id')]))
print(''.join(bib.bibliography()[0]))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

citeproc-py-styles-0.1.0.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

citeproc_py_styles-0.1.0-py2.py3-none-any.whl (8.2 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file citeproc-py-styles-0.1.0.tar.gz.

File metadata

File hashes

Hashes for citeproc-py-styles-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e695c8df59b023bb3724d7b0b727ae96574d6c04dc2a337894622302715c9211
MD5 9a1d0d2316794fd4d856ffd080597d23
BLAKE2b-256 61ce4caaa6d4ef3149e945caa58882a17bf641974b482d7c08930f55ac74dbc0

See more details on using hashes here.

File details

Details for the file citeproc_py_styles-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for citeproc_py_styles-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4e2d229b17aa2f7af4a218063a67fb12f19db1aec972cfd35834e7b7a756f5df
MD5 73dce5994530f5f9134aa3ec3fe264fb
BLAKE2b-256 27395f438a1bd5af4549e5956fab89dd9eba306d20052cc8233f472ddcbf5c97

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page