paul
/
poker-ranking-service
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add project background summary

This commit is contained in:
Paul Harrison 2023-05-16 10:14:52 +01:00
parent c114366357
commit c240f085ef
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,5 +1,9 @@
# Single Poker Hand Ranking Service
This project started as a take-home interview task for an MLOps Engineer role. It is a very simple calculation I've wildly overengineered into a demonstration of how I go about building APIs.
## Project Scope
This service comprises an API to compute the rank of an individual poker hand. The scope of this project is to:
- Write an algorithm that takes a hand of cards and identifies the ranking of the given hand.
@ -90,11 +94,13 @@ 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`.
- Build the API container with `make build`, then run API with `docker compose up -d`.