https://github.com/adjust/github_prospector
https://github.com/adjust/github_prospector
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/adjust/github_prospector
- Owner: adjust
- Archived: true
- Created: 2021-08-03T11:04:08.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-24T07:46:08.000Z (almost 5 years ago)
- Last Synced: 2025-03-09T14:40:50.915Z (over 1 year ago)
- Language: Python
- Size: 26.4 KB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
GitHub Prospector
==========================
**Description:** CLI analytic tool for GitHub's teams, repositories, users.
**Contacts:** maksim.kuznetsov@akvelon.com, viktor.chaptsev@adjust.com or Development Efficiency Team
## Install
```shell
pip install git+https://github.com/adjust/github_prospector
```
## Get metrics list
```shell
python3 -m github_prospector -l
```
## How to run
```shell
python3 -m github_prospector -q
```
## Usage
```
Usage: __main__.py [options]
Options:
-h, --help show this help message and exit
-t GITHUB_TOKEN, --github_token=GITHUB_TOKEN
github's token for access to repos. Can set by env
variable auditor_token
-o OWNER, --owner=OWNER
the username that repositories belong
-s START_DATE, --start_date=START_DATE
filter metrics by start date
-e END_DATE, --end_date=END_DATE
filter metrics by end date
-q QUERY, --query=QUERY
query contains metric names split by comma
-l, --metrics-list list of all exising metrics
--out-dir=OUTPUT_DIR directory for storing reports.
-f REPORTER_TYPE, --format=REPORTER_TYPE
Type of Reports: ['json', 'print']
--one-file create one-file report
-V, --version prints version
--get-limits prints github's rate limits
--repos=REPOS list of repos for analysis
--teams=TEAMS list of teams for analysis
--users=USERS list of users for analysis
```