Python boilerplate

Features

• ruff: linting and code formatting.
• pre-commit: pre-commit hooks.
• pytest: testing.
• logging: logging.
• devcontainer: vscode devcontainer.
• GitHub Actions: GitHub Actions.

Installation

Change python_template folder name to your package name. Meanwhile, replace the python_template in pyproject.toml.

Use in local

(Strong Recommend) Install recommend VSCode extensions

I've listed the recommended vscode extensions in .vscode/extensions.json.

Then, navigate to Extensions in VSCode. Install all extensions in RECOMMENDED tab.

Prepare development environment

Install poetry

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

Use project default poetry

poetry sync

Install pre-commit hooks

poetry run pre-commit install
poetry run pre-commit install --hook-type commit-msg

Use in dev container

Install dev container VSCode extension

Install Dev Containers extension in VSCode.

Open dev container

Click ctrl + shift + p, select Dev Containers: Open Folder in Container.

Wait for the dev container to be built.

(if you want to left dev container running, click ctrl + shift + p, select Dev Containers: Reopen Folder Locally)

Usage

Run

The start command is defined in pyproject.toml. The main.py is the entrypoint.

poetry run start

Test

The pytest command is defined in pyproject.toml. The tests/test_*.py files are the test cases.

poetry run pytest