Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basnijholt/yaml2bib
📖 Convert a yaml file to bib file with the correct journal abbreviations.
https://github.com/basnijholt/yaml2bib
bib bibtex convert crossref doi latex python yaml yaml-to-bib yaml-to-bibtex yaml2bib
Last synced: about 2 months ago
JSON representation
📖 Convert a yaml file to bib file with the correct journal abbreviations.
- Host: GitHub
- URL: https://github.com/basnijholt/yaml2bib
- Owner: basnijholt
- License: mit
- Created: 2019-11-29T10:48:24.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T20:41:29.000Z (2 months ago)
- Last Synced: 2024-10-22T15:26:07.061Z (2 months ago)
- Topics: bib, bibtex, convert, crossref, doi, latex, python, yaml, yaml-to-bib, yaml-to-bibtex, yaml2bib
- Language: Python
- Homepage: https://yaml2bib.readthedocs.io/
- Size: 85 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📘 `yaml2bib`: Convert YAML to BibTeX with Correct Journal Abbreviations Using Only DOIs 🚀
[](https://github.com/basnijholt/yaml2bib/blob/main/LICENSE)
[](https://github.com/basnijholt/yaml2bib/actions?query=workflow%3Apytest)
[](https://codecov.io/gh/basnijholt/yaml2bib)
[](https://yaml2bib.readthedocs.io)
[](https://pypi.org/project/yaml2bib/)
[](https://pypi.org/project/yaml2bib/)
Introducing 🌟 `yaml2bib`, an easy-to-use and powerful Python library and command-line tool that seamlessly converts YAML files to BibTeX format, all while maintaining the correct journal abbreviations using only DOIs! 🎉
Whether you're a researcher or a student, `yaml2bib` will simplify and streamline your bibliography management process. With an intuitive interface, customizable options, and compatibility as both a library and a command-line tool, it's never been more convenient to create and maintain your citation records.
Say goodbye to manual conversions and hello to `yaml2bib`! 🚀
### 🛠️ Installation
```bash
pip install yaml2bib
```
## 🚀 Usage
### Command Line Tool
Check out the help message `yaml2bib --help`:
```bash
Usage: yaml2bib [OPTIONS]
Options:
--bib_fname TEXT Output file. (default: 'dissertation.bib')
--dois_yaml TEXT The `key: doi` YAML file, may contain wildcards
(*). (default: 'bib.yaml', example: '*/*.yaml')
--replacements_yaml TEXT Replacements to perform, might be None. (default:
None, example: 'replacements.yaml')
--static_bib TEXT Static bib entries, might be None, may contain
wildcards (*). (default: None, example:
'chapter_*/not_on_crossref.bib')
--doi2bib_database TEXT The doi2bib database folder 📁 to not query doi.org
more than needed. (default: 'yaml2bib-doi2bib.db')
--crossref_database TEXT The Crossref database folder 📁 to not query
crossref.org more than needed. (default:
'yaml2bib-doi2bib.db')
--email TEXT E-mail 📧 for crossref.org, such that one can make
more API calls without getting blocked. (default:
'anonymous', example: '[email protected]')
--help Show this message and exit.
```
Example invocation for Bas Nijholt's [thesis](https://github.com/basnijholt/thesis):
```bash
yaml2bib \
--bib_fname "dissertation.bib" \
--dois_yaml "*/*.yaml" \
--replacements_yaml "replacements.yaml" \
--static_bib "chapter_*/not_on_crossref.bib" \
--email "[email protected]"
```
### Python Library
```python
from yaml2bib import yaml2bib
yaml2bib(
bib_fname="dissertation.bib",
dois_yaml="*/*.yaml",
replacements_yaml="replacements.yaml",
static_bib="chapter_*/not_on_crossref.bib",
email="[email protected]",
)
```
## 🌟 Full Example
Check out the [`examples`](https://github.com/basnijholt/yaml)
Convert with:
```bash
yaml2bib \
--bib_fname "example.bib" \
--dois_yaml "example.yaml" \
--replacements_yaml "replacements.yaml" \
--static_bib "not_on_crossref.bib" \
--email "[email protected]"
```