adrn / makecite

Generate latex + bibtex citation commands by looking at what packages are imported
MIT License
49 stars 6 forks source link
astrohackweek

makecite

alt text Build Status Coverage Status License badge-img DOI

Generate latex + bibtex citation commands by looking at what packages are imported in your Python code.

Installation

The recommended installation procedure is to use pip:

pip install makecite

To install the development version, you can pip install directly from this GitHub repository with:

pip install git+https://github.com/adrn/makecite

Examples

Get bibtex records for packages used in a single script, and store to a .bib file in the current working directory:

makecite my_script.py

Get bibtex records for packages used in all .py scripts in the current directory and store to a .bib file called "software_refs.bib":

makecite --ext=.py -o software_refs.bib .

Get bibtex records for packages used in all .py scripts and IPython notebook, .ipynb, files in two paths my_code and my_notebooks:

makecite --ext=.py --ext=.ipynb my_code my_notebooks

Get bibtex records for packages used in all .py scripts in the current directory and output a AAS journals \software{} tag:

makecite --ext=.py --aas .

Citing this script

If you use this script, please consider citing our Zenodo record:

@software{makecite,
  author       = {Adrian Price-Whelan and
                  Alexandar Mechev and
                  Brigitta Sipocz and
                  Griffin Hosseinzadeh and
                  jumeroag and
                  Eric Bellm},
  title        = {adrn/makecite v0.5},
  month        = nov,
  year         = 2019,
  publisher    = {Zenodo},
  version      = {v0.5},
  doi          = {10.5281/zenodo.3533303},
  url          = {https://doi.org/10.5281/zenodo.3533303}
}

License

Copyright 2018 the developers.

makecite is free software made available under the MIT License. For details see the LICENSE file.