In summary, this FastAPI project was a learning and experimentation journey to gain expertise in this framework and potentially develop functional applications or APIs along the way.
To access the full documentation on how to setup and execute this project, refer to the mkdocs page
To set up and run the project, you will need:
- Python 3.8;
- [Optional] Anaconda for environemnt management;
Follow these steps to install and set up the project:
-
Clone the repository:
git clone https://github.com/cicerotcv/megadados
-
Go to megadados directory
cd megadados
-
Set up the Python environment
Windows
- Make sure you have python3.8 installed.
- Run
python -m venv venv
to create the virtual environment; - Activate the virtual environment
. ./venv/Scripts/activate
; - Install the dependencies:
pip install -r requirements.txt
Unix/macOS
- Make sure you have python3.8 or greater installed.
- Run
python3.x -m venv venv
to create the virtual environment; - Activate the virtual environment
source venv/bin/activate
; - Install the dependencies:
pip install -r requirements.txt
Using Anaconda
- With conda, run
conda env create -n megadados python=3.8
to create themegadados
environment; - Activate the virtual environment with
conda activate megadados
- Install the dependencies:
pip install -r requirements.txt
To run the project, execute the following command:
python -m uvicorn src.main:app