The Arborist API is currently in alpha development. We're actively working on adding core API functionality. The beta testing phase has not yet commenced, and the Issues
tab for this repository will remain disabled until the app reaches the appropriate level of usability/polish.
- Create, and navigate to, a new directory for this project
python3 -m venv env
: Create a Python virtual environment namedenv
- Set the new virtual environment as the Python interpreter in your IDE
source env/bin/activate
: Activate the virtual environmentpip install -r requirements.txt
: Install the Python dependencies listed inrequirements.txt
pip list
: List the installed Python packagesdeactivate
: Deactivate the virtual environmentsource env/bin/activate
: Reactivate the virtual environment (the freshly installed packages should now be available)uvicorn app.main:app --reload
: Run the FastAPI server
source env/bin/activate
: Activate the virtual environmentuvicorn app.main:app --reload
: Run the FastAPI server
- Follow the steps in the
Running the FastAPI Server
section above http://localhost:8000/docs
: Open the Swagger UI to view endpoint documentationhttp://localhost:8000/redoc
: Open the ReDoc UI to view endpoint documentation
python3 helpers/generate_test_spss.py
: Generate a test .spss file with 10K observations and 10 featurespython3 helpers/generate_test_csv.py
: Generate a test .csv file with 10K observations and 10 features
When deploying to AWS Lambda, we'll use mangum
to wrap our FastAPI application. We'll need to modify the main.py
to include:
from mangum import Mangum
# FastAPI app code here
handler = Mangum(app)