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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flm_citations-0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 297881da28c9049b8ac67d7fa3c79f23f402c4ea041438ad38389ba68f090482 |
|
MD5 | 9df5f8f0b2f25f62a08fd96b2176621e |
|
BLAKE2b-256 | b80f2111e97a7b9990d18988b4551c29b2d81b9a0ab9f94ea2fd7f7acd75c388 |