archunitpython 1.0.0__tar.gz

archunitpython-1.0.0/.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+indent_size = 2
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2
+
+[*.yaml]
+indent_size = 2

archunitpython-1.0.0/.gitattributes

@@ -0,0 +1,2 @@
+*.md linguist-tab-width=2
+* text=auto eol=lf

archunitpython-1.0.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug Report
+about: Create a report to help us improve ArchUnitPython
+title: '[BUG] '
+labels: ['bug']
+assignees: []
+---
+
+# Bug Report
+
+Describe what the bug is and what you expected to happen.
+
+## Steps to Reproduce
+
+1.
+2.
+3.
+
+## Environment
+
+- OS: [e.g. Windows 11, macOS, Ubuntu]
+- Python: [e.g. 3.12.0]
+- ArchUnitPython: [e.g. 0.1.0]
+- Testing Framework: [e.g. pytest, unittest]
+
+## Code Sample
+
+```python
+# Minimal reproduction case
+```

archunitpython-1.0.0/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,54 @@
+---
+name: Documentation
+about: Request documentation improvements or report documentation issues
+title: '[DOCS] '
+labels: ['documentation']
+assignees: []
+---
+
+# Documentation Issue
+
+Describe what documentation needs to be improved or what's unclear.
+
+## What's Missing
+
+- [ ] README.md
+- [ ] API Documentation
+- [ ] Examples
+- [ ] Contributing Guide
+- [ ] Other: **__**
+
+## Suggested Improvement
+
+What would make the documentation better?
+
+## Specific Sections
+
+**Which sections need attention?**
+Point to specific sections, methods, or examples that need work.
+
+## Target Audience
+
+**Who is this documentation for?**
+
+- [ ] New users getting started
+- [ ] Experienced developers
+- [ ] Contributors
+- [ ] Specific framework users (pytest, unittest, etc.)
+
+## Content Suggestions
+
+**Do you have specific content to suggest?**
+If you have ideas for the content, examples, or improvements, please share them.
+
+## Volunteer
+
+**Would you like to help improve this documentation?**
+
+- [ ] Yes, I can submit a PR for this
+- [ ] Yes, but I need guidance
+- [ ] No, just reporting the issue
+
+## Additional Context
+
+Add any other context about the documentation request here.

archunitpython-1.0.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,55 @@
+---
+name: Feature Request
+about: Suggest an idea for ArchUnitPython
+title: '[FEATURE] '
+labels: ['enhancement']
+assignees: []
+---
+
+# Feature Request
+
+Describe the feature you'd like to see added.
+
+## Problem
+
+What problem does this solve? Is your feature request related to a problem?
+
+## Proposed Solution
+
+How would this feature work? What would the API look like?
+
+```python
+# Example usage
+from archunitpython import project_files
+
+rule = project_files("src/").in_folder("src").should().your_new_feature()
+assert_passes(rule)
+```
+
+## Use Case
+
+How would you use this feature in your project?
+
+## Alternatives Considered
+
+Describe alternatives you've considered.
+
+## Impact Assessment
+
+What areas would this affect?
+
+- [ ] Core architecture testing
+- [ ] File dependencies
+- [ ] Metrics calculation
+- [ ] Slice testing
+- [ ] Error messages
+- [ ] Test framework integration
+- [ ] Performance
+- [ ] Documentation
+
+## Checklist
+
+- [ ] I have searched existing issues to make sure this isn't a duplicate
+- [ ] I have provided a clear use case
+- [ ] I have considered the API design
+- [ ] I have thought about backward compatibility

archunitpython-1.0.0/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,37 @@
+---
+name: Question
+about: Ask a question about using ArchUnitPython
+title: '[QUESTION] '
+labels: ['question']
+assignees: []
+---
+
+# Question
+
+What would you like to know about ArchUnitPython?
+
+## What I'm Trying to Do
+
+Describe your goal or what you're trying to achieve.
+
+## Code Context
+
+```python
+# Your code here (if applicable)
+```
+
+## Environment
+
+- Python Version: [e.g. 3.12.0]
+- ArchUnitPython Version: [e.g. 0.1.0]
+- Testing Framework: [e.g. pytest, unittest]
+
+## Documentation Checked
+
+- [ ] README.md
+- [ ] Examples
+- [ ] GitHub Issues
+
+## Additional Context
+
+Add any other context about your question here.

