Python Project Skeleton

A modern project skeleton for Python applications, designed to enforce best practices in testing, code quality, and automation from the very beginning.

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Ensure you have a specific Python version installed. This project's version is managed by a .python-version file. It is recommended to use a Python version manager like uv or pyenv.

Installation

This project uses uv for dependency and virtual environment management.

1. Install uv: Follow the official instructions to install uv on your system.

2. Sync dependencies: Create the virtual environment and install all dependencies from uv.lock.

   uv sync --locked

3. Run commands and scripts: Use uv to run commands and scripts automatically within the virtual environment created in .venv directory at the project root.

   uv run main.py

License

This project is licensed under the GNU General Public License version 3 (GPL-3.0). See the LICENSE file for details. It is crucial to choose a license (e.g., MIT, Apache 2.0, GPL) that defines how others can use, modify, and distribute your code.