| Name | flm-citations JSON |
| Version |
0.2.10
JSON |
| download |
| home_page | None |
| Summary | Support for citations in FLM (see flm-core package) |
| upload_time | 2024-08-21 16:49:04 |
| maintainer | None |
| docs_url | None |
| author | Philippe Faist |
| requires_python | <4.0,>=3.8 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Extra citations support for FLM
See the [FLM README file](https://github.com/phfaist/flm/blob/main/README.md).
Install with:
```bash
$ 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.
```yaml
---
$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](https://arxiv.org/), 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](https://github.com/brechtm/citeproc-py)
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](https://github.com/brechtm/citeproc-py/pull/132)
is considered.
### Metadata Fetching
Thank you to [arXiv](https://arxiv.org/) and
[doi.org](https://doi.org/) for use of their open access
interoperability.
Raw data
{
"_id": null,
"home_page": null,
"name": "flm-citations",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Philippe Faist",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/72/1d/1ef6a5f10d9b82774dff01c5df7ff6fbc5e71c7b4c0d4c2075c33216888b/flm_citations-0.2.10.tar.gz",
"platform": null,
"description": "# Extra citations support for FLM\n\nSee the [FLM README file](https://github.com/phfaist/flm/blob/main/README.md).\n\nInstall with:\n```bash\n$ pip install flm-citations\n```\n\nUse the additional config front matter in your FLM files to enable citations\nwith automatic citation retrieval from arXiv, DOI, etc.\n```yaml\n---\n$import:\n - pkg:flm_citations\nbibliography:\n - my-csl-bibliography.yaml\n---\n```\n\nThen process your file as usual with `flm`.\n\nThe bibliography file(s) you provide (in the example above,\n`my-csl-bibliography.yaml`) should be in CSL JSON or CSL YAML\nformat. They can easily be exported from Zotero, for example.\n\nWith the default configuration, the following citation keys are\nprocessed:\n- `\\cite{arXiv:XXXX.YYYYY}` - fetch citation information from\n the [arXiv](https://arxiv.org/), and from its corresponding\n DOI if applicable.\n- `\\cite{doi:XXX}` - fetch citation information using its DOI\n- `\\cite{manual:{X et al., Journal of Future Results (2034)}}` -\n manual citation text\n- `\\cite{bib:BibKey2023}` - use a citation from any of your\n bibliography files specified in your document front matter.\n \n### In case `citeproc` chokes on certain entries fetched by DOI\n\nSometimes automatically generated citeproc/JSON entries fetched\nthrough various available online APIs (doi.org, crossref.org,\narXiv.org, etc.) might not be fully conforming or exactly\nmatching the structure expected by the\n[`citeproc-py` citation formatting library](https://github.com/brechtm/citeproc-py)\nthat this project uses. If you run against such issues, you\nmight consider installing a patched version of the library that\nsmoothed out some issues I had in the past; you can install it\nwith\n```\n> pip install git+https://github.com/phfaist/citeproc-py.git@pr-branch\n```\nuntil my [upstream PR](https://github.com/brechtm/citeproc-py/pull/132)\nis considered.\n\n\n### Metadata Fetching\n\nThank you to [arXiv](https://arxiv.org/) and\n[doi.org](https://doi.org/) for use of their open access\ninteroperability.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Support for citations in FLM (see flm-core package)",
"version": "0.2.10",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8b0142eee6514cc9cdaa957074943bc673ad180fa4470492242db40f036653f",
"md5": "24cd45a007638cb028a4d2c4a5ae95b2",
"sha256": "60a11b6bb8dfa640ee2e7b30e796982a95b82cc01b1ebbc571a4d9252daf5819"
},
"downloads": -1,
"filename": "flm_citations-0.2.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24cd45a007638cb028a4d2c4a5ae95b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 20778,
"upload_time": "2024-08-21T16:49:03",
"upload_time_iso_8601": "2024-08-21T16:49:03.007578Z",
"url": "https://files.pythonhosted.org/packages/a8/b0/142eee6514cc9cdaa957074943bc673ad180fa4470492242db40f036653f/flm_citations-0.2.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "721d1ef6a5f10d9b82774dff01c5df7ff6fbc5e71c7b4c0d4c2075c33216888b",
"md5": "520c9e9d09cb7d60a6e6ee7bd76162cd",
"sha256": "0c89a8487e68122378e2a4d5273142b0569a95c6ca77fb8cf8a20de7cac99751"
},
"downloads": -1,
"filename": "flm_citations-0.2.10.tar.gz",
"has_sig": false,
"md5_digest": "520c9e9d09cb7d60a6e6ee7bd76162cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 17030,
"upload_time": "2024-08-21T16:49:04",
"upload_time_iso_8601": "2024-08-21T16:49:04.281818Z",
"url": "https://files.pythonhosted.org/packages/72/1d/1ef6a5f10d9b82774dff01c5df7ff6fbc5e71c7b4c0d4c2075c33216888b/flm_citations-0.2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 16:49:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "flm-citations"
}
