PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

0.3.1

PyPI

ads2inspire

Replace ADS citations with the appropriate INSPIRE ones in latex and bibtex

bibliographybibtexlatex
Published4 Dec 2020
Direct dependencies11
Transitive dependenciesNot calculated

README

Version 0.3.1 documentation

github PyPI version DOI Conda Version license

ads2inspire

Replace ADS citations with the appropriate INSPIRE ones in latex and bibtex

Why? Because ADS citation keys are not stable: they start out as something like 2019arXiv191207609s, and after being accepted to a journal turn into something like 2020PhRvD.101f4007S. This means you have to rewrite your latex, or you might even end up citing both entries!

Installation

From PyPI

In your Python environment run

python -m pip install ads2inspire

From conda-forge

In your conda environment run

conda install -c conda-forge ads2inspire

From this repository

In your Python environment from the top level of this repository run

python -m pip install .

From GitHub

In your Python environment run

python -m pip install "git+https://github.com/duetosymmetry/ads2inspire.git#egg=ads2inspire"

Usage

First latex/bibtex/latex your file, then run

ads2inspire [--backup] [--filter-type [ads|all]] [--fill-missing] auxfile.aux [texfile1.tex [texfile2.tex [...]]]

If your main tex file is named wonderful.tex, then your auxfile will be named wonderful.aux. ads2inspire will read the aux file, query INSPIRE, then rewrite all the texfiles named on the command line, and append to the first bibtex file named in auxfile. The option --backup will make the program write backups of the tex and bib files before rewriting them. The option --filter-type controls which keys to search for on INSPIRE: the default "ads" will only search for keys that look like ADS keys, while "all" will try all keys (aside from those that look like INSPIRE keys). The --fill-missing flag will query for INSPIRE-like keys that were referenced in the LaTeX source, but missing from the .bib file, and fill them into the .bib file if found.

Contributing

Note that I have done very little testing! Want to pitch in and help make this code better? Please fork and send me PRs!

TODO:

  • More testing
  • More filter types
  • more?

Citation

The preferred BibTeX entry for citation of ads2inspire is

@software{ads2inspire,
  author = "{Stein, Leo C. and Feickert, Matthew}",
  title = "{ads2inspire: v0.3.1}",
  version = {v0.3.1},
  doi = {10.5281/zenodo.3903987},
  url = {https://github.com/duetosymmetry/ads2inspire},
}

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 26

Native requirements
11 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
bibtexparser
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
bibtexparserruntime
click
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
click (>=6.0)runtime
black
Environment
{
  "extras": "",
  "marker": "extra == 'complete'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
black ; extra == 'complete'runtime
bumpversion
Environment
{
  "extras": "",
  "marker": "extra == 'complete'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
bumpversion ; extra == 'complete'runtime
check-manifest
Environment
{
  "extras": "",
  "marker": "extra == 'complete'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
check-manifest ; extra == 'complete'runtime
flake8
Environment
{
  "extras": "",
  "marker": "extra == 'complete'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
flake8 ; extra == 'complete'runtime
pre-commit
Environment
{
  "extras": "",
  "marker": "extra == 'complete'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pre-commit ; extra == 'complete'runtime
pydocstyle
Environment
{
  "extras": "",
  "marker": "extra == 'complete'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pydocstyle ; extra == 'complete'runtime
pytest
Environment
{
  "extras": "",
  "marker": "extra == 'complete'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pytest ; extra == 'complete'runtime
pytest-cov
Environment
{
  "extras": "",
  "marker": "extra == 'complete'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pytest-cov (>=2.5.1) ; extra == 'complete'runtime
twine
Environment
{
  "extras": "",
  "marker": "extra == 'complete'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
twine ; extra == 'complete'runtime
black
Environment
{
  "extras": "",
  "marker": "extra == 'develop'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
black ; extra == 'develop'runtime
bumpversion
Environment
{
  "extras": "",
  "marker": "extra == 'develop'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
bumpversion ; extra == 'develop'runtime
check-manifest
Environment
{
  "extras": "",
  "marker": "extra == 'develop'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
check-manifest ; extra == 'develop'runtime
flake8
Environment
{
  "extras": "",
  "marker": "extra == 'develop'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
flake8 ; extra == 'develop'runtime
pre-commit
Environment
{
  "extras": "",
  "marker": "extra == 'develop'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pre-commit ; extra == 'develop'runtime
pydocstyle
Environment
{
  "extras": "",
  "marker": "extra == 'develop'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pydocstyle ; extra == 'develop'runtime
pytest
Environment
{
  "extras": "",
  "marker": "extra == 'develop'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pytest ; extra == 'develop'runtime
pytest-cov
Environment
{
  "extras": "",
  "marker": "extra == 'develop'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pytest-cov (>=2.5.1) ; extra == 'develop'runtime
twine
Environment
{
  "extras": "",
  "marker": "extra == 'develop'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
twine ; extra == 'develop'runtime
pytest
Environment
{
  "extras": "",
  "marker": "extra == 'test'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pytest ; extra == 'test'runtime
pytest-cov
Environment
{
  "extras": "",
  "marker": "extra == 'test'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pytest-cov (>=2.5.1) ; extra == 'test'runtime
pydocstyle
Environment
{
  "extras": "",
  "marker": "extra == 'test'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
pydocstyle ; extra == 'test'runtime
check-manifest
Environment
{
  "extras": "",
  "marker": "extra == 'test'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
check-manifest ; extra == 'test'runtime
flake8
Environment
{
  "extras": "",
  "marker": "extra == 'test'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
flake8 ; extra == 'test'runtime
black
Environment
{
  "extras": "",
  "marker": "extra == 'test'",
  "requires_python": ">=3.6",
  "evaluation": "NOT_EVALUATED"
}
black ; extra == 'test'runtime

Distribution files

2 collected
ads2inspire-0.3.1-py2.py3-none-any.whl

bdist_wheel · 8.96 KB · Python py2.py3

Source file
ads2inspire-0.3.1.tar.gz

sdist · 10.3 KB · Python source

Source file

Repository

PENDING
duetosymmetry/ads2inspire

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:51 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:eb7d288af4e6ac46ebc8ebaef2121be86d500f52ab8ab2a2f6585fd7da5dc771

Other collected versions

View all collected versions →