CSC/ECE 517 Spring 2024 - G2402 Implement REST client, REST API, and Graphql API endpoint for repositories: Difference between revisions
Jump to navigation
Jump to search
(Replaced content with "__TOC__ == 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/...") Tag: Replaced |
No edit summary |
||
| Line 11: | Line 11: | ||
## Installation | ## Installation | ||
We recommend using virtual environment. | We recommend using virtual environment. Steps to setup virtual environment: | ||
shell | shell | ||
| Line 39: | Line 39: | ||
pip -r requirements.txt | pip -r requirements.txt | ||
Next, set the PYTHONPATH to | |||
On Windows | |||
set PYTHONPATH=%PYTHONPATH%;path/to/your/project | set PYTHONPATH=%PYTHONPATH%;path/to/your/project | ||
set PYTHONPATH=%PYTHONPATH%;path/to/your/project/backend | |||
On Unix or MacOS | |||
export PYTHONPATH=$PYTHONPATH:/path/to/your/project | export PYTHONPATH=$PYTHONPATH:/path/to/your/project | ||
export PYTHONPATH=%PYTHONPATH%;path/to/your/project/backend | |||
Revision as of 03:54, 25 March 2024
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. Steps to setup 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
Next, set the PYTHONPATH to
On Windows
set PYTHONPATH=%PYTHONPATH%;path/to/your/project set PYTHONPATH=%PYTHONPATH%;path/to/your/project/backend
On Unix or MacOS
export PYTHONPATH=$PYTHONPATH:/path/to/your/project export PYTHONPATH=%PYTHONPATH%;path/to/your/project/backend