From a66bd0c4794a5b5078d1d3da11ec4f8b90479f99 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Wed, 24 May 2023 11:26:52 -0700 Subject: [PATCH 1/3] Fix: small edits to the readme file --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 416c349..8893928 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # devstats -This repository holds the devstats package. devstats uses the github API to -generate developer statistics and a developer statistics report on a specified +This repository holds the devstats package. devstats is a command line tool that uses the GitHub GraphQL API to +generate developer statistics and a developer statistics report for a specified project. ## OAuth key for accessing GitHub @@ -12,8 +12,11 @@ you need a personal access token with `public_repo` permission to access the Gra This code expects the personal access token to be in the environment variable `GRAPH_API_KEY`. -You can [create a personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) on GitHub and save it somewhere you trust. -Then, when you want to use the code: `export GRAPH_API_KEY=` +You can [create a personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) on GitHub. Save the token in a trusted location. + +Finally, add the token to your environment using: + +`export GRAPH_API_KEY=` ## Query script @@ -27,8 +30,13 @@ First you need to install the required Python packages: pip install -r requirements.txt ``` -For example, to download the latest data for `pandas`: +To download the latest data for `pandas` use the following command: ```bash -python query.py pandas-dev pandas +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. From 274cf928f17a9f6768bcc4726607e7fe265f0b92 Mon Sep 17 00:00:00 2001 From: Jarrod Millman Date: Wed, 24 May 2023 11:46:01 -0700 Subject: [PATCH 2/3] Run autolinter --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8893928..b098dfd 100644 --- a/README.md +++ b/README.md @@ -38,5 +38,5 @@ 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_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. From 8941c769fc8082d42de083b4da6ecc1c1bfb6755 Mon Sep 17 00:00:00 2001 From: Jarrod Millman Date: Wed, 24 May 2023 16:43:32 -0700 Subject: [PATCH 3/3] Support Python 3.8 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index ce24fe1..42ff93d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ requires = ["setuptools", "wheel"] [project] name = "devstats" version = "0.1rc1" -requires-python = ">=3.10" +requires-python = ">=3.8" description = "Developer tool for scientific Python libraries" license = {file = "LICENSE"} maintainers = [