maintainer-readiness-kit 0.6.1__tar.gz

maintainer_readiness_kit-0.6.1/LICENSE

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

maintainer_readiness_kit-0.6.1/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: maintainer-readiness-kit
+Version: 0.6.1
+Summary: Generate maintainer-readiness reports for open source repositories.
+Author: YUUDAI-s
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/YUUDAI-s/maintainer-readiness-kit
+Project-URL: Repository, https://github.com/YUUDAI-s/maintainer-readiness-kit
+Project-URL: Issues, https://github.com/YUUDAI-s/maintainer-readiness-kit/issues
+Keywords: open-source,maintainer,github,security,triage
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Maintainer Readiness Kit
+
+[![Maintainer readiness](https://github.com/YUUDAI-s/maintainer-readiness-kit/actions/workflows/maintainer-readiness.yml/badge.svg)](https://github.com/YUUDAI-s/maintainer-readiness-kit/actions/workflows/maintainer-readiness.yml)
+[![GitHub Action](https://img.shields.io/badge/GitHub%20Action-ready-brightgreen.svg)](action.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/Python-3.10%2B-3776AB.svg)](pyproject.toml)
+
+Maintainer Readiness Kit is a small, dependency-light CLI that audits an open
+source repository for maintainer-facing signals: documentation, license files,
+security policy, issue and pull request templates, CI, tests, recent git
+activity, and high-risk local secret files.
+
+The goal is simple: give solo and small-team maintainers a repeatable report
+they can use before publishing a repository, onboarding contributors, or asking
+for support from open source maintainer programs.
+
+## Who Should Use It
+
+- Maintainers preparing a repository for public contributors.
+- Solo developers who need a concrete pre-release checklist.
+- Teams that want CI to fail when maintainer basics regress.
+- Open source applicants who need honest, shareable evidence instead of vague
+  claims.
+
+## What It Helps You Decide
+
+Use it when you need a quick answer to:
+
+- Is this repository ready to make public?
+- What maintainer files are missing before I invite contributors?
+- Will CI fail if the repository falls below a readiness threshold?
+- What ecosystem-specific maintenance steps should I add next?
+- Can I share a report without leaking my local machine path?
+
+## Features
+
+- Scores maintainer-readiness signals with evidence and suggested fixes.
+- Reads local git activity without requiring network access.
+- Optionally enriches the report with public GitHub repository signals.
+- Summarizes stale open issues and pull requests for public GitHub reports.
+- Generates starter maintainer templates for `CONTRIBUTING.md`,
+  `SECURITY.md`, issue templates, pull request templates, and a GitHub Actions
+  smoke workflow.
+- Performs a conservative high-risk file check before public release.
+- Outputs Markdown or JSON for CI and handoff docs.
+- Outputs SARIF for CI and code-scanning workflows.
+- Outputs Shields endpoint badge JSON for project dashboards.
+- Runs as a reusable GitHub Action.
+- Classifies readiness as `ready`, `nearly-ready`, or `needs-work`.
+- Detects Python, Node.js, Rust, Go, and Java/JVM manifests and adds
+  ecosystem-specific maintainer recommendations.
+
+## Quick Start
+
+Install from the repository:
+
+```powershell
+git clone https://github.com/YUUDAI-s/maintainer-readiness-kit.git
+cd maintainer-readiness-kit
+python -m pip install -e .
+maintainer-readiness inspect . --output readiness-report.md
+maintainer-readiness inspect . --fail-under 90
+```
+
+Use it directly in GitHub Actions:
+
+```yaml
+steps:
+  - uses: actions/checkout@v4
+  - uses: YUUDAI-s/maintainer-readiness-kit@v0.6.0
+    with:
+      repo: owner/name
+      fail-under: "80"
+      output: readiness-report.md
+      sarif: readiness.sarif
+      badge-json: readiness-badge.json
+```
+
+Public demo repository:
+[`YUUDAI-s/maintainer-readiness-kit-action-demo`](https://github.com/YUUDAI-s/maintainer-readiness-kit-action-demo)
+uses `YUUDAI-s/maintainer-readiness-kit@v0.6.0` in CI.
+
+After the package is published to PyPI:
+
+```powershell
+python -m pip install maintainer-readiness-kit
+maintainer-readiness inspect . --output readiness-report.md
+```
+
+For local source development without installation:
+
+```powershell
+$env:PYTHONPATH = "src"
+python -m maintainer_readiness inspect . --output readiness-report.md
+python -m maintainer_readiness inspect . --fail-under 90
+```
+
+Typical output:
+
+```text
+Score: 100 / 100 (100.0%)
+Level: ready
+Ecosystem Recommendations: Python
+High-Risk File Warnings: No high-risk credential filenames found.
+```
+
+To include public GitHub signals:
+
+```powershell
+python -m maintainer_readiness inspect . --repo YUUDAI-s/maintainer-readiness-kit --output readiness-report.md
+```
+
+To add starter maintainer files to another repository:
+
+```powershell
+python -m maintainer_readiness init C:\path\to\repo
+```
+
+Use `--force` only when you intentionally want to overwrite an existing starter
+file.
+
+## Commands
+
+### `inspect`
+
+```powershell
+python -m maintainer_readiness inspect . --output readiness-report.md
+python -m maintainer_readiness inspect . --json
+python -m maintainer_readiness inspect . --repo owner/name
+python -m maintainer_readiness inspect . --root-label public-sample
+python -m maintainer_readiness inspect . --repo owner/name --stale-days 14
+python -m maintainer_readiness inspect . --sarif readiness.sarif
+python -m maintainer_readiness inspect . --badge-json readiness-badge.json
+```
+
+The Markdown report includes:
+
+- overall readiness score,
+- readiness level,
+- passing and missing signals,
+- local git maintenance evidence,
+- optional public GitHub evidence,
+- stale open issue and pull request counts when `--repo` is used,
+- high-risk file warnings,
+- ecosystem-specific recommendations,
+- next actions before public release.
+
+For CI, use `--fail-under` to make the command return a non-zero exit code when
+the readiness percentage is below your chosen threshold.
+
+Use `--stale-days` with `--repo` when your project has a shorter or longer
+triage window than the default 30 days.
+
+Use `--sarif readiness.sarif` when you want failed checks and high-risk file
+warnings in a code-scanning compatible format.
+
+Use `--badge-json readiness-badge.json` when you want a Shields-compatible
+endpoint JSON payload for a dashboard or docs site.
+
+### GitHub Actions
+
+```yaml
+name: Maintainer readiness
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  smoke:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: YUUDAI-s/maintainer-readiness-kit@v0.6.0
+        with:
+          repo: owner/name
+          fail-under: "80"
+          output: readiness-report.md
+          sarif: readiness.sarif
+          badge-json: readiness-badge.json
+      - uses: github/codeql-action/upload-sarif@v3
+        if: always()
+        with:
+          sarif_file: readiness.sarif
+```
+
+### `init`
+
+```powershell
+python -m maintainer_readiness init .
+```
+
+This writes starter maintainer files only when they do not already exist:
+
+- `CONTRIBUTING.md`
+- `SECURITY.md`
+- `MAINTAINERS.md`
+- `.github/ISSUE_TEMPLATE/bug_report.yml`
+- `.github/ISSUE_TEMPLATE/feature_request.yml`
+- `.github/PULL_REQUEST_TEMPLATE.md`
+- `.github/workflows/maintainer-readiness.yml`
+
+## Design Principles
+
+- Honest evidence over vanity metrics.
+- Minimal runtime dependencies.
+- Useful defaults for maintainers who work alone.
+- No external writes from `inspect`.
+- No claims that a repository qualifies for any external program.
+
+## Maintainer Workflows
+
+This project is built for routine maintainer tasks:
+
+- pre-publication checks before making a repository public,
+- contributor onboarding checks before accepting outside PRs,
+- release-readiness checks before tagging a version,
+- safety checks before attaching reports to sponsorship or maintainer-support
+  applications,
+- CI-friendly JSON output for repeatable repository hygiene reviews.
+
+## Limitations
+
+This tool cannot prove that a repository is widely adopted, safe, or eligible
+for any benefit. It only turns common maintainer signals into a compact,
+verifiable report. Program applications still require accurate information
+about the applicant, repository, role, usage, and maintainer status.
+
+## Development
+
+```powershell
+$env:PYTHONPATH = "src"
+python -m unittest discover -s tests
+python -m maintainer_readiness inspect . --output readiness-report.md
+```
+
+See [ROADMAP.md](ROADMAP.md) for near-term maintainer-focused work.
+See [examples/reports](examples/reports) for generated reports from real
+repositories.
+See the public action demo at
+[YUUDAI-s/maintainer-readiness-kit-action-demo](https://github.com/YUUDAI-s/maintainer-readiness-kit-action-demo).
+See [docs/pypi.md](docs/pypi.md) for package build and publishing notes.
+See [docs/community-launch.md](docs/community-launch.md) for community launch
+copy and posting rules.
+See [examples/github-action.yml](examples/github-action.yml) for a copyable
+GitHub Actions workflow.
+
+## License
+
+MIT

maintainer_readiness_kit-0.6.1/README.md

@@ -0,0 +1,251 @@
+# Maintainer Readiness Kit
+
+[![Maintainer readiness](https://github.com/YUUDAI-s/maintainer-readiness-kit/actions/workflows/maintainer-readiness.yml/badge.svg)](https://github.com/YUUDAI-s/maintainer-readiness-kit/actions/workflows/maintainer-readiness.yml)
+[![GitHub Action](https://img.shields.io/badge/GitHub%20Action-ready-brightgreen.svg)](action.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/Python-3.10%2B-3776AB.svg)](pyproject.toml)
+
+Maintainer Readiness Kit is a small, dependency-light CLI that audits an open
+source repository for maintainer-facing signals: documentation, license files,
+security policy, issue and pull request templates, CI, tests, recent git
+activity, and high-risk local secret files.
+
+The goal is simple: give solo and small-team maintainers a repeatable report
+they can use before publishing a repository, onboarding contributors, or asking
+for support from open source maintainer programs.
+
+## Who Should Use It
+
+- Maintainers preparing a repository for public contributors.
+- Solo developers who need a concrete pre-release checklist.
+- Teams that want CI to fail when maintainer basics regress.
+- Open source applicants who need honest, shareable evidence instead of vague
+  claims.
+
+## What It Helps You Decide
+
+Use it when you need a quick answer to:
+
+- Is this repository ready to make public?
+- What maintainer files are missing before I invite contributors?
+- Will CI fail if the repository falls below a readiness threshold?
+- What ecosystem-specific maintenance steps should I add next?
+- Can I share a report without leaking my local machine path?
+
+## Features
+
+- Scores maintainer-readiness signals with evidence and suggested fixes.
+- Reads local git activity without requiring network access.
+- Optionally enriches the report with public GitHub repository signals.
+- Summarizes stale open issues and pull requests for public GitHub reports.
+- Generates starter maintainer templates for `CONTRIBUTING.md`,
+  `SECURITY.md`, issue templates, pull request templates, and a GitHub Actions
+  smoke workflow.
+- Performs a conservative high-risk file check before public release.
+- Outputs Markdown or JSON for CI and handoff docs.
+- Outputs SARIF for CI and code-scanning workflows.
+- Outputs Shields endpoint badge JSON for project dashboards.
+- Runs as a reusable GitHub Action.
+- Classifies readiness as `ready`, `nearly-ready`, or `needs-work`.
+- Detects Python, Node.js, Rust, Go, and Java/JVM manifests and adds
+  ecosystem-specific maintainer recommendations.
+
+## Quick Start
+
+Install from the repository:
+
+```powershell
+git clone https://github.com/YUUDAI-s/maintainer-readiness-kit.git
+cd maintainer-readiness-kit
+python -m pip install -e .
+maintainer-readiness inspect . --output readiness-report.md
+maintainer-readiness inspect . --fail-under 90
+```
+
+Use it directly in GitHub Actions:
+
+```yaml
+steps:
+  - uses: actions/checkout@v4
+  - uses: YUUDAI-s/maintainer-readiness-kit@v0.6.0
+    with:
+      repo: owner/name
+      fail-under: "80"
+      output: readiness-report.md
+      sarif: readiness.sarif
+      badge-json: readiness-badge.json
+```
+
+Public demo repository:
+[`YUUDAI-s/maintainer-readiness-kit-action-demo`](https://github.com/YUUDAI-s/maintainer-readiness-kit-action-demo)
+uses `YUUDAI-s/maintainer-readiness-kit@v0.6.0` in CI.
+
+After the package is published to PyPI:
+
+```powershell
+python -m pip install maintainer-readiness-kit
+maintainer-readiness inspect . --output readiness-report.md
+```
+
+For local source development without installation:
+
+```powershell
+$env:PYTHONPATH = "src"
+python -m maintainer_readiness inspect . --output readiness-report.md
+python -m maintainer_readiness inspect . --fail-under 90
+```
+
+Typical output:
+
+```text
+Score: 100 / 100 (100.0%)
+Level: ready
+Ecosystem Recommendations: Python
+High-Risk File Warnings: No high-risk credential filenames found.
+```
+
+To include public GitHub signals:
+
+```powershell
+python -m maintainer_readiness inspect . --repo YUUDAI-s/maintainer-readiness-kit --output readiness-report.md
+```
+
+To add starter maintainer files to another repository:
+
+```powershell
+python -m maintainer_readiness init C:\path\to\repo
+```
+
+Use `--force` only when you intentionally want to overwrite an existing starter
+file.
+
+## Commands
+
+### `inspect`
+
+```powershell
+python -m maintainer_readiness inspect . --output readiness-report.md
+python -m maintainer_readiness inspect . --json
+python -m maintainer_readiness inspect . --repo owner/name
+python -m maintainer_readiness inspect . --root-label public-sample
+python -m maintainer_readiness inspect . --repo owner/name --stale-days 14
+python -m maintainer_readiness inspect . --sarif readiness.sarif
+python -m maintainer_readiness inspect . --badge-json readiness-badge.json
+```
+
+The Markdown report includes:
+
+- overall readiness score,
+- readiness level,
+- passing and missing signals,
+- local git maintenance evidence,
+- optional public GitHub evidence,
+- stale open issue and pull request counts when `--repo` is used,
+- high-risk file warnings,
+- ecosystem-specific recommendations,
+- next actions before public release.
+
+For CI, use `--fail-under` to make the command return a non-zero exit code when
+the readiness percentage is below your chosen threshold.
+
+Use `--stale-days` with `--repo` when your project has a shorter or longer
+triage window than the default 30 days.
+
+Use `--sarif readiness.sarif` when you want failed checks and high-risk file
+warnings in a code-scanning compatible format.
+
+Use `--badge-json readiness-badge.json` when you want a Shields-compatible
+endpoint JSON payload for a dashboard or docs site.
+
+### GitHub Actions
+
+```yaml
+name: Maintainer readiness
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  smoke:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: YUUDAI-s/maintainer-readiness-kit@v0.6.0
+        with:
+          repo: owner/name
+          fail-under: "80"
+          output: readiness-report.md
+          sarif: readiness.sarif
+          badge-json: readiness-badge.json
+      - uses: github/codeql-action/upload-sarif@v3
+        if: always()
+        with:
+          sarif_file: readiness.sarif
+```
+
+### `init`
+
+```powershell
+python -m maintainer_readiness init .
+```
+
+This writes starter maintainer files only when they do not already exist:
+
+- `CONTRIBUTING.md`
+- `SECURITY.md`
+- `MAINTAINERS.md`
+- `.github/ISSUE_TEMPLATE/bug_report.yml`
+- `.github/ISSUE_TEMPLATE/feature_request.yml`
+- `.github/PULL_REQUEST_TEMPLATE.md`
+- `.github/workflows/maintainer-readiness.yml`
+
+## Design Principles
+
+- Honest evidence over vanity metrics.
+- Minimal runtime dependencies.
+- Useful defaults for maintainers who work alone.
+- No external writes from `inspect`.
+- No claims that a repository qualifies for any external program.
+
+## Maintainer Workflows
+
+This project is built for routine maintainer tasks:
+
+- pre-publication checks before making a repository public,
+- contributor onboarding checks before accepting outside PRs,
+- release-readiness checks before tagging a version,
+- safety checks before attaching reports to sponsorship or maintainer-support
+  applications,
+- CI-friendly JSON output for repeatable repository hygiene reviews.
+
+## Limitations
+
+This tool cannot prove that a repository is widely adopted, safe, or eligible
+for any benefit. It only turns common maintainer signals into a compact,
+verifiable report. Program applications still require accurate information
+about the applicant, repository, role, usage, and maintainer status.
+
+## Development
+
+```powershell
+$env:PYTHONPATH = "src"
+python -m unittest discover -s tests
+python -m maintainer_readiness inspect . --output readiness-report.md
+```
+
+See [ROADMAP.md](ROADMAP.md) for near-term maintainer-focused work.
+See [examples/reports](examples/reports) for generated reports from real
+repositories.
+See the public action demo at
+[YUUDAI-s/maintainer-readiness-kit-action-demo](https://github.com/YUUDAI-s/maintainer-readiness-kit-action-demo).
+See [docs/pypi.md](docs/pypi.md) for package build and publishing notes.
+See [docs/community-launch.md](docs/community-launch.md) for community launch
+copy and posting rules.
+See [examples/github-action.yml](examples/github-action.yml) for a copyable
+GitHub Actions workflow.
+
+## License
+
+MIT

maintainer_readiness_kit-0.6.1/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "maintainer-readiness-kit"
+version = "0.6.1"
+description = "Generate maintainer-readiness reports for open source repositories."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [{ name = "YUUDAI-s" }]
+keywords = ["open-source", "maintainer", "github", "security", "triage"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Quality Assurance",
+  "Topic :: Software Development :: Version Control :: Git",
+]
+dependencies = []
+
+[project.scripts]
+maintainer-readiness = "maintainer_readiness.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/YUUDAI-s/maintainer-readiness-kit"
+Repository = "https://github.com/YUUDAI-s/maintainer-readiness-kit"
+Issues = "https://github.com/YUUDAI-s/maintainer-readiness-kit/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools]
+include-package-data = true

maintainer_readiness_kit-0.6.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

maintainer_readiness_kit-0.6.1/src/maintainer_readiness/__init__.py

@@ -0,0 +1,4 @@
+"""Maintainer readiness reporting for open source repositories."""
+
+__all__ = ["__version__"]
+__version__ = "0.6.1"

maintainer_readiness_kit-0.6.1/src/maintainer_readiness/__main__.py

@@ -0,0 +1,5 @@
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

maintainer_readiness_kit-0.6.1/src/maintainer_readiness/badge.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+
+def render_badge(result: dict) -> dict:
+    percent = float(result.get("percent", 0.0))
+    if percent >= 90:
+        color = "brightgreen"
+    elif percent >= 70:
+        color = "yellow"
+    else:
+        color = "red"
+    return {
+        "schemaVersion": 1,
+        "label": "maintainer readiness",
+        "message": f"{percent:.1f}%",
+        "color": color,
+    }