Skip to main content

Support for citations in FLM (see flm-core package)

Project description

Extra citations support for FLM

See the FLM README file.

Install with:

$ pip install flm-citations

Use the additional config front matter in your FLM files to enable citations with automatic citation retrieval from arXiv, DOI, etc.

---
$import:
  -  pkg:flm_citations
bibliography:
  - my-csl-bibliography.yaml
---

Then process your file as usual with flm.

The bibliography file(s) you provide (in the example above, my-csl-bibliography.yaml) should be in CSL JSON or CSL YAML format. They can easily be exported from Zotero, for example.

With the default configuration, the following citation keys are processed:

  • \cite{arXiv:XXXX.YYYYY} - fetch citation information from the arXiv, and from its corresponding DOI if applicable.
  • \cite{doi:XXX} - fetch citation information using its DOI
  • \cite{manual:{X et al., Journal of Future Results (2034)}} - manual citation text
  • \cite{bib:BibKey2023} - use a citation from any of your bibliography files specified in your document front matter.

In case citeproc chokes on certain entries fetched by DOI

Sometimes automatically generated citeproc/JSON entries fetched through various available online APIs (doi.org, crossref.org, arXiv.org, etc.) might not be fully conforming or exactly matching the structure expected by the citeproc-py citation formatting library that this project uses. If you run against such issues, you might consider installing a patched version of the library that smoothed out some issues I had in the past; you can install it with

> pip install git+https://github.com/phfaist/citeproc-py.git@pr-branch

until my upstream PR is considered.

Metadata Fetching

Thank you to arXiv and doi.org for use of their open access interoperability.

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

flm_citations-0.2.10.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

flm_citations-0.2.10-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

Details for the file flm_citations-0.2.10.tar.gz.

File metadata

  • Download URL: flm_citations-0.2.10.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.8 Darwin/23.5.0

File hashes

Hashes for flm_citations-0.2.10.tar.gz
Algorithm Hash digest
SHA256 0c89a8487e68122378e2a4d5273142b0569a95c6ca77fb8cf8a20de7cac99751
MD5 520c9e9d09cb7d60a6e6ee7bd76162cd
BLAKE2b-256 721d1ef6a5f10d9b82774dff01c5df7ff6fbc5e71c7b4c0d4c2075c33216888b

See more details on using hashes here.

File details

Details for the file flm_citations-0.2.10-py3-none-any.whl.

File metadata

  • Download URL: flm_citations-0.2.10-py3-none-any.whl
  • Upload date:
  • Size: 20.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.8 Darwin/23.5.0

File hashes

Hashes for flm_citations-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 60a11b6bb8dfa640ee2e7b30e796982a95b82cc01b1ebbc571a4d9252daf5819
MD5 24cd45a007638cb028a4d2c4a5ae95b2
BLAKE2b-256 a8b0142eee6514cc9cdaa957074943bc673ad180fa4470492242db40f036653f

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