diff options
| author | Paul Harrison <paul@harrison.sh> | 2022-11-20 15:13:16 +0000 |
|---|---|---|
| committer | Paul Harrison <paul@harrison.sh> | 2022-12-15 16:02:14 +0000 |
| commit | 9baafc80ed889c232587cf5d4cfaa2db44d1825a (patch) | |
| tree | 13371c1220a8eabbc0932d30cc9475b98b984c3b /README.md | |
| parent | b4ba284dcc20563b9b7dde770b7c9f67c6b25e76 (diff) | |
feat: Hand ranking API
Hand ranking API with a health check root endpoint and rank endpoint.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -88,3 +88,18 @@ Result: "full house: 4 over 2" Query: "6H 7H 8H 9H 10H" Result: "straight flush: 10-high diamonds" ``` + +## Requirements +- Python 3.11 +- [Poetry](https://python-poetry.org/) +- [GNU Make](https://www.gnu.org/software/make/) + +## Usage +- Install with `make install`. +- Run linting and tests with `make quality test coverage clean`. +- Run API with `make API`. +- Check API health with `curl localhost:8000` +- Query API for rank with e.g. + ```shell + curl -X POST -d '2H 3D 5S 10C KD' localhost:8000/rank + ``` |