From 4b71b84543be115a45d4f2faedac77483fada36d Mon Sep 17 00:00:00 2001 From: Paul Harrison Date: Tue, 16 May 2023 10:14:52 +0100 Subject: [PATCH] docs: Add project background summary --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index cec2780..531494f 100644 --- a/README.md +++ b/README.md @@ -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`.