archetype-py 0.2.2__tar.gz → 0.2.3__tar.gz

archetype_py-0.2.3/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,63 @@
+---
+name: Bug report
+about: Report a problem or unexpected behavior in archetype-py
+title: "[Bug]: "
+labels: bug
+assignees: ''
+---
+
+## Description
+
+Describe the issue clearly and concisely.
+
+---
+
+## Expected Behavior
+
+What did you expect to happen?
+
+---
+
+## Actual Behavior
+
+What actually happened?
+
+---
+
+## Reproduction
+
+Steps to reproduce:
+
+1. Create rule:
+2. Run command:
+3. Observe output:
+
+---
+
+## Example Rule / Config
+
+```python
+# Paste architecture.py snippet here
+```
+
+---
+
+## CLI Output
+
+```text
+Paste error output here
+```
+
+---
+
+## Environment
+
+- archetype-py version:
+- Python version:
+- OS:
+
+---
+
+## Additional Context
+
+Add any other context, screenshots, or examples here.

archetype_py-0.2.3/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,40 @@
+---
+name: Feature request
+about: Suggest an idea or improvement for archetype-py
+title: "[Feature]: "
+labels: enhancement
+assignees: ''
+---
+
+## Problem
+
+Describe the problem or limitation you're facing.
+
+Example:
+"I want to enforce boundaries between domains automatically."
+
+---
+
+## Proposed Solution
+
+Describe the behavior or feature you'd like to see.
+
+---
+
+## Example API
+
+```python
+# Optional example usage
+```
+
+---
+
+## Alternatives Considered
+
+Describe any alternatives or workarounds you've tried.
+
+---
+
+## Additional Context
+
+Add screenshots, architecture examples, or related tools if relevant.

{archetype_py-0.2.2 → archetype_py-0.2.3}/.gitignore

@@ -32,8 +32,10 @@ htmlcov/
 
 # OS files
 .DS_Store
+**/.DS_Store
 
 # Hatch
 .hatch/
 LAUNCH.md
 ROADMAP.md
+.archetype_cache

{archetype_py-0.2.2 → archetype_py-0.2.3}/CHANGELOG.md

@@ -43,3 +43,28 @@
 - Summary line now includes warned and skipped counts
 - Reporter output organized by group when rules use group context manager
 - pytest plugin node IDs include group name when present
+
+
+## 0.2.3 — 2026-05-16
+
+### Added
+- @warn decorator for non-blocking rule violations
+- @skip decorator to temporarily disable rules
+- @since decorator for date-scoped enforcement
+- @rule timeout parameter for pathological graphs
+- Glob pattern support in module matching
+- Rule grouping with group context manager
+- archetype init command for scaffolding
+- --quiet flag to show only failures and warnings
+- --format json flag for machine-readable output
+- --no-cache flag to force fresh graph rebuild
+- --group flag to run specific rule groups only
+- must_not_depend_on for transitive dependency checking
+- Import graph caching for faster repeat runs
+- File path and line number in violation messages
+
+### Fixed
+- src layout detection in archetype init
+- Verbose violation messages now concise and scannable
+- --quiet flag correctly filters JSON output
+- Naming convention violation message format cleaned up

archetype_py-0.2.3/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

archetype_py-0.2.3/PKG-INFO

