Python
Handy Python tooling.
Renamed from makefiles/python-venv.mk
Getting started
Ensure a Python 3 interpreter is available in your path (we recommend installing pyenv).
The Makester Python subsystem aims to be a light-weight, pure-Python implementation of your
project's Python project environment management with basic tooling. Unlike
Conda and Poetry,
or the like, no additional software installs or new learnings are required. But again, that is not
the real problem Makester is trying to solve and does not care if you insist on using a third-party tool for your
Python packaging and dependency management. Simply abstract those commands behind a make target.
This allows you to swap out and/or implement a hybrid Python packaging and dependency management
system, if that is what you really want to do.
Command reference
Create a Simple Python Project Directory Layout
Quick start Python project based on Packaging Python Projects.
Note
Defaults to src-layout.
For example, given MAKESTER__PROJECT_DIR=/var/tmp/fruit:
Makester will produce the following directory layout:
/var/tmp/fruit
├── LICENSE.md
├── pyproject.toml
├── src
│ └── banana
│ └── __init__.py
└── tests
└── banana
Create a Pylint configuration
Create a Python distribution package
Create a versioned archive file that contains your Python packages:
See Packaging Python Projects for more information.Display your local environment's Python setup
### System python3: <$HOME>/.pyenv/shims/python3
### System python3 version: Python 3.10.8
### ---
### Virtual env tooling: <$HOME>/.pyenv/shims/python3 -m venv
### Virtual env Python: <$HOME>/dev/makester/venv/bin/python
### Virtual env pip: <$HOME>/dev/makester/venv/bin/pip
Build virtual environment venv
Note
Makester virtual environment creation will also automatically update pip
and setuptools versions to the latest whilst also installing the wheel package.
Delete virtual environment venv
Install Python package dependencies from requirements.txt
pip editable install with package dependencies taken from requirements.txt:
Install Python package dependencies from setup.py
pip editable install with package dependencies taken from setup.py:
Install Python package dependencies from pyproject.toml
As per PEP 660, editable installs are now supported from pyproject.toml:
Note
pip editable installs via pyproject.toml are supported in conjuction
with setuptools v64.0.0
as the backend and pip v21.3 as the frontend.
Both setuptools and pip are automatically updated as part of make py-venv-create.
Build Python package from setup.py
Write wheel package to --wheel-dir (defaults to ~/wheelhouse):
Invoke the Python virtual environment REPL
Show Python package dependencies
Leverage the awesome pipdeptree tool.
Format your Python modules
Use black for code formatting.
### Formatting Python files under "<$MAKESTER__PROJECT_DIR>/src"
All done! ✨ 🍰 ✨
4 files left unchanged.
To target Python modules under MAKESTER__PYTHONPATH:
Similarly for test modules, to target Python modules under MAKESTER__TESTS_PYTHONPATH:
To target a subset of your project, or even individual files with the py-fmt
target:
Without providing a FMT_PATH, the command will error:
### "FMT_PATH" undefined
###
makefiles/py.mk:79: *** ###. Stop.
The following example demonstrates how to set FMT_PATH for a single Python module:
### Formatting Python files under "src/makester/templater.py"
All done! ✨ 🍰 ✨
1 file left unchanged.
Directory paths to Python modules are also supported:
### Formatting Python files under "src/makester"
All done! ✨ 🍰 ✨
4 files left unchanged.
Lint your Python modules
Use pylint for code linting.
### Linting Python files under "<$MAKESTER__PROJECT_DIR>/src"
--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)
To target Python modules under MAKESTER__PYTHONPATH:
Similarly for test modules, to target Python modules under MAKESTER__TESTS_PYTHONPATH:
To target a subset of your project, or even individual files with the py-lint
target:
Without providing a LINT_PATH, the command will error:
### "LINT_PATH" undefined
###
makefiles/py.mk:88: *** ###. Stop.
The following example demonstrates how to set LINT_PATH for a single Python module:
### Linting Python files under "src/makester/templater.py"
--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)
Directory paths to Python modules are also supported:
### Linting Python files under "src/makester"
--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)
Type annotating your Python modules
Use mypy for code type annotation.
Note
Makester defaults to a more strict interpretation of type annotation checks with the
--disallow-untyped-defs switch. This can be overridden with MAKESTER__MYPY_OPTIONS.
### Type annotating Python files under "/Users/lomarkovski/dev/makester/src"
Success: no issues found in 4 source files
To target Python modules under MAKESTER__PYTHONPATH:
Similarly for test modules, to target Python modules under MAKESTER__TESTS_PYTHONPATH:
To target a subset of your project, or even individual files with the py-type target:
Without providing a TYPE_PATH, the command will error:
### "TYPE_PATH" undefined
###
makefiles/py.mk:117: *** ###. Stop.
The following example demonstrates how to set TYPE_PATH for a single Python module:
### Type annotating Python files under "src/makester/templater.py"
Success: no issues found in 1 source file
Directory paths to Python modules are also supported:
### Type annotating Python files under "src/makester"
Success: no issues found in 4 source files
All-in-one code checker
Special convenience target that runs all code check commands together.
Variables
MAKESTER__SYSTEM_PYTHON3
Path to the current system-wide python executable. In Makester context, this
should only be used to create a Python virtual environment for your project.
Makester will attempt to identify the Python interpreter from your environment path. However,
MAKESTER__SYSTEM_PYTHON3 can also be used to override the system-wide Python.
MAKESTER__PYTHON
Path to the Python virtual environment python executable. You can reference
this anywhere in your Makefile as $(MAKESTER__PYTHON).
MAKESTER__PIP
Path to the Python virtual environment pip executable. You can reference
this anywhere in your Makefile as $(MAKESTER__PIP).
MAKESTER__WHEELHOUSE
Control the location to where Python will build its wheels to. See wheel-dir.
MAKESTER__PYTHON_PROJECT_ROOT
Path to the Python package contents. For example, MAKESTER__PYTHON_PROJECT_ROOT would
be <MAKESTER__PROJECT_DIR>/project/src/my_package if your Python project structure follows this format:
MAKESTER__PYTHONPATH
Makester Python project directory structure follows the src layout. However, this can be
overridden with MAKESTER__PYTHONPATH (default to $MAKESTER__PROJECT_DIR/src)
MAKESTER__PYTHONPATH also acts as the default value for PYTHONPATH in your environment.
MAKESTER__TESTS_PYTHONPATH
Python project src layout's tests directory location compliment (default to $MAKESTER__PROJECT_DIR/tests).
MAKESTER__MYPY_OPTIONS
Control the switch settings to mypy when running type annotation across the code base (default
--disallow-untyped-defs).