Skip to main content

Portable bibliography workspace tool

Project description

biblio

Portable bibliography workspace tooling.

Distribution name: biblio-tools Import package: biblio CLI: biblio

biblio bootstraps a repo-local bib/ workspace, manages citekeys and BibTeX imports, runs Docling, resolves OpenAlex metadata, syncs a bibliography-owned RAG config, expands local literature graphs, and builds a standalone bibliography explorer.

In the development repo, there is also a small local demo workspace under bib/ with three sample papers so you can try the commands immediately.

It can also ingest structured inputs before you have .bib files, including:

  • DOI lists
  • CSL JSON
  • RIS
  • local PDFs

Install for development:

pip install -e ".[dev]"

Install by distribution name:

pip install biblio-tools

Run the CLI:

biblio --help

Enable shell completion for bash:

eval "$(register-python-argcomplete biblio)"

Example ingestion flow:

biblio ingest csljson exports/library.json
biblio ingest ris exports/library.ris
biblio ingest dois reading-list.txt --stdout
biblio ingest pdfs ~/Downloads/papers/

Example local demo flow from this repo:

make ui-serve
biblio citekeys status
biblio bibtex merge
biblio docling run --all
biblio openalex resolve
biblio site build

Documentation

Install docs dependencies:

pip install -e ".[docs]"

Preview locally:

mkdocs serve

The docs site uses a Diataxis layout and is intended for GitHub Pages deployment.

Optional local UI:

pip install -e ".[ui]"
biblio ui serve

Convenience alias:

biblio-gui

The UI serves a local FastAPI app with a React/Cytoscape front end. It can:

  • explore the local paper graph
  • inspect corpus and paper details
  • trigger selected biblio actions directly
  • fall back to the next free port if 8010 is already in use

Release workflow

Build and validate distributions:

python -m build
python -m twine check dist/*

Upload instructions live in RELEASE.md.

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

biblio_tools-0.1.4.tar.gz (307.4 kB view details)

Uploaded Source

Built Distribution

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

biblio_tools-0.1.4-py3-none-any.whl (313.6 kB view details)

Uploaded Python 3

File details

Details for the file biblio_tools-0.1.4.tar.gz.

File metadata

  • Download URL: biblio_tools-0.1.4.tar.gz
  • Upload date:
  • Size: 307.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for biblio_tools-0.1.4.tar.gz
Algorithm Hash digest
SHA256 6020dfa60c26478c7ed1c069f2a73bc03353b513626cf6d12061d0b3010d0491
MD5 b5282117b84ccedf6316960a4cb75e54
BLAKE2b-256 683caa1ebadfa9d5904e11c4a0b4fb61ae5152af941299ed45d30f7fca523823

See more details on using hashes here.

File details

Details for the file biblio_tools-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: biblio_tools-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 313.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for biblio_tools-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9ec61450d3855e82836e218d69a8e85d2a5a2c14aeb9f5965b129e6149967aa9
MD5 cd469872e4c7ac8087bab75d13f019c9
BLAKE2b-256 97b9a8fb60a17d43818a66df28144656c11335c375947917390b1818dde3ed46

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