Cross-platform CLI tool to generate your Github profile's stats and summary.
Hop on to examples for other usecases.
- Github PAT
- Installation Hiccups on Windows
- How to contribute?
- Privacy Notice
The stable version of this package is maintained on pypi, install using pip:
pip install ghs
Using source code
This can be useful when you want to do a code contribution to this project. You can test and verify your local changes before submitting a Pull Request.
- Clone the repository
git clone https://github.com/interviewstreet/ghs.git
- Navigate to the project root and create a virtual environment
python -m venv venv
- Activate the virtual environment
- For macOS and linux, run
- For windows, run
- For macOS and linux, run
- Install the cli by running the following command while you are in the project root
pip install .
Note: You need to reinstall by running the pip command if you want the cli to pick up your code changes.
docker build -t ghs:latest . docker run -it ghs ghs --help
Generate a Github personal access token (https://github.com/settings/tokens) and use the
ghs -t command to save it in the config file. This will be used to make the API requests to Github. A happy side-effect of this is that your private contributions are also considered while generating the stats and the summary of your username.
Please make sure that you give the following scopes to the token:
PS: Your Github PAT is not compromised by ghs. Please read the Privacy Notice to know more.
||Print the cli version|
||Prompts the user for github PAT and saves it in the config file|
||Print the general stats for the provided username|
||Print the summary of the user. The username should be provided using the
||Copy the output to clipboard. Can be used with
||Show the help message of the cli|
ghs -u <username>
Prints the general Github stats for the given username.
copy to clipboard
-c flag to copy the output to your clipboard.
Other options for summary
In addition to getting the Github summary from the beginning, you can also get the summary of the last 12 months or you can provide your own custom duration.
Installation hiccups on windows
Could not install package due to Environment Error
It can be solved by scoping the installation. Add the flag
--user to the pip command (
pip install --user ghs).
Alternatively, you can install the tool inside a virtual environment
ghs command not found even after installing
Most likely the place where the command is installed is not in the system PATH. On windows, there are a few places where the packages might be installed. After confirming the location, add that directory to the PATH.
How to contribute?
Please see Contributing guidelines for more information.
You can checkout Releases for the changelog.
ghs does not collect any data.
- It has no home server. The Github PAT is stored locally in your machine.
- It doesn't embed any kind of analytic hooks in its code.
The only time ghs connects to a remote server is when you want to generate the stats and summary of your github profile. The cli uses the Github GraphQL and Github Rest APIs to do so. The data collected via the APIs is not sent anywhere. It's displayed in your terminal or copied to your clipboard (only if you explicitly tell the tool to do so by providing the
MIT © HackerRank