Grab recent issue/PR activity from a GitHub repository and render it as markdown.
Project description
github-activity
Generate simple markdown changelogs for GitHub repositories written in Python.
This package does two things:
- 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.
- 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 to do so directly from GitHub with pip
:
pip install git+https://github.com/choldgraf/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.
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
github_activity-0.1.2.tar.gz
(12.7 kB
view hashes)
Built Distribution
Close
Hashes for github_activity-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39d98c2feba5ccb2a36495093c1c901c723b7bcfb9c9aac02e26ce1c70844f6e |
|
MD5 | 7b2d289697cabdabce72afa1c71721ed |
|
BLAKE2b-256 | c4f5eddaad5ef8eeeb0473671ea902a1c93a3d324360169f1e32a8e1f48923bc |