This project template serves as a robust foundation for Python projects, promoting best practices and streamlining development workflows. It comes pre-configured with essential tools and features to enhance the development experience.
- uv for efficient dependency management.
- Ruff for comprehensive linting and code formatting.
- Pytest for running tests and ensuring code reliability.
- GitLab CI/CD for continuous integration.
- Pydocstyle for validating docstring styles, also following the Google style.
- Mypy for static type checking.
Key commands for effective project management:
uv sync- Installs all project dependencies.uv add <package>- Adds a new dependency to the project.uv run ruff check- Runs linting.uv run ruff format- Runs formattinguv run mypy .- Runs mypy.uv run pytest tests- Executes tests located in the tests directory.uv run <command>- Runs the specified command within the virtual environment.
The project uses our GitLab CI/CD templates to automate the linting and testing processes. The pipeline is triggered on every merge request and push to the default branch.