archetype-py

Enforce architectural rules as code. Catch structural violations before they merge.

Why archetype-py

Most tooling checks formatting, typing, and tests, but not architecture drift.
archetype-py lets you codify structural boundaries and enforce them in local runs, CI, and pytest.

When to use / When not to use

Use archetype-py when:

You want architecture rules to run automatically in CI and pytest.
You need to prevent forbidden imports, layer violations, or import cycles.
You are adopting architecture checks incrementally in a legacy codebase (baseline mode).

Do not use archetype-py when:

You only need style/type checks (linters and type checkers are enough).
Your project is a very small script with no meaningful module boundaries.
You are looking for runtime policy enforcement instead of static import-graph checks.

Install

pip install archetype-py

Quick Start

archetype init .
archetype check .

Create an architecture.py file and define your rules:

from archetype import rule
from archetype.rules import layers

@rule("layers are ordered")
def layer_order() -> None:
    layers(["myapp.api", "myapp.services", "myapp.db"]).are_ordered()

Core Features

Architecture rules for forbidden imports, allowlisted imports, and protected boundaries
Transitive dependency checks with must_not_depend_on
Layer order enforcement with layers(...).are_ordered()
Import cycle detection with no_cycles(...)
Rule decorators: @rule, @warn, @skip, @since
Rule grouping via group("...") and targeted execution with --group
archetype init scaffolding for starter architecture.py
JSON and text reporting (--format json|text) with stable JSON contract versioning
Quiet output mode (--quiet) for CI-friendly logs
Import graph caching for faster repeated runs (--cache, --no-cache)
Parallel execution control with --workers
Baseline adoption for legacy codebases (--write-baseline, --baseline)
Changed-files scope mode (--changed-from <git-ref>)
GitHub Actions inline PR annotations (--github-annotations)
Project diagnostics with archetype doctor
Import graph export with archetype graph --format mermaid|json
Unmatched pattern warnings with suggestions for likely misspellings
Path exclusions via CLI (--exclude) and config
Project config defaults through archetype.toml
Git pre-commit hook installer (archetype install-hook)
Project layout support for flat, src/, namespace packages (PEP 420), and monorepos
CLI command and pytest plugin support for local and CI enforcement

CI Example

- run: archetype check .

For full guides, examples, and release notes, use the GitHub README and changelog.

Development Status
- 3 - Alpha
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Programming Language
- Python :: 3
Topic
- Software Development :: Quality Assurance

Download files

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

Source Distribution

archetype_py-0.4.0.tar.gz (7.6 MB view details)

Uploaded Jul 13, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

archetype_py-0.4.0-py3-none-any.whl (41.4 kB view details)

Uploaded Jul 13, 2026 Python 3

File details

Details for the file archetype_py-0.4.0.tar.gz.

File metadata

Download URL: archetype_py-0.4.0.tar.gz
Upload date: Jul 13, 2026
Size: 7.6 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for archetype_py-0.4.0.tar.gz
Algorithm	Hash digest
SHA256	`37b1ab33c7ce82464ece3215274bb3e0859dee7c0a707aa2632bf93a2cfaf2a2`
MD5	`c97f64e6c32648389996b038a061fce5`
BLAKE2b-256	`a6ec782b1a43af9615bf2a996d0d6246be42b81ac6ec8c0cdc2e1f347f27c49d`

See more details on using hashes here.

Provenance

The following attestation bundles were made for archetype_py-0.4.0.tar.gz:

Publisher: publish.yml on MossabArektout/archetype-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: archetype_py-0.4.0.tar.gz
- Subject digest: 37b1ab33c7ce82464ece3215274bb3e0859dee7c0a707aa2632bf93a2cfaf2a2
- Sigstore transparency entry: 2165083224
- Sigstore integration time: Jul 13, 2026
Source repository:
- Permalink: MossabArektout/archetype-py@cba6e3b199be69b6b19f05126c9c23180aa2e0a7
- Branch / Tag: refs/tags/v0.4.0
- Owner: https://github.com/MossabArektout
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@cba6e3b199be69b6b19f05126c9c23180aa2e0a7
- Trigger Event: push