OSS Readiness

oss-ready is a small, dependency-free Python CLI that checks whether a local repository has the basic files and signals people expect from a maintainable open-source project.

It is intentionally boring: fast checks, clear output, no telemetry, no network calls, and no scanning outside the path you pass in.

What It Checks

• README presence and minimum substance
• License file presence
• Contributing guide presence
• Security policy presence
• Code of conduct presence
• GitHub Actions CI workflow presence
• Test folder presence
• .gitignore presence
• Package metadata presence for common ecosystems

Installation

From a local checkout:

python -m pip install -e .

Usage

Check the current repository:

oss-ready .

Get JSON output:

oss-ready . --format json

Fail CI when required checks are missing:

oss-ready . --fail-under 80

Example

OSS readiness score: 89/100

PASS  README            README.md has enough content to orient contributors.
PASS  License           LICENSE found.
WARN  Security policy   SECURITY.md is missing.
PASS  Tests             tests/ found.

Project Goals

• Help new maintainers publish projects that are easier to understand, trust, and contribute to.
• Keep checks transparent enough that users can disagree with them.
• Stay local-first and privacy-respecting.

Development

Run the test suite:

python -m unittest discover -s tests

Run the CLI without installing:

python -m oss_readiness .

License

MIT License. See LICENSE.