Skip to main content

Building newsfiles for your project.

Project description

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!

Project details


Download files

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

Source Distribution

towncrier-24.7.1rc1.tar.gz (60.7 kB view details)

Uploaded Source

Built Distribution

towncrier-24.7.1rc1-py3-none-any.whl (57.1 kB view details)

Uploaded Python 3

File details

Details for the file towncrier-24.7.1rc1.tar.gz.

File metadata

  • Download URL: towncrier-24.7.1rc1.tar.gz
  • Upload date:
  • Size: 60.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for towncrier-24.7.1rc1.tar.gz
Algorithm Hash digest
SHA256 bfef9adf1530c402538eac6102a1fc3b8639cb47efe0568165dbd59389fa1764
MD5 e5a90fba333a4f1e82178eac00fe0df2
BLAKE2b-256 8c72aa22980f0177bf4ad72f8625ec464cffa032142b401877c0b297d322dc62

See more details on using hashes here.

Provenance

File details

Details for the file towncrier-24.7.1rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for towncrier-24.7.1rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 0a5b4dd699ca89d96fa119b0c11406e3b45a1737f328bbd7d1ab3c51c7f01aeb
MD5 05cbb276c2a4f1ce8a0da85684af1769
BLAKE2b-256 16d59f0b8ab557a718cd3b9ae30013ab1ed0179fdc7f30f73f789441d7d86eed

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page