Development.md

Development Notes

Getting Started

Create a virtualenv and install the dependencies:

virtualenv env
source env/bin/activate
pip install -r requirements.txt

The service is written using FastAPI and runs inside of Uvicorn. You can start a dev server quickly with the run.py helper script:

./run.py --port 8000

This is equivalent to running Uvicorn directly, like this:

uvicorn x2s3.app:app --host 0.0.0.0 --port 8000 --workers 1 --access-log --reload

You can specify TLS certificates and increase the number of workers in order to scale the service:

uvicorn x2s3.app:app --host 0.0.0.0 --port 8000 --workers 8 --access-log --ssl-keyfile /opt/tls/cert.key --ssl-certfile /opt/tls/cert.crt

For production deployments, please refer to the main README file.

Testing

To run the unit tests and produce a code coverage report:

python -m pytest --cov=x2s3 --cov-report html -W ignore::DeprecationWarning

These tests are automatically run whenever changes are merged to the main branch.

Building the Docker container

Run the Docker build, replacing <version> with your version number:

cd docker/
export VERSION=<version>
docker build . --build-arg GIT_TAG=$VERSION -t ghcr.io/janeliascicomp/x2s3:$VERSION

Pushing the Docker container

docker push ghcr.io/janeliascicomp/x2s3:$VERSION
docker tag ghcr.io/janeliascicomp/x2s3:$VERSION ghcr.io/janeliascicomp/x2s3:latest
docker push ghcr.io/janeliascicomp/x2s3:latest