ghs
Cross-platform CLI tool to generate your Github profile's stats and summary.
File Explorer
Download Latest Version (.zip)- ci.yml
- __init__.py
- check_config.py
- es_queries.py
- fetchers.py
- ghs.py
- utils.py
- viewer.py
- .flake8
- .gitignore
- CODEOWNERS
- CONTRIBUTING.md
- Dockerfile
- LICENSE
- README.md
- setup.cfg
- setup.py
# Installation Guide
git clone https://github.com/interviewstreet/ghs
Downloads the entire project code from GitHub to your computer.
cd ghs
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommended- Python 3 Python is required to use pip.
pip install ghs
Installs the package published on PyPI directly β no need to clone the source.
pip install .
Installs the package published on PyPI directly β no need to clone the source.
pip install build twine
Installs the package published on PyPI directly β no need to clone the source.
Pulled directly from this repo's README.
3. Docker
Easy- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t ghs:latest .
Builds a runnable image based on the Dockerfile.
docker run -it ghs ghs --help
Runs the built image as an actual container.
Pulled directly from this repo's README.
4. Python
Easypip install ghs
Installs the package published on PyPI directly β no need to clone the source.
python -m venv venv
Runs the Python script (or module).
pip install .
Installs the package published on PyPI directly β no need to clone the source.
pip install build twine
Installs the package published on PyPI directly β no need to clone the source.
python -m build
Runs the Python script (or module).
Pulled directly from this repo's README.