This repository holds the devstats package. devstats is a Python command line tool that uses the GitHub GraphQL API to generate developer statistics and a developer statistics report for a specified project.

Per the GitHub GraphQL API docs, you need a personal access token with public_repo permission to access the GraphQL API.

This code expects the personal access token to be in the environment variable GRAPH_API_KEY.

You can create a personal access token on GitHub. Save the token in a trusted location.

Finally, add the token to your environment using:

export GRAPH_API_KEY=<yourkey>

The query.py script can be used to collect data for other projects like so: devstats query.py <repo_owner> <repo_name> where repo_owner and repo_name are the names of the org and repo on GitHub, respectively.

To download the latest data for pandas use the following command:

devstats query.py pandas-dev pandas

The command will collect information from GitHub and generate two output files in the same directory where you ran it as follows:

packagename_issues.json: this file contains information about issues for the repository of interest. packagename_PRs.json: this file contains information associated with pull requests for the repository of interest.

If you wish to contribute to devstats:

1. Fork and clone the repository
2. Create a new branch with your proposed feature or change to the package repository

We use pre-commit to ensure the code style is consistent. To install pre-commit locally:

1. First install pre-commit: pip install pre-commit
2. Install all of the pre-commit hooks by running pre-commit install

Once you have pre-commit installed, the code stylers and linters defined in the pre-commit-config.yaml will run each time you commit modified changes to git locally.