Skip to content

Latest commit

 

History

History

README.md

GitHub Reporting Tool docs

Create detailed and summary CSV reports of activity by a GitHub user, using the GraphQL API

Made with Python API - GitHub GraphQL

A project to output CSV reports around on repos, users and commits, for interest and for business reporting.

View the source:

MichaelCurrin - github-reporting-py

If you're interested in making your own docs site like this one, follow my DocsifyJS Tutorial.

Sample

This project has a few executable Python scripts which each generate a report.

Run the script by name and supply it with arguments.

Examples:

$ ./repos_and_commit_counts.py owner MichaelCurrin
$ ./repos_and_commit_counts.py owner MichaelCurrin start 2020-04-01

Documentation

See the following guides so you can use this project to generate some reports for yourself on users or repos you are interested in. Note that these only cover the case of a Unix-style environment.

  • Aims - The main purposes for this project and how they could benefit you.
  • Installation - Requirements and how to set up your environment and configs.
  • Usage - Run CLI scripts to generate reports.
  • Datasources - Info and links around APIs.

See also GitHub's resources and samples for running GraphQL queries - platform-samples.