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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file gitlogfeed-1.1.1.tar.gz.

File metadata

  • Download URL: gitlogfeed-1.1.1.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.11

File hashes

Hashes for gitlogfeed-1.1.1.tar.gz
Algorithm Hash digest
SHA256 9c1adcb8411a129a5e16d7005a8db94405aa5a4b9a9f00e6760cee914efad6ec
MD5 857cd63eefa5ea1a7a59fbe3b96a2e60
BLAKE2b-256 b750dda5666c11624051119d7cde5eb15d3cf4e043cea9e9fd3463e601669240

See more details on using hashes here.

File details

Details for the file gitlogfeed-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: gitlogfeed-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.11

File hashes

Hashes for gitlogfeed-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 def9bd73649d6ef386678e57e50906d818cfcbd9049a72ad38cf5c591aa28196
MD5 967432f9f3608c61fa8dc0da7c2b7291
BLAKE2b-256 b76993efcbafe13352a52162a50add8322d4187f72813a4bed661cf83e412564

See more details on using hashes here.

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