diff options
| author | Paul Harrison <paul@harrison.sh> | 2023-05-16 10:14:52 +0100 |
|---|---|---|
| committer | Paul Harrison <paul@harrison.sh> | 2023-05-16 10:22:26 +0100 |
| commit | 4b71b84543be115a45d4f2faedac77483fada36d (patch) | |
| tree | 4e36050671208fc2eb1c832616dab76ea9375121 | |
| parent | 6f3de3a8853243d302132083edefe3f87f60dc07 (diff) | |
docs: Add project background summary
| -rw-r--r-- | README.md | 6 |
1 files changed, 6 insertions, 0 deletions
@@ -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`. |