Python Template

Project Structure

• It uses project.toml instead of setup.py and setup.cfg. The reasoning is following:
• As official setuptools guide says, " configuring new projects via setup.py is discouraged"
• One of the biggest problems with setuptools is that the use of an executable file (i.e. the setup.py) cannot be executed without knowing its dependencies. And there is really no way to know what these dependencies are unless you actually execute the file that contains the information related to package dependencies.
• The pyproject.toml file is supposed to solve the build-tool dependency chicken and egg problem since pip itself can read pyproject.yoml along with the version of setuptools or wheel the project requires.
• The pyproject.toml file was introduced in PEP-518 (2016) as a way of separating configuration of the build system from a specific, optional library (setuptools) and also enabling setuptools to install itself without already being installed. Subsequently PEP-621 (2020) introduces the idea that the pyproject.toml file be used for wider project configuration and PEP-660 (2021) proposes finally doing away with the need for setup.py for editable installation using pip.
• It uses rye for python dependency operations
• It uses src layout, which is the recommended layout for python projects to avoid common pitfalls.

Install

Default installation

• Install rye - System wide

make -s install-rye

• Install the project dependencies

make -s install

• After running above command, the project installed in editable mode with all development and test dependencies installed.
• Moreover, a dummy entry point called placeholder will be available as a cli command.

Docker

# Development build (800 MB)
docker build --tag python-template --file docker/Dockerfile --target development .

# Production build (145 MB)
docker build --tag python-template --file docker/Dockerfile --target production .

• To run command inside the container:

docker run -it python-template:latest bash

# Temporary container
docker run --rm -it python-template:latest bash

IDE Setings

Pycharm

• Line-length: Editor -> Code Style -> Hard wrap at 88

Inspections

Settings -> Editor -> Inspections -> Python

Enable all except:

• Accessing a protected member of a class or a module
• Assignment can be replaced with augmented assignments
• Classic style class usage
• Incorrect BDD Behave-specific definitions
• No encoding specified for file
• The function argument is equal to the default parameter
• Type checker compatible with Pydantic
• For "PEP 8 coding style violation": Ignore = E266, E501
• For "PEP 8 naming convetion violation": Ignore = N803

Plugins

• Ruff
• Pydantic

Vscode

• All recommended settings and extensions can be found in .vscode directory.

Useful Makefile commands

# All available commands
makefile
makefile help

# Run all tests
make -s test

# Run specific tests
make -s test-one TEST_MARKER=<TEST_MARKER>

# Remove unnecessary files such as build,test, cache
make -s clean

# Run all pre-commit hooks
make -s pre-commit

# Lint the project
make -s lint

# Profile a file
make -s profile PROFILE_FILE_PATH=<PATH_TO_FILE>