Skip to main content
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 requires Python to run, 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 an issue.

To get started, check out our tutorial!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

towncrier-26.9.0.tar.gz (79.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

towncrier-26.9.0-py3-none-any.whl (67.0 kB view details)

Uploaded Python 3

File details

Details for the file towncrier-26.9.0.tar.gz.

File metadata

  • Download URL: towncrier-26.9.0.tar.gz
  • Upload date:
  • Size: 79.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for towncrier-26.9.0.tar.gz
Algorithm Hash digest
SHA256 ace9031631c718cc0709107b8755e6e31350eb8acdc877af43df3177addb9a55
MD5 c3e7564be46f40c108ce671e6e930456
BLAKE2b-256 92d4e85ce614bf45b1a7fe13b82cc687819c2eaac5a1dd94b84834322095fd98

See more details on using hashes here.

Provenance

The following attestation bundles were made for towncrier-26.9.0.tar.gz:

Publisher: ci.yml on twisted/towncrier

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file towncrier-26.9.0-py3-none-any.whl.

File metadata

  • Download URL: towncrier-26.9.0-py3-none-any.whl
  • Upload date:
  • Size: 67.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for towncrier-26.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae4d223e6aadaff98d29b7f09e58d9c9ccf4cd3b455a2d2e0486d432cd8bf660
MD5 0d68dcd0af3d1ce8d585b0614c022e22
BLAKE2b-256 8288f9340b545dafa64de053798e760515a2736fbb60092cf9aa6b146ccf3ede

See more details on using hashes here.

Provenance

The following attestation bundles were made for towncrier-26.9.0-py3-none-any.whl:

Publisher: ci.yml on twisted/towncrier

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

26.9.0 This release

2 files

25.8.0

2 files

24.8.0

2 files

24.7.1

2 files

24.7.0

2 files

23.11.0

2 files

23.10.0

2 files

23.6.0

2 files

22.12.0

2 files

22.8.0

2 files

21.9.0

2 files

21.3.0

2 files

21.3.0.dev4

2 files

21.3.0.dev2

2 files

19.9.0

2 files

19.2.0

2 files

18.6.0

2 files

18.5.0

2 files

17.8.0

2 files

17.4.0

2 files

17.1.0

2 files

16.12.0

2 files

16.1.0

2 files

16.0.0

2 files

15.1.0

2 files

15.0.0

1 file

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