archunitpython-1.0.0/.github/PAGES.md

@@ -0,0 +1,32 @@
+# GitHub Pages Configuration for ArchUnitPython Documentation
+
+## Documentation Site
+
+- **URL**: https://lukasniessen.github.io/ArchUnitPython/
+- **Source**: `docs/` folder generated by pdoc
+- **Updates**: Automatically on push to `main` branch
+
+## Documentation Generation
+
+- **Tool**: [pdoc](https://pdoc.dev/)
+- **Entry Point**: `src/archunitpython/`
+- **Output**: `docs/` folder
+- **Theme**: Default pdoc theme
+
+## GitHub Actions
+
+- **Documentation Deployment**: `.github/workflows/docs.yaml`
+- **Integration Tests**: `.github/workflows/integrate.yaml`
+
+## Local Development
+
+```bash
+# Install pdoc
+pip install pdoc
+
+# Generate documentation
+pdoc src/archunitpython/ -o docs/
+
+# Serve locally
+pdoc src/archunitpython/
+```

archunitpython-1.0.0/.github/dependabot.yml

@@ -0,0 +1,39 @@
+version: 2
+updates:
+    - package-ecosystem: 'pip'
+      directory: '/'
+      schedule:
+          interval: 'weekly'
+      commit-message:
+          prefix: 'fix'
+          include: 'scope'
+      labels:
+          - 'dependencies'
+      open-pull-requests-limit: 10
+
+      groups:
+          minor-and-patch:
+              update-types:
+                  - 'minor'
+                  - 'patch'
+
+      ignore:
+          - dependency-name: '*'
+            update-types:
+                - 'version-update:semver-major'
+
+    - package-ecosystem: 'github-actions'
+      directory: '/'
+      schedule:
+          interval: 'weekly'
+      commit-message:
+          prefix: 'fix'
+          include: 'scope'
+      labels:
+          - 'dependencies'
+      open-pull-requests-limit: 10
+
+      groups:
+          actions-updates:
+              patterns:
+                  - '*'

archunitpython-1.0.0/.github/pull_request_template.md

@@ -0,0 +1,10 @@
+# Pull Request
+
+Briefly describe changes and purpose. If there's a related issue, make sure to mention that.
+
+## Change Type
+
+- [ ] Bug fix
+- [ ] Feature
+- [ ] Documentation
+- [ ] Refactoring

archunitpython-1.0.0/.github/workflows/docs.yaml

@@ -0,0 +1,59 @@
+name: Deploy Documentation
+
+on:
+    push:
+        branches: [main]
+
+# Allow one concurrent deployment
+concurrency:
+    group: 'pages'
+    cancel-in-progress: true
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+jobs:
+    # Build job
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v6
+              with:
+                  fetch-depth: 0
+
+            - name: Setup Python
+              uses: actions/setup-python@v6
+              with:
+                  python-version: '3.12'
+
+            - name: Install dependencies
+              run: |
+                  pip install -e ".[dev]"
+                  pip install pdoc
+
+            - name: Generate documentation
+              run: pdoc src/archunitpython/ -o docs/ --docformat google
+
+            - name: Setup Pages
+              uses: actions/configure-pages@v6
+
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v4
+              with:
+                  path: './docs'
+
+    # Deployment job - only runs on main branch pushes
+    deploy:
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        needs: build
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v5

archunitpython-1.0.0/.github/workflows/integrate.yaml

@@ -0,0 +1,77 @@
+name: Integrate
+on:
+    - push
+    - pull_request
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+jobs:
+    integrate:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: ["3.10", "3.11", "3.12", "3.13"]
+        steps:
+            - uses: actions/checkout@v6
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v6
+              with:
+                  python-version: ${{ matrix.python-version }}
+            - name: Cache pip
+              uses: actions/cache@v5
+              with:
+                  path: ~/.cache/pip
+                  key: pip-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}
+                  restore-keys: |
+                      pip-${{ runner.os }}-${{ matrix.python-version }}-
+            - name: Install dependencies
+              run: pip install -e ".[dev]"
+            - name: Lint
+              run: ruff check src/
+            - name: Type check
+              run: mypy src/archunitpython/ --ignore-missing-imports
+            - name: Test
+              run: pytest --tb=short -q
+
+    publish:
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+        needs: integrate
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+            issues: write
+            pull-requests: write
+            id-token: write
+        steps:
+            - uses: actions/checkout@v6
+              with:
+                  fetch-depth: 0
+                  token: ${{ secrets.GITHUB_TOKEN }}
+            - name: Setup Node.js
+              uses: actions/setup-node@v6
+              with:
+                  node-version: 22
+            - name: Set up Python
+              uses: actions/setup-python@v6
+              with:
+                  python-version: "3.12"
+            - name: Install semantic-release plugins
+              run: npm install -g semantic-release @semantic-release/changelog @semantic-release/git @semantic-release/exec @semantic-release/github
+            - name: Semantic Release
+              id: release
+              run: npx semantic-release
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            # After semantic-release: re-read the (potentially bumped) pyproject.toml,
+            # build, and publish to PyPI
+            - name: Pull latest (version-bumped) commit
+              run: git pull --ff-only origin main || true
+            - name: Install build tools
+              run: pip install build twine
+            - name: Build package
+              run: python -m build
+            - name: Publish to PyPI
+              env:
+                  TWINE_USERNAME: __token__
+                  TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+              run: twine upload dist/* --skip-existing

archunitpython-1.0.0/.github/workflows/stale.yaml

@@ -0,0 +1,23 @@
+name: Close inactive issues
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v10
+        with:
+          days-before-issue-stale: 365
+          days-before-issue-close: 365
+          stale-issue-label: "stale"
+          stale-issue-message: "This issue is stale because it has been open for 365 days with no activity."
+          close-issue-message: "This issue was closed because it has been inactive for 365 days since being marked as stale."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

archunitpython-1.0.0/.gitignore

@@ -0,0 +1,26 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+dist/
+build/
+*.egg-info/
+*.egg
+.eggs/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+*.log
+.env
+.venv/
+venv/
+ENV/
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+logs/
+test-output/

archunitpython-1.0.0/.releaserc.json

@@ -0,0 +1,27 @@
+{
+	"branches": ["main"],
+	"plugins": [
+		"@semantic-release/commit-analyzer",
+		"@semantic-release/release-notes-generator",
+		[
+			"@semantic-release/changelog",
+			{
+				"changelogFile": "CHANGELOG.md"
+			}
+		],
+		[
+			"@semantic-release/exec",
+			{
+				"prepareCmd": "python -c \"import re, pathlib; p=pathlib.Path('pyproject.toml'); p.write_text(re.sub(r'version = \\\"[^\\\"]+\\\"', f'version = \\\"${nextRelease.version}\\\"', p.read_text()))\""
+			}
+		],
+		[
+			"@semantic-release/git",
+			{
+				"assets": ["pyproject.toml", "CHANGELOG.md"],
+				"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+			}
+		],
+		"@semantic-release/github"
+	]
+}

archunitpython-1.0.0/CHANGELOG.md

@@ -0,0 +1,47 @@
+# 1.0.0 (2026-04-02)
+
+
+* feat!: rename package from archunitpy to archunitpython ([95c0b3a](https://github.com/LukasNiessen/ArchUnitPython/commit/95c0b3a0047534302f04e42c0bfca3389c9926bf))
+
+
+### Bug Fixes
+
+* **deps:** bump the actions-updates group with 7 updates ([54521e4](https://github.com/LukasNiessen/ArchUnitPython/commit/54521e492256dcd1f612f119ae03ec87a08dd0c1))
+* lint issues ([d69666b](https://github.com/LukasNiessen/ArchUnitPython/commit/d69666b9cb179225d5520f696035e5ca28f2b7ff))
+* pypi packaging config ([5bc8b8e](https://github.com/LukasNiessen/ArchUnitPython/commit/5bc8b8eec35b5dcdd8cb391216181963970e4e6e))
+* README ([9d41438](https://github.com/LukasNiessen/ArchUnitPython/commit/9d414386245de7288ff441618f0dd56215d032ca))
+* resolve all ruff lint errors ([3a349f9](https://github.com/LukasNiessen/ArchUnitPython/commit/3a349f95c686df2bfb0582bcafeeef5e109ba626))
+* update README ([e3e8949](https://github.com/LukasNiessen/ArchUnitPython/commit/e3e89493bcdd3458221666cb5f7ee46dc7996a8c))
+
+
+### BREAKING CHANGES
+
+* Package import changed from `import archunitpy` to
+`import archunitpython`.
+
+Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
+
+# Changelog
+
+All notable changes to ArchUnitPython will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!-- This file is automatically updated by python-semantic-release. -->
+
+## [0.1.0] (2026-04-01)
+
+### Features
+
+* Initial release of ArchUnitPython
+* File-level architecture rules: circular dependencies, layer dependencies, naming conventions, custom rules
+* Slice-level architecture rules: PlantUML diagram validation, forbidden dependency checks
+* Code metrics: 8 count metrics, 8 LCOM cohesion variants, distance metrics (abstractness, instability, zones)
+* Custom metrics with arbitrary calculation and assertion logic
+* HTML report export (experimental)
+* Pattern matching with glob and regex support
+* Testing integration: `assert_passes()` for pytest, `check()` for any framework
+* Debug logging with file output
+* Empty test protection
+* Zero runtime dependencies

archunitpython-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing
+
+Thanks for contributing!
+
+## Setup
+
+- Fork & clone: `git clone https://github.com/LukasNiessen/ArchUnitPython.git`
+- Install: `pip install -e ".[dev]"`
+- Test: `pytest`
+- Lint: `ruff check src/`
+- Type check: `mypy src/archunitpython/`
+
+## Guidelines
+
+- Code Style: Run `ruff check` and `ruff format` before committing
+- Commits: Use [Conventional Commits](https://www.conventionalcommits.org/) (see below)
+- PRs: Use feature branches, clear descriptions, ensure CI passes
+- Tests: Maintain high coverage
+
+## Commit Convention
+
+We use [Conventional Commits](https://www.conventionalcommits.org/) to automate versioning and changelog generation via [semantic-release](https://github.com/semantic-release/semantic-release). Your commit messages determine the next version number:
+
+| Commit prefix | Version bump | Example |
+|---|---|---|
+| `fix:` | Patch (0.1.0 -> 0.1.1) | `fix: handle empty project in graph extraction` |
+| `feat:` | Minor (0.1.0 -> 0.2.0) | `feat: add support for namespace packages` |
+| `feat!:` or `BREAKING CHANGE:` in footer | Major (0.1.0 -> 1.0.0) | `feat!: remove deprecated API` |
+
+Other prefixes like `chore:`, `docs:`, `refactor:`, `test:`, `ci:` do **not** trigger a release.
+
+## Releases
+
+Releases are fully automated. When a PR is merged to `main`:
+
+1. CI runs lint + type checking + tests (across Python 3.10-3.13)
+2. If CI passes, [semantic-release](https://github.com/semantic-release/semantic-release) analyzes commit messages since the last release
+3. If there are `fix:` or `feat:` commits, it automatically:
+   - Bumps the version in `pyproject.toml`
+   - Updates `CHANGELOG.md`
+   - Publishes to PyPI
+   - Creates a GitHub release with release notes
+
+No manual version bumping or publishing is needed.
+
+## Documentation
+
+Documentation is automatically generated from Python docstrings using [pdoc](https://pdoc.dev/) and deployed to GitHub Pages.
+
+### Local Development
+
+```bash
+# Install pdoc
+pip install pdoc
+
+# Generate docs
+pdoc src/archunitpython/ -o docs/
+
+# Serve locally with live reload
+pdoc src/archunitpython/
+```
+
+### Writing Good Documentation
+
+- Add docstrings to all public APIs
+- Use Google-style docstring format
+- Include code examples in docstrings where helpful
+- Keep docstrings concise but informative
+
+### Documentation Deployment
+
+- Documentation is automatically deployed to [GitHub Pages](https://lukasniessen.github.io/ArchUnitPython/) on push to `main`
+- Configuration is in `.github/workflows/docs.yaml`
+
+## Issues
+
+Bugs: Include environment, expected/actual behavior, steps, errors
+Features: Check existing issues, provide use case
+
+## Code of Conduct
+
+Be respectful and inclusive.
+Happy coding!

archunitpython-1.0.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Lukas Niessen <lks.niessen@gmail.com> https://lukasniessen.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.