https://github.com/michaelcurrin/aggre-git

Report on aggregated GitHub activity data, based around PRs and users within your organization
https://github.com/michaelcurrin/aggre-git

git github-api github-api-v3 pygithub python python3 reporting reporting-tool

Last synced: 10 months ago
JSON representation

Report on aggregated GitHub activity data, based around PRs and users within your organization

• Host: GitHub
• URL: https://github.com/michaelcurrin/aggre-git
• Owner: MichaelCurrin
• License: mit
• Created: 2018-09-04T19:16:24.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-01-08T09:22:53.000Z (almost 4 years ago)
• Last Synced: 2025-01-14T20:53:47.899Z (12 months ago)
• Topics: git, github-api, github-api-v3, pygithub, python, python3, reporting, reporting-tool
• Language: Python
• Homepage:
• Size: 188 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Aggre-Git

> Report on aggregated GitHub activity data, based around PRs and users within your organization

[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/aggre-git)](https://github.com/MichaelCurrin/aggre-git/tags/)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](#license)

## Features

- Report on historical GitHub activity for your user or organization.

- Read from the GitHub REST API, accessed through a Python library called _PyGithub_ - see the [homepage](https://pygithub.readthedocs.io/en/latest/introduction.html) and [GitHub repo](https://github.com/PyGithub/PyGithub).

## Purpose

This project reports on data from the GitHub API. It creates PR report and a commit report CSV using input parameters.

The project uses the V3 REST API, which works fine for light reporting. But performs poorly at scale - for a commit report on a given branch, it takes 5000 requests to fetch 5000 commits. That is slow to run and also means you are likely to exceed the API rate limit of 5000 requests per hour.

Therefore if you want to do reporting at scale, use this other project instead. It makes use of the GitHub V4 GraphQL API so scales well.

- [Github GraphQL Tool](https://github.com/MichaelCurrin/github-graphql-tool)

## Documentation



[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](/docs/ "Go to docs")



## Contributing

If you want to make the project better, see the [contribution guidelines](/CONTRIBUTING.md).

## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).