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 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.
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.2.0.tar.gz
(14.0 kB
view hashes)
Built Distribution
Close
Hashes for github_activity-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d2d34fa557ac7d1be578f8d055e68291c5c123050bddcb34a13bc512990e9ad |
|
MD5 | 40923f14a4d6d18cbeaf7637c87418e3 |
|
BLAKE2b-256 | 1500945b9e5bbaff95baa8f41a76878a1326d537d25a4c77764489ad04f02bcf |