Skip to main content

Sam's Generate Changelog

PyPI GitHub Workflow Status Requires.io PyPI - Downloads GitHub

Yet another changelog generator!

Sam’s Generate Changelog focusses on making it easy to group information about your commits by author_date, author, file_path, friendly_change_type, and more importantly, custom attributes!

This makes it easy to generate a changelog that’s as simple as a list of all commits/files that changed, or as complicated as a list of Python files changed grouped by module and then grouped by author with their last changed date.

Documentation

For full documentation go to ReadTheDocs.

Installation

pip install samsgeneratechangelog

Usage

Command

$ sgc save --start-ref HEAD~3 --end-ref HEAD --var header_text 0.0.1 --output-file CHANGELOG.md --entry-id 0.0.1

Outputs to CHANGELOG.md


[//]: # (SamsGenerateChangelog-0.0.1)
 # 0.0.1

 ## Sam Martin's Files


 ### Added

 - tests/fixtures/custom_template.j2 - 2020-09-02 11:26:13
 - tests/test_cmdline_arguments.py - 2020-09-02 11:26:13

 ### Modified

 - samsgeneratechangelog/__init__.py - 2020-09-02 11:26:13
 - samsgeneratechangelog/__main__.py - 2020-09-02 11:26:13
 - samsgeneratechangelog/config.py - 2020-09-02 11:26:13
 - samsgeneratechangelog/generatechangelog.py - 2020-09-02 11:26:13
 - tests/test_default_templates.py - 2020-09-02 11:26:13
 [//]: # (SamsGenerateChangelog-0.0.1)

Metadata

Release files for samsgeneratechangelog 1.2.0

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

Source distribution (sdist)

Source distribution for samsgeneratechangelog 1.2.0
File Size Uploaded Provenance
samsgeneratechangelog-1.2.0.tar.gz 9.4 kB Without provenance Details

Release files / samsgeneratechangelog-1.2.0.tar.gz

Download URL samsgeneratechangelog-1.2.0.tar.gz
Size 9.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a15a73d868738e3030be95416041ec5631a48d94ac188310c5ca2165b983ca75
BLAKE2b-256 checksum
How to use checksums
aa0339584666231747045256c8ca01b44722a909203e496f2da9dbb264c57f51
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.0

Security for samsgeneratechangelog 1.2.0

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.

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