Installation

How to install

Using uv:

$ uv pip install polyany

To install uv, follow the instructions in the official documentation.

Using pip:

$ pip install polyany

How to contribute

This project uses uv to manage dependencies and environments.

1. Clone the repository

   $ git clone https://github.com/rolmip/polyany.git
   $ cd polyany
   

2. Sync the uv environment

   $ uv sync --all-groups
   

3. Activate the virtual environment

   POSIXWindows cmdWindows PowerShell

   $ source .venv/bin/activate
   

   C:\> .venv\Scripts\activate.bat
   

   PS C:\> .venv\Scripts\Activate.ps1
   

4. Install git hooks

   $ pre-commit install
   

Running tests

To run all tests, just use:

$ uv run pytest

To run all tests with coverage analysis:

$ uv run pytest --cov --cov-branch