Skip to content

Update docs #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jarrodmillman wants to merge 3 commits into from
Closed

Update docs #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a66bd0c
Fix: small edits to the readme file
lwasser May 24, 2023
274cf92
Run autolinter
jarrodmillman May 24, 2023
8941c76
Support Python 3.8
jarrodmillman May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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=<yourkey>`
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=<yourkey>`

## Query script

Expand All @@ -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.
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down