https://github.com/tdegeus/goosebib
Some simple command-line tools to clean-up / modify BibTeX files
https://github.com/tdegeus/goosebib
arxiv bibtex bibtexparser doi formatter pre-commit python
Last synced: 28 days ago
JSON representation
Some simple command-line tools to clean-up / modify BibTeX files
- Host: GitHub
- URL: https://github.com/tdegeus/goosebib
- Owner: tdegeus
- License: mit
- Created: 2018-03-29T08:37:07.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-02-20T10:39:16.000Z (over 1 year ago)
- Last Synced: 2024-08-18T01:24:08.114Z (10 months ago)
- Topics: arxiv, bibtex, bibtexparser, doi, formatter, pre-commit, python
- Language: Python
- Homepage: https://goosebib.readthedocs.io
- Size: 402 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/tdegeus/GooseBib/actions)
[](https://goosebib.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/tdegeus/GooseBib/actions)
[](https://github.com/pre-commit/pre-commit)
[](https://anaconda.org/conda-forge/goosebib)
**Documentation: [https://goosebib.readthedocs.io](goosebib.readthedocs.io)**
- [Usage](#usage)
- [pre-commit](#pre-commit)
- [From the command-line](#from-the-command-line)
- [From Python](#from-python)
- [Disclaimer](#disclaimer)
- [Getting GooseBib](#getting-goosebib)
- [Using conda](#using-conda)
- [Using PyPi](#using-pypi)
- [From source](#from-source)
# Usage
Clean-up and correct BibTeX files.
## pre-commit
For example:
```yaml
repos:
- repo: https://github.com/tdegeus/GooseBib
rev: v0.6.0
hooks:
- id: GbibClean
args: ['--arxiv=arXiv preprint: {}']
```
## From the command-line
* [`GbibClean`](https://goosebib.readthedocs.io/en/latest/tools.html#GbibClean)
Clean-up a BibTeX file, removing it from unnecessary fields and applying several fixes,
including abbreviating authors.
* [`GbibDiscover`](https://goosebib.readthedocs.io/en/latest/tools.html#GbibDiscover)
Check online databases to see if entries in a BibTeX file went out-to-data.
## From Python
All of these tools wrap around a
[Python module](https://texplain.readthedocs.io/en/latest/module.html)
that you can use just as well!
# Disclaimer
This library is free to use under the
[MIT license](https://github.com/tdegeus/GooseBib/blob/master/LICENSE).
Any additions are very much appreciated, in terms of suggested functionality, code, documentation,
testimonials, word-of-mouth advertisement, etc.
Bug reports or feature requests can be filed on [GitHub](https://github.com/tdegeus/GooseBib).
As always, the code comes with no guarantee.
None of the developers can be held responsible for possible mistakes.
Download:
[.zip file](https://github.com/tdegeus/GooseBib/zipball/master) |
[.tar.gz file](https://github.com/tdegeus/GooseBib/tarball/master).
(c - [MIT](https://github.com/tdegeus/GooseBib/blob/master/LICENSE)) T.W.J. de Geus (Tom) |
[email protected] |
www.geus.me |
[github.com/tdegeus/GooseBib](https://github.com/tdegeus/GooseBib)
# Getting GooseBib
## Using conda
```bash
conda install -c conda-forge goosebib
```
## Using PyPi
```bash
python -m pip install GooseBib
```
## From source
```bash
# Download GooseBib
git checkout https://github.com/tdegeus/GooseBib.git
cd GooseBib
# Install
python -m pip install .
```