Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Hear ye, hear ye, says the towncrier

Documentation License: MIT PyPI release

towncrier is a utility to produce useful, summarized news files (also known as changelogs) for your project.

Rather than reading the Git history, or having one single file which developers all write to and produce merge conflicts, towncrier reads “news fragments” which contain information useful to end users.

Used by Twisted, pytest, pip, BuildBot, and attrs, among others.

While the command line tool towncrier works on Python 3.7+ only, as long as you don’t use any Python-specific affordances (like auto-detection of the project version), it is usable with any project type on any platform.

Philosophy

towncrier delivers the news which is convenient to those that hear it, not those that write it.

That is, by duplicating what has changed from the “developer log” (which may contain complex information about the original issue, how it was fixed, who authored the fix, and who reviewed the fix) into a “news fragment” (a small file containing just enough information to be useful to end users), towncrier can produce a digest of the changes which is valuable to those who may wish to use the software. These fragments are also commonly called “topfiles” or “newsfiles”.

towncrier works best in a development system where all merges involve closing a ticket.

To get started, check out our tutorial!

Metadata

Release files for towncrier 23.6.0rc1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for towncrier 23.6.0rc1
File Size Uploaded Provenance Actions
towncrier-23.6.0rc1.tar.gz 48.0 kB Without provenance Details for towncrier-23.6.0rc1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for towncrier 23.6.0rc1
File Interpreter ABI Platform Actions
towncrier-23.6.0rc1-py3-none-any.whl Python 3 none any Details for towncrier-23.6.0rc1-py3-none-any.whl

Total release size: 94.4 kB

Release files / towncrier-23.6.0rc1.tar.gz

Download URL towncrier-23.6.0rc1.tar.gz
Size 48.0 kB
Tags Source
SHA-256 checksum
How to use checksums
ea5d6c7ea2eec0caceeea45948e6f3c1c156104938aea6a28af4431be6d04a8f
BLAKE2b-256 checksum
How to use checksums
1f9bbbeea7530255f00d149608000836c057f3fb5deea5dc4dea7c2dbacb0e0e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.1 CPython/3.11.3

Release files / towncrier-23.6.0rc1-py3-none-any.whl

Download URL towncrier-23.6.0rc1-py3-none-any.whl
Size 46.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3ccd1897dd50e71da61071c0ae0fc8931ef13e30c5be284b1e29b905d9de6ca8
BLAKE2b-256 checksum
How to use checksums
0f37e9b21118886fee0764ef691199f456eb48445c3f4073ef1e0d11191c18af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.1 CPython/3.11.3

Security for towncrier 23.6.0rc1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page