StormPiper

Get Started

1. clone the repo

   git clone git@github.com:Geosyntec/StormPiper.git

2. build & activate an environment

   conda create -n stormpiper python=3.11
   conda activate stormpiper

3. install dependencies

   cd StormPiper
   pip install -r stormpiper/requirements.txt
   pip install -r stormpiper/requirements_test.txt

Try it out

Run the development server From the StormPiper/stormpiper directory:

uvicorn stormpiper.main:app --reload --port 8000

Navigate to localhost:8000/docs in your browser

Making Changes and Maintaining

Run the tests

pytest

Check test coverage

coverage run --branch -m pytest
coverage report -m

Check formatting and type declarations

from StormPiper directory

bash scripts/lint.sh

get started with docker

Build the container

This command runs make clean, then make stack, then make build

make develop

Run the container

if a startup command is set for the container, this will run it.

make up

The development server runs on your localhost:8080

if you want to silence the logs you can bring things up in daemon mode with:

make up-d

Stop the container

make down