Skip to main content

Create an atom feed from git log

Project description

Makefile CI

gitlogfeed

gitlogfeed creates an atom feed from your git log.

Installation

pip install gitlogfeed

When to use?

If your project has plain text documentation (reStrucutedText, markdown or gherkin) you can setup an atom feed with gitlogfeed to notify your users about the changes of your project:

gitlogfeed --repo /path/of/your/git/repo --filter-path docs https://your.site

The title and summary of the feed entry will be created from the commit message. gitlogfeed creates html file from every patch and the content of the feed entry will link to the html file.

The scope of the generated diff can be set with the --diff-context option. You can show the entire file with a big enough limit:

gitlogfeed --diff-context 5000 https://your.site

gitlogfeed can read the git log from stdin:

git log --max-count 20 | gitlogfeed -i --target-dir docs/build https://your.site

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

gitlogfeed-1.1.1.tar.gz (8.4 kB view hashes)

Uploaded Source

Built Distribution

gitlogfeed-1.1.1-py3-none-any.whl (9.0 kB view hashes)

Uploaded Python 3

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