CSC/ECE 517 Spring 2024 - G2402 Implement REST client, REST API, and Graphql API endpoint for repositories
GitHub Miner
This is a convenient tool to query a user's GitHub metrics.
- IN ORDER TO USE THIS TOOL, YOU NEED TO PROVIDE YOUR OWN .env FILE.**
Because we use the [dotenv](https://pypi.org/project/python-dotenv/) package to load environment variable.
- YOU ALSO NEED TO PROVIDE YOUR GITHUB PERSONAL ACCESS TOKEN(PAT) IN YOUR .env FILE**
i.e. GITHUB_TOKEN = 'yourGitHubPAT'
- Installation
We recommend using virtual environment.
shell
cd path/to/your/project/directory python -m venv venv
On macOS and Linux:
shell
source venv/bin/activate
On Windows (Command Prompt):
shell
.\venv\Scripts\activate
On Windows (PowerShell):
shell
.\venv\Scripts\Activate.ps1
then you can
shell
pip -r requirements.txt
- On Windows
set PYTHONPATH=%PYTHONPATH%;path/to/your/project
- On Unix or MacOS
export PYTHONPATH=$PYTHONPATH:/path/to/your/project