batchman 1.1.0

A flexible Python library for managing batches of requests to LLM inference providers.

Batchman

A flexible Python library for managing batches of requests to LLM inference providers.

Features

• Use batch providers through a unified API [supported providers: OpenAI, Anthropic, Exxa]
• Validate requests before uploading
• Keep track of uploaded batches and their status

Installation

From PyPI

pip install batchman

Quickstart

Creating a batch

import batchman
from batchman import Request, UserMessage

# Initialize a new batch
batch = batchman.create_batch("my batch")

# Example: Generate stories for different professions
jobs = [
    "an astronaut", "a doctor", "a firefighter", "a teacher",
    "a chef", "a farmer", "a pilot", "a scientist"
]

# Add requests to the batch
batch.add_requests([
    Request([UserMessage(f"Write a short story about a child dreaming of being {job}.")])
    for job in jobs]
)

# Configure batch parameters
batch.override_request_params(
    system_prompt=(
        "You are a creative writer who writes short stories for children. "
        "The goal of the stories are to motivate them to pursue their dreams "
    ),
    model="llama-3.1-70b-instruct-fp16",
    temperature=0.5,
)

# Set the provider (uses EXXA_API_KEY environment variable by default)
batch.set_provider(provider="exxa")

# Upload the batch
batch.upload()

Managing Batches

The batchman command sync all batches. This will fetch the status of all non-completed batches, and then display them in an interactive way

batchman

It will display a table with the batches, and you can remove or cancel them.

Advanced Usage

Custom Provider Configuration

If you need to specify the api_key and/or the base_url for a provider, you can do so by passing the provider_config parameter to the create_batch function.

batch = batchman.create_batch(
    name="my batch",
    provider="exxa",
    provider_config=ProviderConfig(
        api_key="your-api-key",
        url="https://api.example.com",
    )
)

Security

Once a provider is configured (at batch creation time or later), the provider configuration including the api_key is stored in the providers_config.jsonl file, in a .batchman directory in your home directory. This file should not be shared with others. The batches directory only store hash references to this file, and are safe to share.

For Development

git clone https://github.com/yourusername/batchman.git
cd batchman
uv pip install -e .[dev]

to build the pypi package with uv, run

uv build

to publish to testpypi, run

uv publish --index testpypi --username __token__ --password $PYPITEST_TOKEN

Downloading from the test index:

pip install --verbose -i https://test.pypi.org/simple/  --extra-index-url https://pypi.org/simple/ batchman

Building the documentation

tox -e docs

Contributing

Contributions are welcome! Please see our (TODO) Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.