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

archetype_py-0.3.0/.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.3.0/.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.3.0}/.github/workflows/archetype.yml

@@ -4,8 +4,13 @@ on:
   push:
     branches:
       - main
+    tags:
+      - "v*"
   pull_request:
 
+permissions:
+  contents: read
+
 jobs:
   archetype:
     runs-on: ubuntu-latest
@@ -13,7 +18,11 @@ jobs:
     steps:
       # Pull down your repository code so CI can inspect it.
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
+        with:
+          token: ${{ github.token }}
+          ref: ${{ github.ref }}
+          fetch-depth: 0
 
       # Install Python 3.11 so the Archetype CLI can run.
       - name: Set up Python
@@ -28,9 +37,15 @@ jobs:
           pip install archetype-py
 
       # Run architecture rules defined in architecture.py.
-      # This step exits non-zero on violations, which fails the workflow.
+      # If the installed Archetype supports GitHub annotations, emit inline
+      # PR annotations. Otherwise, fall back to standard checks.
       - name: Run architecture checks
-        run: archetype check .
+        run: |
+          if archetype check --help | grep -q -- '--github-annotations'; then
+            archetype check . --github-annotations
+          else
+            archetype check .
+          fi
 
       # If your team already runs pytest in CI, you can skip this workflow file.
       # Archetype's pytest plugin runs architecture.py rules automatically during pytest.

{archetype_py-0.2.2 → archetype_py-0.3.0}/.github/workflows/ci.yml

@@ -4,8 +4,13 @@ on:
   push:
     branches:
       - main
+    tags:
+      - "v*"
   pull_request:
 
+permissions:
+  contents: read
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -16,7 +21,11 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
+        with:
+          token: ${{ github.token }}
+          ref: ${{ github.ref }}
+          fetch-depth: 0
 
       - name: Set up Python
         uses: actions/setup-python@v5

{archetype_py-0.2.2 → archetype_py-0.3.0}/.github/workflows/publish.yml

@@ -8,11 +8,17 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
 
     steps:
       # Checkout repository contents for test execution.
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
+        with:
+          token: ${{ github.token }}
+          ref: ${{ github.ref }}
+          fetch-depth: 0
 
       # Install Python runtime used for tests and packaging checks.
       - name: Set up Python
@@ -40,7 +46,11 @@ jobs:
     steps:
       # Checkout repository contents so the package can be built.
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
+        with:
+          token: ${{ github.token }}
+          ref: ${{ github.ref }}
+          fetch-depth: 0
 
       # Set up Python for building distribution artifacts.
       - name: Set up Python

{archetype_py-0.2.2 → archetype_py-0.3.0}/.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.3.0}/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.3.0 - 2026-05-26
+
+### Added
+- Git pre-commit hook integration via `archetype install-hook`.
+- GitHub PR inline annotations support with `--github-annotations`.
+- Baseline mode for legacy repositories via `--write-baseline` and `--baseline`.
+- Project config defaults through `archetype.toml`.
+- Exclude paths support via CLI (`--exclude`) and config.
+- Versioned JSON contract with explicit `schema_version`.
+- Namespace package and monorepo layout support improvements.
+- Changed-files mode with `--changed-from <git-ref>`.
+
+### Changed
+- CI/release workflows expanded to cover new check and packaging behaviors.
+
 ## 0.1.0 - 2026-05-09
 
 ### Added
@@ -43,3 +58,22 @@
 - 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
+- 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.3.0/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.3.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: archetype-py
+Version: 0.3.0
+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
+
+# archetype-py
+
+Enforce architectural rules as code. Catch structural violations before they merge.
+
+[GitHub Repository](https://github.com/MossabArektout/archetype-py)  
+[Documentation](https://github.com/MossabArektout/archetype-py#readme)
+
+## 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
+
+```bash
+pip install archetype-py
+```
+
+## Quick Start
+
+```bash
+archetype init .
+archetype check .
+```
+
+Create an `architecture.py` file and define your 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()
+```
+
+## 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`)
+- 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
+
+```yaml
+- run: archetype check .
+```
+
+For full guides, examples, and release notes, use the GitHub README and changelog.

archetype_py-0.3.0/PYPI.md

@@ -0,0 +1,77 @@
+# archetype-py
+
+Enforce architectural rules as code. Catch structural violations before they merge.
+
+[GitHub Repository](https://github.com/MossabArektout/archetype-py)  
+[Documentation](https://github.com/MossabArektout/archetype-py#readme)
+
+## 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
+
+```bash
+pip install archetype-py
+```
+
+## Quick Start
+
+```bash
+archetype init .
+archetype check .
+```
+
+Create an `architecture.py` file and define your 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()
+```
+
+## 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`)
+- 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
+
+```yaml
+- run: archetype check .
+```
+
+For full guides, examples, and release notes, use the GitHub README and changelog.