Skip to main content

Installation

Using pip

pip install metacrafter

Optional features are available as install extras:

pip install metacrafter # core (built-in rules, CLI, server)
pip install 'metacrafter[rules]' # + extended rules pack (metacrafter-rules)
pip install 'metacrafter[llm]' # + LLM/RAG hybrid classification
pip install 'metacrafter[datahub]' # + DataHub export integration
pip install 'metacrafter[openmetadata]' # + OpenMetadata integration
pip install 'metacrafter[all]' # extended rules + all optional integrations
pip install 'metacrafter[dev]' # development + test tooling

When metacrafter[rules] is installed, Metacrafter automatically loads the extended metacrafter-rules YAML pack. Set auto_rules: false in .metacrafter to use only paths you list explicitly.

The stable public Python API is importable from the package:

from metacrafter import CrafterCmd

Optional extras

ExtraEnables
rulesExtended YAML rules and validators from metacrafter-rules
llmLLM/RAG hybrid classification (OpenAI, ChromaDB, requests)
datahubExport scan results to DataHub (acryl-datahub)
openmetadataExport scan results to OpenMetadata
allExtended rules plus LLM and catalog integrations
devpytest, coverage, flake8, black, mypy

From source

git clone https://github.com/apicrafter/metacrafter.git
cd metacrafter
pip install -e '.[dev]'

Requirements

  • Python 3.8 or newer
  • CI currently tests Python 3.8–3.12

Next steps