python-coffee-machine

An exercise highly focused on clean Python code, design patterns and proper git handling

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

The project is fully based on Python 3.7

Following library dependencies for the python code can be found in requirements.txt.

pytest
click

You can install these with pip install -r requirements.txt.

Setting up the development environment

1. Clone the project with git clone
2. Install the prerequisites as in the previous section
3. Enjoy the properly configured development environment

Running the simulator

Standard way

1. Go to a directory one level above the project root directory
2. Run python python_coffee_machine
3. Enjoy the interaction with the coffee machine

Alternative way

1. Go to the project root directory
2. Run python __main__.py
3. Enjoy the interaction with the coffee machine

Running the tests

1. Go to the project root directory
2. Run pytest in your console or terminal
3. Enjoy the green bar indicating all tests passed

License

This project is licensed under the MIT License - see the LICENSE.md file for details