axm-init 0.4.0

AXM Init — Python project scaffolding CLI with Copier templates.

axm-init

Python project scaffolding, quality checks & governance CLI.

---

Features

• 🚀 Scaffold — Bootstrap production-grade Python projects with Copier templates
• 📋 Check — Score any project against the AXM gold standard (39 checks, A–F grade)
• 📦 Reserve — Claim a package name on PyPI before you're ready to publish

Installation

uv add axm-init

Quick Start

# Scaffold a new project
axm-init init my-project \
  --org axm-protocols \
  --author "Your Name" --email "[e-mail]"

# Check against AXM standards
axm-init check
# Score: 100/100 — Grade A 🏆

# Reserve a name on PyPI
axm-init reserve my-cool-lib --dry-run

CLI Commands

axm-init init

Scaffold a production-grade Python project (src layout, PEP 621, CI, docs).

Option	Short	Default	Description
PATH		.	Directory to initialize
--org	-o	required	GitHub org or username
--author	-a	required	Author name
--email	-e	required	Author email
--name	-n	dir name	Project name
--license	-l	MIT	License (MIT, Apache-2.0, EUPL-1.2)
--license-holder		--org	License holder
--description	-d		One-line description
--check-pypi		False	Verify PyPI availability first
--json		False	Output as JSON

axm-init check

Score a project against the AXM gold standard (39 checks across 7 categories).

Option	Short	Default	Description
PATH		.	Directory to check
--category	-c	all	Filter to one category
--json		False	Output as JSON

Categories: pyproject, ci, tooling, docs, structure, deps, changelog

axm-init reserve

Reserve a package name on PyPI with a minimal placeholder.

Option	Short	Default	Description
NAME		required	Package name to reserve
--author	-a	John Doe	Author name
--email	-e	[e-mail]	Author email
--dry-run		False	Skip actual publish
--json		False	Output as JSON

CI Check Badge

Projects scaffolded with axm-init init include an automated check badge that updates on every push. The badge shows your score and grade using the AXM logo.

push → axm-init check → badge JSON → gh-pages → shields.io

The badge is already in your README — just push to main and it appears after the first CI run.

Existing projects can add the badge too — copy .github/workflows/axm-init.yml from a scaffolded project and add the badge markup. See the howto guide for details.

Development

git clone https://github.com/axm-protocols/axm-init.git
cd axm-init
uv sync --all-groups
uv run pytest           # 317 tests
uv run ruff check src/  # lint

License

Apache License 2.0