@@ -0,0 +1,345 @@
+Metadata-Version: 2.4
+Name: archetype-py
+Version: 0.2.3
+Summary: Enforce architectural rules as code. Catch structural violations before they merge.
+Project-URL: Homepage, https://github.com/MossabArektout/archetype-py
+Project-URL: Documentation, https://github.com/MossabArektout/archetype-py
+Author-email: Mossab Arektout <mossabarektout2000@gmail.com>
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Requires-Dist: click
+Requires-Dist: networkx
+Requires-Dist: rich
+Provides-Extra: benchmarks
+Provides-Extra: dev
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/markdown
+
+[![PyPI version](https://img.shields.io/pypi/v/archetype-py)](https://pypi.org/project/archetype-py/)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue)](https://pypi.org/project/archetype-py/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/MossabArektout/archetype-py/blob/main/LICENSE)
+[![CI](https://img.shields.io/github/actions/workflow/status/MossabArektout/archetype-py/ci.yml?branch=main&label=ci)](https://github.com/MossabArektout/archetype-py/actions/workflows/ci.yml)
+
+# archetype-py
+
+## Table of Contents
+
+- [Overview](#overview)
+- [archetype-py Logo](#archetype-py-logo)
+- [Architecture Visuals](#architecture-visuals)
+- [Why Developers Use archetype-py](#why-developers-use-archetype-py)
+- [See It In Action](#see-it-in-action)
+- [Quick Start](#quick-start)
+- [Minimum `architecture.py` Example](#minimum-architecturepy-example)
+- [Features](#features)
+- [Decorators and Commands](#decorators-and-commands)
+- [Perfect For](#perfect-for)
+- [Installation](#installation)
+- [Build & Test](#build--test)
+- [Exit Codes](#exit-codes)
+- [Troubleshooting](#troubleshooting)
+- [Roadmap](#roadmap)
+- [Contributing](#contributing)
+- [Support The Project](#support-the-project)
+
+## Overview
+
+archetype-py is a Python architecture testing library that helps teams define structural rules as code and enforce them continuously. Instead of relying on conventions alone, you can codify boundaries such as layer direction, forbidden dependencies, module visibility, and cycle prevention, then run those checks locally, in CI, and in pytest. This keeps architecture decisions explicit, reviewable, and resilient as the codebase grows.
+
+## archetype-py Logo
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/MossabArektout/archetype-py/main/assets/logo.png" alt="archetype-py logo" width="280"/>
+</p>
+
+## Architecture Visuals
+
+### Architecture Diagram
+archetype-py lets teams define architecture rules like:
+
+- “API must not depend on infrastructure”
+- “No cycles between services”
+- “Only repositories can access the database”
+
+…and automatically enforce them in CI, locally, and in pytest.
+
+<p align="center">
+  <img src="./assets/architecture.png" alt="archetype-py high-level architecture diagram" width="900"/>
+</p>
+
+### Rule Execution Flow
+
+<p align="center">
+  <img src="./assets/Rule_Execution_Flow.png" alt="archetype-py rule execution flow diagram" width="900"/>
+</p>
+
+
+### Violation Lifecycle
+
+<p align="center">
+  <img src="./assets/Violation_Lifecycle.png" alt="archetype-py violation lifecycle diagram" width="900"/>
+</p>
+
+### CLI + CI Diagram
+
+<p align="center">
+  <img src="./assets/ci_integration.png" alt="archetype-py CLI and CI integration diagram" width="900"/>
+</p>
+
+### pytest Integration
+
+<p align="center">
+  <img src="./assets/Pytest.png" alt="archetype-py pytest integration diagram" width="900"/>
+</p>
+
+---
+
+## Why Developers Use archetype-py
+
+Most Python tooling checks:
+
+- formatting
+- typing
+- linting
+- correctness
+
+But almost nothing protects **system structure**.
+
+As projects grow, architecture drifts silently:
+- layers start leaking
+- imports become tangled
+- boundaries disappear
+- coupling spreads
+
+archetype-py turns architectural intent into executable checks.
+
+---
+
+## See It In Action
+
+### Define architecture rules
+
+```python
+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()
+```
+
+### Run checks
+
+```bash
+archetype check .
+```
+
+### Get actionable feedback
+
+```text
+✖ API cannot depend on DB internals
+
+app.api.users
+└── imports app.db.internal.session
+```
+
+---
+
+## Quick Start
+
+### 1. Install
+
+```bash
+pip install archetype-py
+```
+
+### 2. Generate a starter architecture file
+
+```bash
+archetype init .
+```
+
+### 3. Define your rules
+
+Edit:
+
+```text
+architecture.py
+```
+
+### 4. Run checks
+
+```bash
+archetype check .
+```
+
+### 5. Add to CI
+
+```yaml
+- run: archetype check .
+```
+
+Done.
+
+---
+
+## Minimum `architecture.py` Example
+
+Use this as a starting point when creating or refining your rules file:
+
+```python
+from archetype import group, imports, rule, since, warn
+from archetype.rules import no_cycles
+
+with group("Layer boundaries"):
+    @rule("api-must-not-import-db")
+    def api_must_not_import_db() -> None:
+        imports("myapp.api").must_not_import("myapp.db")
+
+@rule("db-warning-example")
+@warn
+def db_warning_example() -> None:
+    imports("myapp.services").must_not_import("myapp.db.internal")
+
+@rule("recent-violations-only")
+@since("2026-01-01")
+def recent_violations_only() -> None:
+    imports("myapp.api").must_not_import("myapp.legacy")
+
+@rule("no-import-cycles")
+def no_import_cycles() -> None:
+    no_cycles("myapp")
+```
+
+---
+
+## Features
+
+### Architecture Rules
+- Forbidden imports
+- Allowlisted imports
+- Layer enforcement
+- Import cycle detection
+- Protected module boundaries
+
+### Workflow Features
+- Rule grouping
+- Warning-level rules
+- Temporary rule skips with context
+- Changed-file enforcement (`since`)
+- Pytest integration
+- CI-friendly exit codes
+
+## Decorators and Commands
+
+Rules are written in `architecture.py` with decorators. Below are all decorator-style rule helpers currently available in this library.
+
+| Decorator / Helper | Purpose | Example |
+|---|---|---|
+| `@rule("name")` | Registers a rule with a human-readable display name. | `@rule("api-not-db")` |
+| `@warn` | Marks a rule as warning-only (does not fail exit code). | `@warn` |
+| `@skip` / `@skip(reason="...")` | Temporarily skips a rule, optionally with a reason shown in output. | `@skip(reason="Refactor in progress")` |
+| `@since("YYYY-MM-DD")` | Limits violations to files changed since a specific date. | `@since("2026-01-01")` |
+| `group("name")` | Context manager that assigns a group to enclosed rules (used with `--group`). | `with group("Layer boundaries"):` |
+
+Decorator order tip: place `@rule(...)` first, then wrappers like `@warn`, `@skip`, or `@since`.
+
+| Command | Description | Example |
+|---|---|---|
+| `archetype init [path]` | Detects project structure and generates a starter `architecture.py` file. | `archetype init .` |
+| `archetype check [path]` | Loads `architecture.py` and runs all registered architecture rules. | `archetype check .` |
+| `archetype check [path] --group <name>` | Runs only rules that belong to the specified group. | `archetype check . --group core` |
+
+
+
+## Perfect For
+
+- Growing Python monoliths
+- Modular backends
+- Clean Architecture projects
+- Hexagonal Architecture
+- Domain-driven design
+- Teams scaling beyond “tribal knowledge”
+
+---
+
+## Installation
+
+```bash
+pip install archetype-py
+```
+
+Requires Python 3.11+.
+
+---
+
+## Build & Test
+
+For local development, install dev dependencies, run the test suite, and run architecture checks before opening a PR.
+
+```bash
+pip install -e ".[dev]"
+pytest
+archetype check .
+```
+
+
+---
+
+## Exit Codes
+
+- `0`: no blocking failures (passes and warnings only)
+- `1`: one or more blocking rule failures
+
+---
+
+## Troubleshooting
+
+- `Error: architecture.py not found`: run `archetype init .` in your project root, or pass the correct path to `archetype check <path>`.
+- Rules seem to do nothing: confirm your rules are decorated with `@rule("...")`; undecorated functions are not registered.
+- `@since(...)` behavior is unexpected: verify the date format is `YYYY-MM-DD` and that your git history is available in the checked path.
+- Import path mismatches: use fully qualified module paths (`myapp.api`, not file paths like `src/api.py`).
+
+---
+
+## Roadmap
+
+Planned improvements include:
+- Graph visualization
+- Architecture diffing
+- IDE integrations
+- Rich HTML reports
+- More built-in rule primitives
+
+---
+
+## Contributing
+
+Contributions are welcome:
+- bug fixes
+- rule ideas
+- docs improvements
+- integrations
+- performance work
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+---
+
+## Support The Project
+
+If archetype-py helps your team:
+
+⭐ Star the repository  
+🐛 Open issues  
+🧠 Share feedback  
+🔧 Contribute improvements
+
+Every star genuinely helps the project grow.