Clean Code in Python (with examples)

Clean Code by Robert C. Martin, is a handbook for software developers that introduces design principles and ideas for clean code.

This repository focuses on the principles introduced in the book, with a focus on Python. It goes hand in hand with the "Clean up your code" workshop, for which you can find the slides here.

Prerequisites

To be able to run the code in this repository, you will need to have the following two prerequisites fulfilled:

1. Python version of at least 3.9

You will need to have Python version of at least 3.9 installed.

Here are a few useful tools that let you manage multiple Python installations on your machine:

pyenv: easy to use, reliable, and integrates well with most package manager tools.
conda or miniconda.
asdf similar to pyenv but more versatile because it can manage other programming languages as well.

2. Poetry installed

You will need to have Poetry of at least version 1.8.0 to be able to install the package dependencies listed in the poetry.lock file.

To install Poetry, check out the installation guide or simply run the following command on your Linux, Mac or Windows machine:

curl -sSL https://install.python-poetry.org | python3 -

Installation

❗ Disclaimer: The installation was tested only on Mac and Linux machines.

Clone the repository:

git clone https://github.com/pythonmonty/clean-code-in-python.git

Navigate into the directory (if not already):
```
cd clean-code-in-python
```
[Optional] Set Poetry to create the virtual environment in-project.
```
poetry config virtualenvs.in-project true
```
Set a Python version for your Poetry environment. The Python version should be 3.9. or higher. If you are using pyenv to manage your Python versions, you can install a specific Python version, set it as the local version of the directory and configure Poetry to use it.
```
pyenv install 3.11.8
pyenv local 3.11.8
poetry env use $(pyenv which python)
```
📝 Note: As an example I picked Python 3.11.8, but if you cannot install that particular version on your machine, you can check which Python 3.11 versions are available by running pyenv install --list | grep 3.11.

Alternatively, you can explicitly tell Poetry which Python version to use by passing the path to the Python executable:
```
poetry env use /full/path/to/python
```
[Optional] To check if your Python executable has been set correctly, you can run:
```
poetry env info
```
Install the package dependencies and activate the environment:
```
poetry install
poetry shell
```

Repository structure

The repository has the following structure: