pni501 0.1.0__tar.gz

pni501-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.3
+Name: pni501
+Version: 0.1.0
+Summary: Project Nemesis Index (PNI) - Evaluate software development project health and generate reports.
+Author: Yuichi Ito
+Author-email: Yuichi Ito <yuichi@yuichi.com>
+License: Apache-2.0
+Requires-Dist: typer>=0.12.0
+Requires-Dist: rich>=13.0.0
+Requires-Python: >=3.11
+Project-URL: Repository, https://github.com/yuichi110/pni501
+Description-Content-Type: text/markdown
+
+# pni501 (Project Nemesis Index)
+
+**Project Nemesis Index (PNI)** evaluates software development project health and generates diagnostic reports to help engineering teams identify risks, maintain architectural integrity, and improve delivery velocity.
+
+---
+
+## Overview
+
+Software projects naturally accumulate friction—technical debt, uneven test coverage, stagnant dependencies, architectural drift, and workflow bottlenecks. **PNI (Project Nemesis Index)** analyzes software repositories to produce quantifiable health scores and actionable reports.
+
+- **Package Name (PyPI)**: `pni501`
+- **Import Module**: `pni`
+- **CLI Command**: `pni501`
+- **Developer Management Tool**: `./pcli`
+
+---
+
+## Installation
+
+Install via `pip`:
+
+```bash
+pip install pni501
+```
+
+Or using `uv`:
+
+```bash
+uv add pni501
+```
+
+---
+
+## Quickstart
+
+Verify the installation:
+
+```bash
+pni501 version
+```
+
+Display CLI options and help:
+
+```bash
+pni501 --help
+```
+
+---
+
+## Development
+
+This project is managed with `uv` and uses `./pcli` (`tools/pcli`) for development workflows.
+
+### 1. Shell Setup
+
+Run `./pcli` to inspect available toolsets or source it to enable dynamic autocompletion:
+
+```bash
+./pcli                    # Display available toolsets
+source ./pcli             # Register 'pcli' shell alias & autocompletion
+```
+
+### 2. Available Toolsets
+
+| Toolset | Command | Description |
+| :--- | :--- | :--- |
+| **`code-check`** | `./pcli code-check all [--fix]` | Ruff linting & formatting, Ty static type checking |
+| **`test`** | `./pcli test all [--cov]` | Run pytest unit tests with coverage |
+| **`pypi`** | `./pcli pypi check-version` | Verify versions, inspect dependencies & publish |
+
+```bash
+# Code Quality
+./pcli code-check lint [--fix]
+./pcli code-check type
+./pcli code-check lines
+./pcli code-check all
+
+# Testing
+./pcli test all
+./pcli test pni
+./pcli test pcli
+
+# PyPI Management
+./pcli pypi check-version
+./pcli pypi publish --test-pypi
+./pcli pypi publish
+```
+
+---
+
+## License
+
+This project is licensed under the Apache 2.0 License. See [LICENSE](LICENSE) for details.

pni501-0.1.0/README.md

@@ -0,0 +1,93 @@
+# pni501 (Project Nemesis Index)
+
+**Project Nemesis Index (PNI)** evaluates software development project health and generates diagnostic reports to help engineering teams identify risks, maintain architectural integrity, and improve delivery velocity.
+
+---
+
+## Overview
+
+Software projects naturally accumulate friction—technical debt, uneven test coverage, stagnant dependencies, architectural drift, and workflow bottlenecks. **PNI (Project Nemesis Index)** analyzes software repositories to produce quantifiable health scores and actionable reports.
+
+- **Package Name (PyPI)**: `pni501`
+- **Import Module**: `pni`
+- **CLI Command**: `pni501`
+- **Developer Management Tool**: `./pcli`
+
+---
+
+## Installation
+
+Install via `pip`:
+
+```bash
+pip install pni501
+```
+
+Or using `uv`:
+
+```bash
+uv add pni501
+```
+
+---
+
+## Quickstart
+
+Verify the installation:
+
+```bash
+pni501 version
+```
+
+Display CLI options and help:
+
+```bash
+pni501 --help
+```
+
+---
+
+## Development
+
+This project is managed with `uv` and uses `./pcli` (`tools/pcli`) for development workflows.
+
+### 1. Shell Setup
+
+Run `./pcli` to inspect available toolsets or source it to enable dynamic autocompletion:
+
+```bash
+./pcli                    # Display available toolsets
+source ./pcli             # Register 'pcli' shell alias & autocompletion
+```
+
+### 2. Available Toolsets
+
+| Toolset | Command | Description |
+| :--- | :--- | :--- |
+| **`code-check`** | `./pcli code-check all [--fix]` | Ruff linting & formatting, Ty static type checking |
+| **`test`** | `./pcli test all [--cov]` | Run pytest unit tests with coverage |
+| **`pypi`** | `./pcli pypi check-version` | Verify versions, inspect dependencies & publish |
+
+```bash
+# Code Quality
+./pcli code-check lint [--fix]
+./pcli code-check type
+./pcli code-check lines
+./pcli code-check all
+
+# Testing
+./pcli test all
+./pcli test pni
+./pcli test pcli
+
+# PyPI Management
+./pcli pypi check-version
+./pcli pypi publish --test-pypi
+./pcli pypi publish
+```
+
+---
+
+## License
+
+This project is licensed under the Apache 2.0 License. See [LICENSE](LICENSE) for details.

pni501-0.1.0/pyproject.toml

