- Install Python 3.6 or higher.
- Install pip dependencies with
pip install -r requirements.txt
orpip3 install -r requirements.txt
for Mac/Linux users. - Copy or rename
.env_example
to.env
in the root of the project folder. - Optionally create a GitHub personal access token and store it under
github_token
in your.env
file to run the GitHub example routes. - Run the application with
uvicorn main:app --reload
In addition, for VSCode Users:
- Install the Python extension and Pylance extension.
- Recommended: Install the VS Intellicode extension for better code suggestions/completion.
- VSCode tasks are included in this repo as well: press 'F1' or 'Ctrl + Shift + P' and select 'Run Tasks' to access them.
- You may also run or debug the application using the included debug profile.