Metadata-Version: 2.4
Name: bib-ami
Version: 0.1.2
Summary: A command-line client for bib-ami citation verification
Author: Carlson Research, LLC
License-Expression: MIT
Project-URL: Homepage, https://github.com/carlson-research/bib-ami-client
Project-URL: Repository, https://github.com/carlson-research/bib-ami-client
Project-URL: Documentation, https://carlson-research.github.io/bib-ami-client/
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx>=0.27.0
Requires-Dist: click>=8.1.0
Provides-Extra: dev
Requires-Dist: pytest>=7.4.0; extra == "dev"
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
Requires-Dist: pytest-mock>=3.14.0; extra == "dev"
Requires-Dist: pytest-httpx>=0.30.0; extra == "dev"
Requires-Dist: sphinx>=7.0.0; extra == "dev"
Requires-Dist: sphinx_rtd_theme>=2.0.0; extra == "dev"
Requires-Dist: pre-commit<3.8.0; extra == "dev"
Requires-Dist: build>=1.0.0; extra == "dev"
Requires-Dist: twine>=5.0.0; extra == "dev"
Dynamic: license-file

# bib-ami

[![CI](https://github.com/carlson-research/bib-ami-client/actions/workflows/tests.yml/badge.svg)](https://github.com/carlson-research/bib-ami-client/actions)
[![PyPI Version](https://img.shields.io/pypi/v/bib-ami.svg)](https://pypi.org/project/bib-ami/)
[![Python Version](https://img.shields.io/pypi/pyversions/bib-ami.svg)](https://pypi.org/project/bib-ami/)
[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://carlson-research.github.io/bib-ami-client/)

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:

```bash
pip install bib-ami
```

## Configuration

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

```bash
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:

```bash
bib-ami lookup 10.1038/nature12345
```

### 2. Launch Web App
Open the interactive `bib-ami` web application in your default system browser:

```bash
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:

```bash
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:

```bash
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:

```bash
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:

```bash
pre-commit install
```
