Autogenerate bibtex citations for common Python packages
Project description
# 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):
```
@misc{makecite:2018,
author = {Adrian Price-Whelan and
Alexandar Mechev and
jumeroag},
title = {adrn/makecite: v0.1},
month = aug,
year = 2018,
doi = {10.5281/zenodo.1343295},
url = {https://doi.org/10.5281/zenodo.1343295}
}
```
## 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.
[![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):
```
@misc{makecite:2018,
author = {Adrian Price-Whelan and
Alexandar Mechev and
jumeroag},
title = {adrn/makecite: v0.1},
month = aug,
year = 2018,
doi = {10.5281/zenodo.1343295},
url = {https://doi.org/10.5281/zenodo.1343295}
}
```
## 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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
makecite-0.3.tar.gz
(13.2 kB
view details)
File details
Details for the file makecite-0.3.tar.gz
.
File metadata
- Download URL: makecite-0.3.tar.gz
- Upload date:
- Size: 13.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/36.4.0 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/3.6.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7400fe3b8b52580c77adbc06343b98f3fff3a4e67f36b436f9095b5841b96a5 |
|
MD5 | e494a56c33fbea0f1046e11a0d8496b3 |
|
BLAKE2b-256 | 0cccdedb475d15a57e4a013401de70ebc8415122a02d5a3602b501bee95a734b |