Skip to main content

Citation management and academic reference toolkit

Project description

OneCite Logo

OneCite

Citation & Academic Reference Toolkit

Downloads Awesome CLI Apps

Tests codecov PyPI Python MIT Docs Awesome LaTeX

FeaturesQuick Start📖 Advanced Usage🤝 Contributing


OneCite is a command-line tool and Python library for citation management. It accepts DOIs, paper titles, arXiv IDs, and mixed inputs, and outputs formatted bibliographic entries.


Statement of Need

Researchers frequently accumulate reference lists in ad-hoc formats — DOIs copied from browser tabs, arXiv IDs from paper PDFs, titles typed by hand, and BibTeX fragments from various sources. Cleaning these into a consistent, complete .bib file is tedious and error-prone.

OneCite solves this by accepting any mix of identifiers and text queries and automatically resolving them to structured BibTeX through a pipeline of academic APIs (CrossRef, arXiv, PubMed, Semantic Scholar, and others). It is designed for researchers who work primarily in the terminal, use LaTeX, and want a lightweight, scriptable tool — not a full reference manager.

When to use OneCite vs. alternatives:

Tool Best for
OneCite One-shot conversion of messy reference lists to BibTeX in a terminal/script
Zotero Long-term reference management, GUI-based, browser integration
CrossRef API directly When you have clean DOIs and want canonical metadata
doi2bib Single DOI → BibTeX conversion, no fuzzy matching

Features

Feature Description
Fuzzy Matching Match references against multiple academic databases even from incomplete or inaccurate info.
Multiple Formats Input .txt/.bib → Output BibTeX.
4-stage Pipeline A 4-stage process (clean → query → validate → format) to produce consistent output.
Field Completion Enrich entries by filling in missing fields like journal, volume, pages, and authors.
🎓 7+ Citation Types Handles journal articles, conference papers, books, software, datasets, theses, and preprints.
Multi-Source Lookup Queries CrossRef, arXiv, PubMed, Semantic Scholar, Google Books, and others for every entry.
Many Identifier Types Accepts DOI, PMID, arXiv ID, ISBN, GitHub URL, Zenodo DOI, or plain text queries.
🎛️ Interactive Mode Manually select the correct entry when multiple potential matches are found.
Custom Templates YAML-based presets that provide a fallback BibTeX entry type when auto-detection is inconclusive.

🌐 Data Sources

CrossRef Semantic Scholar PubMed arXiv DataCite Zenodo Google Books

Quick Start

Install and try OneCite in a few steps.

1. Installation

# Recommended: Install from PyPI
pip install onecite

2. Create an Input File

Create a file named references.txt with your mixed-format references:

# references.txt
# Add blank lines between entries to avoid misidentification

10.1038/nature14539

Attention is all you need, Vaswani et al., NIPS 2017

Goodfellow, I., Bengio, Y., & Courville, A. (2016). Deep Learning. MIT Press.

https://github.com/tensorflow/tensorflow

10.5281/zenodo.3233118

arXiv:2103.00020

Smith, J. (2020). Neural Architecture Search. PhD Thesis. Stanford University.

3. Run OneCite

Execute the command to process your file and generate a clean .bib output.

onecite process references.txt -o results.bib --quiet

4. View Output

Your results.bib file now contains entries of different types.

View Complete Output (results.bib)
@article{LeCun2015Deep,
  doi = "10.1038/nature14539",
  title = "Deep learning",
  author = "LeCun, Yann and Bengio, Yoshua and Hinton, Geoffrey",
  journal = "Nature",
  year = 2015,
  volume = 521,
  number = 7553,
  pages = "436-444",
  publisher = "Springer Science and Business Media LLC",
  url = "https://doi.org/10.1038/nature14539",
  type = "journal-article",
}
@inproceedings{Vaswani2017Attention,
  arxiv = "1706.03762",
  title = "Attention Is All You Need",
  author = "Vaswani, Ashish and Shazeer, Noam and Parmar, Niki and Uszkoreit, Jakob and Jones, Llion and Gomez, Aidan N. and Kaiser, Lukasz and Polosukhin, Illia",
  year = 2017,
  booktitle = "Advances in Neural Information Processing Systems (NeurIPS)",
  url = "https://arxiv.org/abs/1706.03762",
}
# ... and 5 more entries ...

📖 Advanced Usage

Direct String and Stdin Input
onecite process "10.1038/nature14539"
onecite process "Attention is all you need, Vaswani et al., NIPS 2017"
echo "10.1038/nature14539" | onecite process -
Interactive Disambiguation

For ambiguous entries, use the --interactive flag to manually select the correct match and ensure accuracy.

Command:

onecite process ambiguous.txt --interactive

Example Interaction:

Found multiple possible matches for "Deep learning Hinton":
1. Deep learning
   Authors: LeCun, Yann; Bengio, Yoshua; Hinton, Geoffrey
   Journal: Nature, 2015
   DOI: 10.1038/nature14539

2. Deep belief networks
   Authors: Hinton, Geoffrey E.
   Journal: Scholarpedia, 2009
   DOI: 10.4249/scholarpedia.5947

Please select (1-2, 0=skip): 1
Selected: Deep learning
🐍 Use as a Python Library

Use OneCite directly in your Python scripts.

from onecite import process_references

# A callback can be used for non-interactive selection (e.g., always choose the best match)
def auto_select_callback(candidates):
    return 0 # Index of the best candidate

result = process_references(
    input_content="Deep learning review\nLeCun, Bengio, Hinton\nNature 2015",
    input_type="txt",
    template_name="journal_article_full",
    output_format="bibtex",
    interactive_callback=auto_select_callback
)

print('\n\n'.join(result['results']))

🤝 Contributing

Contributions are always welcome! Please see CONTRIBUTING.md for development guidelines and instructions on how to submit a pull request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

Disclosure

Development was assisted by standard productivity tools including Generative AI for streamlining implementation details. All output was verified and integrated by the maintainer, and no LLMs are used by the package at runtime.


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

onecite-0.1.0.tar.gz (132.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

onecite-0.1.0-py3-none-any.whl (47.9 kB view details)

Uploaded Python 3

File details

Details for the file onecite-0.1.0.tar.gz.

File metadata

  • Download URL: onecite-0.1.0.tar.gz
  • Upload date:
  • Size: 132.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.1

File hashes

Hashes for onecite-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f61d15d761d0db45115dde6e1136d0c4a2f23d5a0d63b6d6e4a88fada38318bc
MD5 d8e67d335b9b8a215bc169697bd30eae
BLAKE2b-256 91ad2b4616bdbaff468d23cb78f4af50e357422f2e816999f68ea492500298b4

See more details on using hashes here.

File details

Details for the file onecite-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: onecite-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 47.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.1

File hashes

Hashes for onecite-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0ea7a588fb107c4a7da372cc8903e439a89e1632ba83a924cf0f822b399d328
MD5 eb57a25f0cbb2a3a8a981fe7f6c6c28b
BLAKE2b-256 12be1a0cad3ba07946ebd8eab0243c820d4c3783208b20e8a3cf088c0b9a5382

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page