Metadata-Version: 2.4
Name: release-note-readiness-desk
Version: 0.1.0
Summary: Local CLI and desktop checker for release note readiness gaps
Author: Haider Sattar
License-Expression: MIT
Keywords: release-notes,changelog,product,qa,developer-tools
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Text Processing
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

![Release Note Readiness desktop preview](docs/screenshot.svg)

# Release Note Readiness Desk

Release Note Readiness Desk checks changelog drafts, PR summaries, and release-note copy for gaps that usually cause avoidable release confusion: missing migration steps, unclear customer impact, vague bullets, unresolved placeholders, absent validation evidence, and missing rollback notes.

It runs locally as a CLI or a small Tkinter desktop app. There are no runtime dependencies.

## Install

```bash
python3 -m pip install release-note-readiness-desk
```

## CLI

```bash
release-note-readiness examples/release-draft.md
release-note-readiness examples/release-draft.md --format html --output readiness.html
release-note-readiness CHANGELOG.md --fail-under 80 --fail-on-high
```

Read from stdin:

```bash
cat CHANGELOG.md | release-note-readiness --format json
```

## Desktop App

```bash
release-note-readiness-gui
```

Paste a draft, click **Check**, then copy or save the Markdown report.

## What It Checks

- Breaking or high-risk changes without migration guidance
- Risky changes without customer impact language
- Missing validation or rollout evidence
- Missing rollback, revert, or feature-flag notes
- Draft placeholders such as `TODO` or `TBD`
- Vague entries like "minor updates" or "various fixes"
- Missing standard release-note categories

## Development

```bash
python3 -m unittest discover -s tests
python3 -m build --no-isolation
python3 -m twine check dist/*
```

## License

MIT
