Skip to main content

bib-ami

CI PyPI Version Python Version Documentation

A lightweight, thin-client CLI for the bib-ami citation verification service. This package routes all citation metadata lookups and verification logic to the proprietary backend engine.

Installation

Install the client directly from PyPI:

pip install bib-ami

Configuration

To authenticate with the backend API, set your API key as an environment variable:

export BIB_AMI_API_KEY="your-secret-api-key"

Usage

The client provides two primary commands via the terminal:

1. Citation Lookup

Query citation metadata using a DOI, arXiv ID, or standard reference identifier:

bib-ami lookup 10.1038/nature12345

2. Launch Web App

Open the interactive bib-ami web application in your default system browser:

bib-ami launch

(You can optionally pass a custom URL using bib-ami launch --url https://custom.bib-ami.com)

Help

View all available commands and options:

bib-ami --help

Development & Testing

This project uses pyproject.toml for dependency management and requires Python 3.11+.

Clone the repository and install the development dependencies in editable mode:

git clone [https://github.com/carlson-research/bib-ami-client.git](https://github.com/carlson-research/bib-ami-client.git)
cd bib-ami-client
pip install -e ".[dev]"

Run the Test Suite: Execute the complete unit and end-to-end test suite with terminal coverage reporting:

pytest tests/ --cov=bib_ami --cov-report=term-missing

Code Quality: This project enforces strict formatting and linting via pre-commit. Install the git hooks to run automatically before every commit:

pre-commit install

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bib_ami-0.1.3.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

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

bib_ami-0.1.3-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file bib_ami-0.1.3.tar.gz.

File metadata

  • Download URL: bib_ami-0.1.3.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for bib_ami-0.1.3.tar.gz
Algorithm Hash digest
SHA256 b758f63b3cc6fc0e9394775bfa97a5e1b537f7abf1391e4aad0f68acfe80e66d
MD5 1c305e4e86b55dc312774f057a4f51d7
BLAKE2b-256 8fc4fd53988a6068076afeb4d6c307848e5042e963c813f7cfe12a66987e7897

See more details on using hashes here.

Provenance

The following attestation bundles were made for bib_ami-0.1.3.tar.gz:

Publisher: release-pypi.yml on carlson-research/bib-ami-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bib_ami-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: bib_ami-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for bib_ami-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bb2c459256b1905b72911b96e3dacef5bd793a2a2f46cbe801afb4a58ca140ef
MD5 13c167180909005e7c6a42f2d19b6032
BLAKE2b-256 13721f100d892e4d6dc42ba495b19af3c645d56c3e14adeb3582c986c98ce50f

See more details on using hashes here.

Provenance

The following attestation bundles were made for bib_ami-0.1.3-py3-none-any.whl:

Publisher: release-pypi.yml on carlson-research/bib-ami-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.3 This release

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page