checkowners 0.1.0__tar.gz

checkowners-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Run tests
+        run: hatch run test
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Run linters
+        run: hatch run lint
+
+      - name: Check formatting
+        run: hatch run fmt --check

checkowners-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,43 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Build package
+        run: hatch build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

checkowners-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

checkowners-0.1.0/CLAUDE.md

@@ -0,0 +1,73 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## What This Is
+
+checkOwners: a CODEOWNERS inference engine driven by git commit history with drift detection and CI integration. Pure-git, no-LLM. Python 3.11+, packaged with hatch, distributed on PyPI and as a composite GitHub Action.
+
+## Commands
+
+```bash
+hatch run test                          # pytest with coverage (85%+ target)
+hatch run test -- tests/test_analyze.py # single test file
+hatch run test -- -k "test_name"        # single test by name
+hatch run lint                          # ruff check + mypy --strict
+hatch run fmt                           # ruff format
+hatch build                             # sdist + wheel in dist/
+```
+
+CLI entry point is `checkowners` (Typer app in `checkowners/cli.py`):
+`analyze`, `generate`, `print`, `validate`, `drift`, `notify`, `sync`.
+All subcommands support `--json` for structured JSON output.
+
+## Architecture
+
+```
+checkowners/
+  cli.py        # Typer app; all subcommands registered here
+  analyze.py    # git log + git blame -> OwnershipMap
+  generate.py   # OwnershipMap -> .github/CODEOWNERS writer
+  drift.py      # State machine: inferred vs. current diff -> DriftResult
+  notify.py     # Webhook POST on drift events
+  validate.py   # Syntax-only CODEOWNERS validator
+  config.py     # PyYAML loader for .github/checkowners.yml
+  models.py     # Dataclasses: OwnershipMap, DriftResult, Config
+  state.py      # ~/.checkowners/state.json reader/writer
+tests/
+  test_analyze.py
+  test_generate.py
+  test_drift.py
+  test_validate.py
+  integration/  # Fixture git repos via GitPython
+action.yml      # Composite GitHub Action
+```
+
+Key data flow: `config.py` loads `.github/checkowners.yml` -> `analyze.py` runs git log/blame -> `models.OwnershipMap` -> `generate.py` writes CODEOWNERS or `drift.py` compares against existing CODEOWNERS -> `models.DriftResult` -> `notify.py` posts webhooks. `state.py` persists inference results to `~/.checkowners/state.json`.
+
+## Conventions
+
+- Functional style throughout; no classes except dataclasses in `models.py`
+- Type hints on every function signature; strict mypy (`--strict`)
+- All file paths via `pathlib.Path`, never hardcoded strings
+- Config file: `.github/checkowners.yml` (per-repo; loaded via `config.py`)
+- State file: `~/.checkowners/state.json` (auto-maintained; never hardcode path)
+- Every write to `.github/CODEOWNERS` must include: `# Generated by checkOwners. Do not edit manually.`
+- Default exclusions: `*.lock`, `dist/**`, `vendor/**`
+- Config defaults: `lookback_days: 180`, `min_commits: 3`, `top_n_owners: 2`
+- Drift state machine modes: `commit`, `repo`, `both`
+
+## Testing
+
+- Unit tests mock all subprocess calls (`git log`, `git blame`); never require a real git repo
+- Integration tests in `tests/integration/` use fixture repos created with GitPython
+- Every module has a corresponding `tests/test_<module>.py`
+
+## Do NOT
+
+- Add LLM or AI dependencies; checkOwners is pure-git inference only
+- Write to `.github/CODEOWNERS` without the machine-generated header
+- Make external network calls except in `notify.py` (webhook POST) and `action.yml` (GitHub API)
+- Use classes except dataclasses in `models.py`
+- Skip type annotations on any function signature
+- Modify `state.json` schema without bumping the schema version field

checkowners-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Samir Musali
+
+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.

checkowners-0.1.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: checkowners
+Version: 0.1.0
+Summary: Infer and maintain CODEOWNERS from git history. Drift detection, CI-native JSON output, and GitHub Actions integration.
+Author-email: Samir Musali <samir.musali@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,codeowners,drift-detection,git,github-actions,ownership
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: gitpython>=3.1.0
+Requires-Dist: pygithub>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Description-Content-Type: text/markdown
+
+# checkowners
+
+[![PyPI version](https://img.shields.io/pypi/v/checkowners)](https://pypi.org/project/checkowners/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+Infer and maintain CODEOWNERS from git history. Drift detection, CI-native JSON output, and GitHub Actions integration.
+
+## Installation
+
+```bash
+pip install checkowners
+```
+
+## Quick Start
+
+```bash
+# Infer ownership from git commit history
+checkowners analyze
+
+# Generate .github/CODEOWNERS from inference
+checkowners generate
+
+# Detect drift between inferred and current CODEOWNERS
+checkowners drift
+
+# Validate CODEOWNERS syntax
+checkowners validate
+```
+
+All commands support `--json` for structured output.
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `checkowners analyze` | Infer file ownership from git history |
+| `checkowners generate` | Write `.github/CODEOWNERS` from inferred ownership |
+| `checkowners print` | Print inferred owners to stdout |
+| `checkowners validate` | Validate existing CODEOWNERS syntax (no git access) |
+| `checkowners drift` | Compare inferred vs. current CODEOWNERS |
+| `checkowners notify` | POST webhook on drift events |
+| `checkowners sync` | Generate CODEOWNERS and commit the result |
+
+## Configuration
+
+Create `.github/checkowners.yml` in your repository:
+
+```yaml
+analysis:
+  lookback_days: 180        # How far back to analyze
+  min_commits: 3            # Minimum commits to qualify as owner
+  top_n_owners: 2           # Max owners per path
+
+paths:
+  exclude:
+    - "*.lock"
+    - "dist/**"
+    - "vendor/**"
+
+output:
+  header: "# Generated by checkOwners. Do not edit manually."
+  include_unowned: false    # Show paths with no inferred owner
+
+drift:
+  mode: commit              # commit | repo | both
+  compare_to: auto
+
+notifications:
+  webhook_url: ""           # POST here on drift events
+  include_unchanged: false
+```
+
+All fields are optional. Defaults are shown above.
+
+## Drift Detection Modes
+
+- **commit**: detect paths in the inferred map that are missing from CODEOWNERS
+- **repo**: detect CODEOWNERS entries that are stale or have changed owners
+- **both**: run both checks
+
+## GitHub Actions
+
+```yaml
+- name: Check CODEOWNERS drift
+  run: |
+    pip install checkowners
+    checkowners drift --json
+```
+
+Set `drift.mode: both` in your config and fail the step when `drift_detected` is true.
+
+## Development
+
+```bash
+hatch run test              # pytest with coverage
+hatch run lint              # ruff check + mypy --strict
+hatch run fmt               # ruff format
+```
+
+## License
+
+MIT