Skip to content

Getting Started

This tutorial walks you through installing axm-vault and verifying your setup.

Prerequisites

  • Python 3.12+
  • uv (recommended) or pip

Installation

Bash
uv add axm-vault

Or with pip:

Bash
pip install axm-vault

Step 1: Verify Installation

Python
from axm_vault._version import __version__

print(f"axm-vault v{__version__}")

Step 2: Declare a Credential Group

The catalog describes the credentials a package needs — schema only, no values:

Python
from axm_vault import CredentialGroup, CredentialSpec, Sensitivity

group = CredentialGroup(
    id="acme",
    package="axm-acme",
    title="Acme",
    specs=(
        CredentialSpec(name="api_key", env="ACME_API_KEY", kind="token"),
        CredentialSpec(
            name="region", env="ACME_REGION", kind="str",
            sensitivity=Sensitivity.CONFIG, required=False, default="eu",
        ),
    ),
)

print(group.spec("api_key").env)  # ACME_API_KEY

See the Catalog Models reference for every field.

Step 3: Run the Tests

The workspace Makefile lives at the axm-forge root, not inside the package:

Bash
cd axm-forge
make check          # lint + type check + security audit + tests, all packages

To exercise just this package:

Bash
uv run --package axm-vault --directory packages/axm-vault pytest -x -q

Next Steps