Automated GitHub profile review.
If you want to only use hen as a command line tool, install it using pipx:
pipx install 'git+https://github.com/juniorguru/hen.git'
If you later want to install updates:
pipx upgrade jg.hen
To check a GitHub profile and print JSON with results, run the following:
hen https://github.com/PavlaBerankova
The result can be redirected to a file, which you can further process as you wish.
hen https://github.com/PavlaBerankova > report.json
Installation:
- You'll need poetry installed.
- Clone this repository:
git clone git@github.com:juniorguru/hen.git - Go to the project directory:
cd hen - Install the project:
poetry install
Running locally:
- Set the
GITHUB_API_KEYenvironment variable to your GitHub API token if you want higher GitHub API rate limits. Using direnv might help setting environment variables automatically in your shell when you navigate to the project directory. - Run
poetry run hen --helpto start the program.
Useful commands:
- To test, run
pytest. - To format code, run
ruff format. - To organize imports and fix other issues, run
ruff check --fix.
Why Hen? Because hens are mothers, they lovingly raise chicks. This tool lovingly raises well-prepared juniors.
Copyright (c) 2024 Jan Javorek, and contributors. Unlike other junior.guru projects, this project uses AGPL-3.0.