🌺 What ris?

What ris is an Iris identification service.

Getting started

Requires

• Python 3.8+ - https://www.python.org/
• Poetry - https://python-poetry.org/

Running

To begin: clone this repository, install the dependencies using Poetry, and run the application using uvicorn.

git clone git@github.com:alxwrd/what-ris.git
cd what-ris
poetry install
poetry run uvicorn ris.api:app --reload

The test suite is written using pytest. To verify you're ready to go, run the tests:

$ poetry run pytest
======== test session starts ========
collected 55 items

tests\test_maths.py ........
tests\test_predict.py ..............................................

Documentation

Endpoints are self documenting thanks to FastAPI. After you've started the application locally, simply visit http://localhost:8000/docs.

Deployment

Deployed to Google Cloud Platform using:

• Container Registry
• Cloud Run