https://github.com/executablebooks/github-activity

Simple markdown changelogs for GitHub repositories
https://github.com/executablebooks/github-activity

Last synced: 3 months ago
JSON representation

Simple markdown changelogs for GitHub repositories

• Host: GitHub
• URL: https://github.com/executablebooks/github-activity
• Owner: executablebooks
• License: bsd-3-clause
• Created: 2019-09-27T02:03:57.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-01T12:23:23.000Z (4 months ago)
• Last Synced: 2024-07-03T23:43:57.426Z (4 months ago)
• Language: Python
• Homepage: https://github-activity.readthedocs.io/en/latest/
• Size: 182 KB
• Stars: 46
• Watchers: 11
• Forks: 11
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# github-activity

Generate simple markdown changelogs for GitHub repositories written in Python.

[![continuous-integration](https://github.com/executablebooks/github-activity/actions/workflows/tests.yaml/badge.svg)](https://github.com/executablebooks/github-activity/actions/workflows/tests.yaml)

This package provides a CLI to do two things:

**Scrape all GitHub activity over a period of time for a repository**.

Given a GitHub org, repository, an initial git reference or date, use the [GitHub GraphQL API](https://developer.github.com/v4/) to return a Pandas DataFrame of all issue and PR activity for this time period.

**Render this as a markdown changelog**.

Convert this DataFrame to markdown that is suitable for generating changelogs or community updates.

For an example, see the [changelog of this package](<[https://](https://github-activity.readthedocs.io/en/latest/changelog)>).

## Use this tool

Use this tool via the command line like so:

```bash

github-activity [/] --since  --until 

```

See [the User Guide for details on how to install and use this tool](https://github-activity.readthedocs.io/en/latest/use).

## Contribute to this package

See [the Contributing Guide for more details](https://github-activity.readthedocs.io/en/latest/contribute).