An open API service indexing awesome lists of open source software.

https://github.com/saiyalamarty/github-stats

Command line tool to get number of PRs reviewed by a user.
https://github.com/saiyalamarty/github-stats

github pull-requests stats

Last synced: 3 months ago
JSON representation

Command line tool to get number of PRs reviewed by a user.

Awesome Lists containing this project

README

          

# Github Stats [![Python Versions](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/) [![GitHub](https://img.shields.io/github/license/saiyalamarty/gitstats.svg)](https://github.com/saiyalamarty/gitstats/blob/develop/LICENSE)

Command line tool to get number of PRs reviewed by a user.

## Usage
Use `--help` to see all options.
```
$ gitstats --help
Usage: gitstats [OPTIONS]

This script will print the number of PRs reviewed by the user in the given
timeframe.

Options:
-t, --token TEXT Github token
-u, --username TEXT Github username
-o, --org TEXT Github org
-r, --repos TEXT ',' separated github repos
-s, --start_timestamp TEXT Start time in epoch format
-e, --end_timestamp TEXT End time in epoch format
--help Show this message and exit.
```

The script by default attempts to read the options from the environment variables. Set the following environment variables:

* `GITHUB_TOKEN` - GitHub token
* `GITHUB_USERNAME` - GitHub username
* `GITHUB_ORGANIZATION` - GitHub organization
* `GITHUB_REPOS` - Comma separated list of GitHub repositories

If the environment variables are not set, the script will prompt for the values.

When the script is run, it will print the number of PRs reviewed by the user in the last two weeks.

```
$ gitstats
Repos ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2/2 • 0:00:06 0:00:00

╭───┬───────────┬─────────────────────────────────────────────────────────────────────┬───────╮
│ │ Repo │ PR Title │ PR ID │
├───┼───────────┼─────────────────────────────────────────────────────────────────────┼───────┤
│ 0 │ gitrepo_1 │ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiu │ 101 │
│ 1 │ gitrepo_2 │ Lorem ipsum dolor sit amet, consectetur adipiscing elit, │ 100 │
╰───┴───────────┴─────────────────────────────────────────────────────────────────────┴───────╯

PRs reviewed between 2022-07-04 and 2022-07-18: 2

```