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.2.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.2-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bib_ami-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 4303b5f7709f84d4de3ce3f5558b5013b63526ef7e5d1f7c0a68b3a94655dd02
MD5 16dbbb3d23aba8ad3f523fe11c82ec7b
BLAKE2b-256 c51fcd77e753ef1e7f546f3f0c601fbb2150024bf33fe644bc9c3ab7fec109be

See more details on using hashes here.

Provenance

The following attestation bundles were made for bib_ami-0.1.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: bib_ami-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 02bb61d6f19423d99bb3d466364b92379ee275f76dfa52360f71015406430eb6
MD5 8b7eb907077ee00b6ba4c472d8fb8fdc
BLAKE2b-256 87737a5c345617c8d913c1f48fcf5c47b9761542298047f669d1e1107c3062d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for bib_ami-0.1.2-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

0.1.3

2 files

This release

0.1.2 This release

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