https://github.com/alxwrd/what-ris
Iris flower identification service
https://github.com/alxwrd/what-ris
Last synced: 3 months ago
JSON representation
Iris flower identification service
- Host: GitHub
- URL: https://github.com/alxwrd/what-ris
- Owner: alxwrd
- Created: 2021-11-29T22:26:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-01T15:48:44.000Z (over 3 years ago)
- Last Synced: 2024-12-29T17:34:29.258Z (5 months ago)
- Language: Python
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# :hibiscus: 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.
```shell
git clone [email protected]:alxwrd/what-ris.git
cd what-ris
poetry install
poetry run uvicorn ris.api:app --reload
```
The test suite is written using [pytest](https://docs.pytest.org/en/6.2.x/). To
verify you're ready to go, run the tests:
```shell
$ 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](https://cloud.google.com/container-registry)
- [Cloud Run](https://cloud.google.com/run)