Skip to main content

Generate EU AI Act Annex IV compliance documentation from your ML codebase

Project description

PyPI version License: MIT

AIBOM

Generate EU AI Act Annex IV compliance documentation from your ML codebase in one command.

getaibom.com

pip install aibom-cli
aibom scan .

What it does

AIBOM scans your Python ML project and outputs a structured document listing the AI models, datasets, and frameworks used in your project. This provides the core inventory required for the technical documentation under Annex IV of the EU AI Act.

The tool detects components from major AI providers and libraries, helping you automatically generate a baseline "AI Bill of Materials" to accelerate your compliance workflow.

Installation

pip install aibom-cli==0.2.0

Requires Python 3.9+

Usage

# Scan a project, output JSON (default)
aibom scan ./my-project

# Save to file
aibom scan ./my-project --output report.json

# Markdown output
aibom scan ./my-project --format markdown --output report.md

Example output

{
  "aibom_version": "0.2.0",
  "generated_at": "2026-03-14T05:55:00Z",
  "project_path": "./my-project",
  "datasets": [
    {
      "name": "squad",
      "source": "huggingface",
      "source_url": "https://huggingface.co/datasets/squad",
      "detected_in": "train.py:4"
    }
  ],
  "models": [
    {
      "name": "gpt-4o",
      "provider": "openai",
      "model_card_url": null,
      "detected_in": "inference.py:12"
    }
  ],
  "apis": [
    {
      "provider": "openai",
      "endpoint_pattern": "chat.completions.create",
      "detected_in": "inference.py:12"
    }
  ]
}

CI/CD Integration

Automate your compliance documentation by running AIBOM in your CI/CD pipeline. This ensures your AI Bill of Materials is always up-to-date.

Here’s a quick example for GitHub Actions:

name: AIBOM Scan

on:
  push:
    branches:
      - main

jobs:
  aibom-scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.10'
      - run: pip install aibom-cli
      - run: aibom scan . --format markdown --output aibom-report.md
      - uses: actions/upload-artifact@v4
        with:
          name: aibom-report
          path: aibom-report.md

For GitLab CI and Jenkins examples, see the CI/CD integration guide.

What is the EU AI Act?

The EU AI Act requires providers of high-risk AI systems to maintain technical documentation detailing the system's components, including the datasets and models used. AIBOM generates the dataset and model inventory component of that documentation automatically.

Relevant articles: Annex IV Section 2, Article 11, Article 13.

Detection Coverage

AIBOM v0.2.0 detects usage of the following frameworks and providers:

Provider / Framework Type
HuggingFace Models & Datasets
OpenAI Models & API Usage
Anthropic Models & API Usage
Google Vertex AI Models & API Usage
Cohere Models & API Usage
TensorFlow Datasets (tfds)
PyTorch Datasets (torchvision)
scikit-learn Models & Datasets
LangChain Components
LlamaIndex Components

License

MIT

Developer FAQ

Does AIBOM scan all Python files recursively?

Yes. The aibom scan . command scans for Python files recursively within the specified directory.

Does it work with virtual environments or requirements.txt?

No. Version 0.2.0 performs an AST (Abstract Syntax Tree) scan on Python files directly. It does not analyze virtual environments or parse dependencies from requirements.txt.

Can I scan a single file instead of a whole project?

No, single-file scanning is not supported in v0.2.0. The tool currently operates on directories.

What does the JSON output schema look like?

The JSON output contains aibom_version, generated_at, project_path, and three arrays for discovered assets: datasets, models, and apis.

Is this an official EU AI Act compliance tool?

No. AIBOM is an open-source, community-driven project and is not an official tool for EU AI Act compliance.

Can I contribute new framework detections?

Yes, contributions are encouraged. See our CONTRIBUTING.md file for details on how to get started.

Project details


Download files

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

Source Distribution

aibom_cli-0.3.0.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

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

aibom_cli-0.3.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file aibom_cli-0.3.0.tar.gz.

File metadata

  • Download URL: aibom_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for aibom_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 518c64e273dc923739dabd9853f3da4f9e48a5f73d9cb92b4434518a3016a1b9
MD5 0794f5c8508f6ce56bc1e514677e3c3a
BLAKE2b-256 c925c955fdcd47a2ee4dc3e834f2577d41a5520c26510a5d6fab8df3167c328a

See more details on using hashes here.

File details

Details for the file aibom_cli-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: aibom_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for aibom_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f08c300ae91ef86154f786b6c337b78994a2f62a599cf20a4771ac5f4a0a9018
MD5 21d00c83db23c56947d53dd3d8996415
BLAKE2b-256 c0abb019152489fc1e80a84cc0d1fdc42e482c01e8975093eddc0bd1d88b70e1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page