peeler 0.0.1

Add your description here

Peeler

Getting Started

These instructions will get you a copy of the project on your local machine for development and testing purposes.

Clone this repository in an empty directory

git clone https://github.com/Maxioum/peeler.git

Project Management

This project is using uv to manage dependencies and to build the package.

See pyproject.toml files for the list of dependencies.

How to install uv

Virtual Environments

You may create a virtual environnement managed by uv with

uv venv

make sure to activate the environnement

Testing

uv run pytest .

Coding style enforcement

Pre-commit

Pre-commit framework manages and maintains multi-language pre-commit hooks.

To install hooks the first time, run

  uvx pre-commit install

After this step all your future commits will need to satisfy coding style rules.

Ruff

Ruff is a Python linter and code formatter.

To manually run Ruff on your code

uvx ruff check

uvx ruff format

Mypy

Mypy is a static type checker for Python.

These packages uses as much as possible python static typing feature and mypy helps us to check our typing inconsistencies.

To manually run Mypy on your code

uv run mypy .

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting Pull Requests.

Versioning

This project adheres to Semantic Versioning.

Authors

• Maxime Letellier - Initial work