@@ -0,0 +1,108 @@
+[build-system]
+requires = ["uv-build<0.12"]
+build-backend = "uv_build"
+
+[project]
+name = "pni501"
+version = "0.1.0"
+description = "Project Nemesis Index (PNI) - Evaluate software development project health and generate reports."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "Apache-2.0" }
+authors = [{name = "Yuichi Ito", email = "yuichi@yuichi.com"}]
+dependencies = [
+    "typer>=0.12.0",
+    "rich>=13.0.0",
+]
+
+[project.urls]
+Repository = "https://github.com/yuichi110/pni501"
+
+[project.scripts]
+pni501 = "pni.cli:main"
+
+[tool.uv.build-backend]
+module-name = "pni"
+
+[dependency-groups]
+dev = [
+    "ruff>=0.9.0",
+    "pytest>=8.3.0",
+    "pytest-cov>=6.0.0",
+    "tomlkit>=0.14.0",
+    "ty>=0.0.35",
+    "typer>=0.12.0",
+    "rich>=13.0.0",
+    "pytest-xdist>=3.8.0",
+]
+
+[tool.ruff]
+preview = false
+fix = true
+unsafe-fixes = false
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "C90", # mccabe 
+    "F",   # Pyflakes
+    "D",   # pydocstyle
+    "E",   # Pycodestyle Error
+    "I",   # isort
+    "N",   # pep8-naming (N)
+    "W",   # Pycodestyle Warning
+    "ANN", # flake8-annotations (ANN)
+    "CPY", # flake8-copyright
+    "S",   # flake8-bandit
+    "PL"   # Pylint
+]
+
+ignore = [
+    "D203",    # 1 blank line required before class docstring
+    "D212",    # Multi-line docstring summary should start at the first line
+    "D415",    # First line should end with a period, question mark, or exclamation point
+    "F401",    # imported but unused
+    "PLC0414", # Import alias does not rename original package
+    "PLC1901", # compare-to-empty-string
+    "PLR0904", # Too many public methods
+    "PLR0912", # Too many branches
+    "PLR0913", # Too many arguments in function definition
+    "PLR0914", # Too many local variables
+    "PLR0915", # Too many statements
+    "PLR0917", # Too many positional arguments
+    "PLR2004", # Magic value used in comparison
+    "PLW2901"  # Outer variable overwritten by inner target
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tools/**.py" = [
+    "ANN",     # flake8-annotations
+    "S101",    # Use of assert detected
+    "S310",    # Audit URL open for permitted schemes
+    "S404",    # Subprocess module usage
+    "S603",    # Subprocess call without shell=True
+    "S607",    # Subprocess with partial executable path
+    "PLC2701", # Private name import from external module
+    "PLR6301", # Method could be a function/static method
+]
+"tests/**.py" = [
+    "F403", # undefined-local-with-import-star
+    "F405", # undefined-local-with-import-star-usage
+    "D100", # undocumented-public-module
+    "D101", # undocumented-public-class
+    "D102", # undocumented-public-method
+    "D103", # undocumented-public-function
+    "D104", # undocumented-public-package
+    "D107", # undocumented-public-init
+    "ANN",  # flake8-annotations
+    "CPY",  # flake8-copyright
+    "S101", # Use of assert detected
+    "PLC2701", # Private name import from external module (standard for unit tests)
+    "PLR6301" # Method could be a function/static method (standard for pytest classes)
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

pni501-0.1.0/src/pni/__init__.py

@@ -0,0 +1,25 @@
+# Copyright (c) 2026 Yuichi Ito (yuichi@yuichi.com)
+#
+# This software is licensed under the Apache License, Version 2.0.
+# For more information, please visit: https://github.com/yuichi110/pni501
+#
+# This 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.
+
+"""Project Nemesis Index (PNI) - Evaluate software development project health and generate reports."""
+
+from __future__ import annotations
+
+from typing import Final
+
+LIB_NAME: Final[str] = "pni501"
+LIB_VERSION: Final[str] = "0.1.0"
+
+__version__: Final[str] = LIB_VERSION
+
+__all__ = [
+    "LIB_NAME",
+    "LIB_VERSION",
+    "__version__",
+]

pni501-0.1.0/src/pni/cli.py

@@ -0,0 +1,48 @@
+# Copyright (c) 2026 Yuichi Ito (yuichi@yuichi.com)
+#
+# This software is licensed under the Apache License, Version 2.0.
+# For more information, please visit: https://github.com/yuichi110/pni501
+#
+# This 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.
+
+"""Command line interface for Project Nemesis Index (pni501)."""
+
+from __future__ import annotations
+
+import typer
+from rich.console import Console
+
+from pni import LIB_NAME, LIB_VERSION
+
+app = typer.Typer(
+    name="pni501",
+    help="Project Nemesis Index (PNI) - Evaluate software development project health and generate reports.",
+)
+console = Console()
+
+
+@app.command()
+def version() -> None:
+    """Show pni501 version."""
+    console.print(f"[bold cyan]{LIB_NAME}[/bold cyan] version [bold green]{LIB_VERSION}[/bold green]")
+
+
+@app.callback(invoke_without_command=True)
+def callback(ctx: typer.Context) -> None:
+    """PNI 501 entrypoint callback."""
+    if ctx.invoked_subcommand is None:
+        console.print("[bold cyan]Project Nemesis Index (PNI)[/bold cyan]")
+        console.print(f"{LIB_NAME} version [bold green]{LIB_VERSION}[/bold green]\n")
+        console.print("Evaluate software development project health and generate reports.")
+        console.print("Run [bold]pni501 --help[/bold] for available commands.")
+
+
+def main() -> None:
+    """Execute pni501 CLI."""
+    app()
+
+
+if __name__ == "__main__":
+    main()