https://github.com/adrn/makecite

Generate latex + bibtex citation commands by looking at what packages are imported
https://github.com/adrn/makecite

astrohackweek

Last synced: 2 days ago
JSON representation

Generate latex + bibtex citation commands by looking at what packages are imported

• Host: GitHub
• URL: https://github.com/adrn/makecite
• Owner: adrn
• License: mit
• Created: 2018-08-02T12:36:01.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2020-09-17T11:57:07.000Z (about 4 years ago)
• Last Synced: 2024-10-31T22:32:28.498Z (9 days ago)
• Topics: astrohackweek
• Language: Python
• Size: 76.2 KB
• Stars: 49
• Watchers: 7
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
# makecite

[![alt text](http://apmechev.com/img/git_repos/pylint/makecite.svg "pylint score")](https://github.com/apmechev/pylint-badge)

[![Build Status](https://travis-ci.org/adrn/makecite.svg?branch=master)](https://travis-ci.org/adrn/makecite)

[![Coverage Status](https://coveralls.io/repos/github/adrn/makecite/badge.svg?branch=master)](https://coveralls.io/github/adrn/makecite?branch=master)

[![License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/adrn/makecite/blob/master/LICENSE)

![badge-img](https://img.shields.io/badge/Made%20at-%23AstroHackWeek-8063d5.svg?style=flat)

[![DOI](https://zenodo.org/badge/143292502.svg)](https://zenodo.org/badge/latestdoi/143292502)

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](https://zenodo.org/badge/latestdoi/143292502):

```

@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](https://github.com/adrn/makecite/blob/master/LICENSE) file.