Metadata-Version: 2.4
Name: tenzir-changelog
Version: 0.11.0
Summary: Reusable changelog management toolkit for Tenzir repositories.
Project-URL: Homepage, https://github.com/tenzir/changelog
Project-URL: Repository, https://github.com/tenzir/changelog
Project-URL: Bug Tracker, https://github.com/tenzir/changelog/issues
Project-URL: Documentation, https://docs.tenzir.com
Author-email: Tenzir <engineering@tenzir.com>
Maintainer-email: Tenzir Engineering <engineering@tenzir.com>
License: Apache-2.0
License-File: LICENSE
Keywords: automation,changelog,release-notes,tenzir
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business :: News/Diary
Classifier: Topic :: Software Development :: Version Control
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: click>=8.1
Requires-Dist: mdformat>=0.7.17
Requires-Dist: packaging>=24.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.7
Description-Content-Type: text/markdown

# 📝 tenzir-changelog

`tenzir-changelog` is the reusable changelog companion for Tenzir projects. It
helps contributors capture entries, maintain release manifests, and ship tidy
change logs across public and private repositories.

## ✨ Highlights

- 🚀 Bootstrap a changelog project with sensible defaults and YAML
  configuration in seconds.
- 🧾 Capture changelog entries via an interactive assistant that pulls metadata
  from Git and GitHub, pre-filling authors from your `gh` login and current PRs.
- 📦 Assemble release manifests that include narrative introductions before the
  structured list of entries.
- 🔍 Validate entry metadata and release manifests to keep docs tooling happy.

## 📦 Installation

`tenzir-changelog` ships on PyPI. Use
[`uvx`](https://docs.astral.sh/uv/concepts/tools/) to fetch and execute the
latest compatible version on demand (requires Python 3.12+):

```sh
uvx tenzir-changelog --help
```

`uvx` downloads the newest release, runs it in an isolated environment, and
caches the result for snappy subsequent invocations.

## 📚 Documentation

- [User Reference](https://docs.tenzir.com/reference/changelog-framework):
  Concise description of concepts and abstractions.

## 🐶 Dogfooded Project

The repository ships with `changelog/`, the real changelog project maintained
by the Tenzir team. Explore it to see how `config.yaml`, `unreleased/`, and
Markdown release manifests fit together end-to-end.

## 📄 License

`tenzir-changelog` is released under the Apache License, Version 2.0. Consult
[`LICENSE`](LICENSE) for the full text.
