cdlbib
cdlbib is a command-line tool that checks the formatting of the
CDL bibliography (a BibTeX file,
cdl.bib) and verifies each entry's citation against published records.
If you are a member of the Contextual Dynamics Laboratory at Dartmouth College, we use this package to manage a single bibliography "database" (bibtex file) to ensure accuracy and consistency across all of our written documents.
If you are not a CDL member, you probably won't want to use this package directly. However, you may find it useful to adapt the approach for your own research group; feel free to use, modify, adapt, etc., as you wish!
What it does
- Checks that every entry in
cdl.bibfollows the bibliography's formatting rules. - Verifies each entry's citation against published records (Crossref, Europe PMC, publisher pages, library catalogues, preprint servers and others).
- Records a human review of an entry under the reviewer's GitHub login.
- Sends a change to the bibliography as a pull request from your own fork.
- Optionally reads PDFs to collect quoted evidence for an entry (the
researchextra). - Links the bibliography into your TeX tree (
cdlbib setup) and exports the entries a paper cites as a.bibor a compiled.bbl(cdlbib export). - Offers these tasks in a local web interface in your browser (
cdlbib web), except the compiled.bbl, which onlycdlbib export --bblmakes.
Requirements
Python 3.11 or later. The GitHub CLI (gh) is needed for
recording reviews and for sending changes.
Install
With the install script (macOS and Linux), which works whatever the default Python is:
curl -LsSf https://raw.githubusercontent.com/ContextLab/CDL-bibliography/master/install.sh | sh
or, from a checkout of the repository, sh install.sh. The script installs cdlbib
with uv in an environment of its own. When uv is missing
it says so and downloads it into ~/.local/share/cdlbib/uv/; when no Python 3.11, 3.12
or 3.13 is installed, uv downloads one into its own folder. The uv that is downloaded
is one version, named by UV_VERSION in install.sh: its installer is run only when its
SHA-256 equals UV_INSTALLER_SHA256 in install.sh, and that installer compares the
archive of uv with a SHA-256 it carries before unpacking it. No signature is verified.
To move to another version, set both values (the README's "Installation" section has the
command that prints the digest). The Python already installed
is not changed, no shell profile is edited and sudo is not used. --ask asks first,
--no-uv downloads no uv, --uninstall removes what the script installed, and
--help lists the options.
By hand, with Python 3.11 or later available:
uv tool install --python ">=3.11" cdlbib
pipx install --python python3.11 cdlbib
python3.11 -m pip install cdlbib
These install the version on PyPI. The curl form installs the master branch of the
repository; with --pypi the script installs the version on PyPI. To install the
master branch by hand, give "cdlbib @ git+https://github.com/ContextLab/CDL-bibliography"
in place of cdlbib.
pip prints
ERROR: Package 'cdlbib' requires a different Python: 3.9.13 not in '>=3.11'
when the Python it belongs to (here 3.9.13) is older than 3.11. The install script does
not use the default Python: uv finds a Python from 3.11 to 3.13, or downloads one, and
puts cdlbib into an environment made with it.
The tool downloads the bibliography on first use and checks for updates when commands run. See the README for library locations and usage.
Documentation
- Repository: https://github.com/ContextLab/CDL-bibliography
- Full usage (README): https://github.com/ContextLab/CDL-bibliography/blob/master/README.md
- Tutorials: https://github.com/ContextLab/CDL-bibliography/blob/master/docs/tutorials.md
- How verification works: https://github.com/ContextLab/CDL-bibliography/blob/master/docs/verification.md
Licence
MIT. See https://github.com/ContextLab/CDL-bibliography/blob/master/LICENSE.
Metadata
Release files for cdlbib 2.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cdlbib-2.0.1.tar.gz | 1.5 MB | Without provenance | Details for cdlbib-2.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cdlbib-2.0.1-py3-none-any.whl | Python 3 | none | any | Details for cdlbib-2.0.1-py3-none-any.whl |
Total release size: 2.2 MB
Release files / cdlbib-2.0.1.tar.gz
| Download URL | cdlbib-2.0.1.tar.gz |
|---|---|
| Size | 1.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
57164b826191f46d407149d8afe8f319269b68e26904547fa21d9e2098d115d0
|
|
BLAKE2b-256 checksum How to use checksums |
0656cdc8d3da7b5bb0bbc130ddc1633d184f83b7c2ad8147aeb6f1416978ce8f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Release files / cdlbib-2.0.1-py3-none-any.whl
| Download URL | cdlbib-2.0.1-py3-none-any.whl |
|---|---|
| Size | 789.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
19384b1a84d3cb8083c196abaf31a5e16e3f650eb7e70502624cf215fbd6d2a5
|
|
BLAKE2b-256 checksum How to use checksums |
73129c82df21fd4d7c9622466c59cca7ddeedec2dcaa108470cac69fa7c7c0d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Security for cdlbib 2.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.