Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 971 Bytes

README.md

File metadata and controls

25 lines (17 loc) · 971 Bytes

Repo stats

Functionality to generate git statistics (e.g. commits, issues, pull requests) of a repository using GitHub's GraphQL API, and citation statistics using the NASA ADS publication database's API.

Produces text files of processed data, and images of summary statistics and plots. The images are designed to be used in a README or documentation.

Written for repositories in The Astropy Project, but readily generalizable by updating the input file parameters.json (see parameter_descriptions.json). Essential parameters to update: repo_owner, repo_name, labels, bibs. Run with

python -m repo_stats.runner -a "<ADS_TOKEN>" -g "<GITHUB_TOKEN>"

where the tokens are for access to the NASA ADS API and the GitHub GraphQL API.

For current output files, see the cache branch.