# review-tally
This tool is intended to retrieve a basic review count for the pull
requests for a GitHub organization in a given time frame. The default time
from is 2 weeks. The tool will retrieve statistics only on all repositories in
the specified organization unless there are specific languages specified.
This tool uses the GitHub API to retrieve the data. The tool requires that
you have your GitHub token set as an environment variable. The environment
variable should be named `GITHUB_TOKEN`.
basic usage:
```bash
review-tally -o expressjs -l javascript
```
which would produce the following output
```shell
user total
--------------------- --
user1 26
user2 18
user3 15
```
This output shows the number of reviews that each user has carried out in the
time period for the repositories that have python as a language specified.
A comma separated list of languages can be provided to filter the repositories
that are included in the statistics. If no languages are provided then all of
the repositories will be included in the statistics.
multiple languages:
```bash
review-tally -o crossplane -l python,go
```
All languages:
```bash
review-tally -o expressjs
```
Specifying the time frame:
```bash
review-tally -o expressjs -l javascript -s 2021-01-01 -e 2021-01-31
```
Customizing metrics displayed:
```bash
review-tally -o expressjs -l javascript -m reviews,engagement,thoroughness
```
## Sprint Analysis
If aggregate data is required sprint over sprint then the `--sprint-analysis`
option can be used. This will produce a CSV file with the data for each sprint.
```shell
review-tally -o expressjs -l javascript --sprint-analysis --output-path sprint_analysis.csv
```
## Options
* -o, --organization The Github organization that you want to query
* -l, --languages A comma separated list of languages that you want to include
* -s, --start-date The start date for the time frame that you want to query (optional)
* -e, --end-date The end date for the time frame that you want to query (optional)
* -m, --metrics Comma-separated list of metrics to display (reviews,comments,avg-comments,engagement,thoroughness). Default: reviews,comments,avg-comments
* -h, --help Show this message and exit
* -v, --version Show the version of the tool
* --sprint-analysis selects the sprint analysis option
* --output-path specifices the output file for sprint analysis
Raw data
{
"_id": null,
"home_page": "https://github.com/ghinks/review-tally",
"name": "review-tally",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "ghinks",
"author_email": "ghinks@yahoo.com",
"download_url": "https://files.pythonhosted.org/packages/9a/9f/92e8ff5b7f5e6030e8519c3c02c575f2fd4e0cdc1b19fbaa611418a0f0ff/review_tally-0.3.3.tar.gz",
"platform": null,
"description": "# review-tally\n\nThis tool is intended to retrieve a basic review count for the pull\nrequests for a GitHub organization in a given time frame. The default time\nfrom is 2 weeks. The tool will retrieve statistics only on all repositories in\nthe specified organization unless there are specific languages specified.\n\nThis tool uses the GitHub API to retrieve the data. The tool requires that \nyou have your GitHub token set as an environment variable. The environment\nvariable should be named `GITHUB_TOKEN`.\n\nbasic usage:\n```bash\nreview-tally -o expressjs -l javascript\n```\n \nwhich would produce the following output\n\n```shell\nuser total\n--------------------- --\nuser1 26\nuser2 18\nuser3 15\n```\nThis output shows the number of reviews that each user has carried out in the\ntime period for the repositories that have python as a language specified.\n\nA comma separated list of languages can be provided to filter the repositories\nthat are included in the statistics. If no languages are provided then all of\nthe repositories will be included in the statistics.\n\nmultiple languages:\n```bash\nreview-tally -o crossplane -l python,go\n```\n\nAll languages:\n```bash\nreview-tally -o expressjs\n```\n\nSpecifying the time frame:\n```bash\nreview-tally -o expressjs -l javascript -s 2021-01-01 -e 2021-01-31\n```\n\nCustomizing metrics displayed:\n```bash\nreview-tally -o expressjs -l javascript -m reviews,engagement,thoroughness\n```\n\n## Sprint Analysis\nIf aggregate data is required sprint over sprint then the `--sprint-analysis` \noption can be used. This will produce a CSV file with the data for each sprint.\n\n```shell\nreview-tally -o expressjs -l javascript --sprint-analysis --output-path sprint_analysis.csv\n```\n\n\n## Options \n\n* -o, --organization The Github organization that you want to query\n* -l, --languages A comma separated list of languages that you want to include\n* -s, --start-date The start date for the time frame that you want to query (optional)\n* -e, --end-date The end date for the time frame that you want to query (optional)\n* -m, --metrics Comma-separated list of metrics to display (reviews,comments,avg-comments,engagement,thoroughness). Default: reviews,comments,avg-comments\n* -h, --help Show this message and exit\n* -v, --version Show the version of the tool\n* --sprint-analysis selects the sprint analysis option\n* --output-path specifices the output file for sprint analysis",
"bugtrack_url": null,
"license": "Apache",
"summary": "A tool to discover who is reviewing your organization's PRs",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/ghinks/review-tally",
"Repository": "https://github.com/ghinks/review-tally"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57a2ee456bcb70fb762511e1e03c5682b9aacbec57baf64f07f00d919b884497",
"md5": "fb4fe2ce50aa1b8fecbee21d0458c031",
"sha256": "f3d5f339c585ac6ecfb51eb86c0d54e4dd6da88b511d5914f5816e42fd605008"
},
"downloads": -1,
"filename": "review_tally-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb4fe2ce50aa1b8fecbee21d0458c031",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 23189,
"upload_time": "2025-08-19T20:28:54",
"upload_time_iso_8601": "2025-08-19T20:28:54.946729Z",
"url": "https://files.pythonhosted.org/packages/57/a2/ee456bcb70fb762511e1e03c5682b9aacbec57baf64f07f00d919b884497/review_tally-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a9f92e8ff5b7f5e6030e8519c3c02c575f2fd4e0cdc1b19fbaa611418a0f0ff",
"md5": "82a2a7aed4b4bea4d69460192b7f7105",
"sha256": "018174e0089a16f8acd35b739c79d52f7186f3a53248597f77fff349cd9e6430"
},
"downloads": -1,
"filename": "review_tally-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "82a2a7aed4b4bea4d69460192b7f7105",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 18008,
"upload_time": "2025-08-19T20:28:55",
"upload_time_iso_8601": "2025-08-19T20:28:55.747397Z",
"url": "https://files.pythonhosted.org/packages/9a/9f/92e8ff5b7f5e6030e8519c3c02c575f2fd4e0cdc1b19fbaa611418a0f0ff/review_tally-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-19 20:28:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ghinks",
"github_project": "review-tally",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "review-tally"
}
JSON
