prism-api

Prism Backend implemented with FastAPI

Setup

1. Create a new conda environment and install python 3.10

conda create -n prism
conda install python=3.10

2. Install poetry

curl -sSL https://install.python-poetry.org | python -

3. Install packages and activate the virtual environment

poetry install
poetry shell

4. Setup pre-commit git hook

pre-commit install

5. Create .env file

Ask teammates for the environment configuration

touch .env

6. Start local Ray instance

ray start --head --port=6379

7. Run the api using the following command

cd app
python -m uvicorn main:app --workers 4

Before committing

Run the following command

pre-commit run --all-files

You can also fix auto-fixable ruff erros by running the following command

ruff check . --fix

Adding new packages

Use the following command

poetry add [PACKAGE_NAME]

Terraform

Setup

1. Install Terraform

brew tap hashicorp/tap
brew install hashicorp/tap/terraform

2. Verify the installation

terraform -help

3. Enable DEBUG logging (if you want to)

export TF_LOG=DEBUG

ETC

Delete pycache

find . | grep -E "(/__pycache__$|\.pyc$|\.pyo$)" | xargs rm -rf

Delete local branches

git branch | grep -v "main" | xargs git branch -D