Skip to content

minrk/github-activity

 
 

Repository files navigation

github-activity

Generate simple markdown changelogs for GitHub repositories written in Python.

This package does two things:

  1. Given a GitHub org, repository, an initial git reference or date, use the GitHub GraphQL API to return a DataFrame of all issue and PR activity for this time period.
  2. A CLI to render this activity as markdown, suitable for generating changelogs or community updates.

Note: This is a really young tool so it might change a bit over time.

Installation

The easiest way to install this package is via pip:

pip install github-activity

Usage

The easiest way to use github-activity to generate activity markdown is to use the command-line interface. It takes the following form:

github-activity [<org>/<repo>] --since <date or ref> --until <date or ref>

See the github-activity documentation for more information.

To run the tests

The easiest way to run the test suite is using nox. This will install the local version of the package and run the test suite.

nox -s test

About

Simple markdown changelogs for GitHub repositories

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%