Installation

How to install

Not yet available in PyPI

How to contribute

This project uses uv to manage dependencies and environments.

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

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