Development Setup¶

Welcome to the development guide for pysarflow!

1. Install UV¶

We use UV because it simplifies installation and synchronization of dependencies, making development smoother and more efficient.

Install UV by running:

curl -LsSf https://astral.sh/uv/install.sh | sh

Once UV is installed, install the project dependencies directly into your virtual environment (.venv) with:

uv sync

This command reads project's configuration (i.e. pyproject.toml) and ensures that all required libraries are installed with the correct versions.

We use pre-commit hooks to ensure code quality and consistency across the project. Our pre-commit configuration includes:

UV Lock: Ensures locking of dependency versions.
Ruff Hooks (linter and formatter): Ruff is used for linting and formatting. It helps catch issues and enforces a consistent code style.
Commitizen: Helps enforce conventional commit messages for better project history.

It should be installed already. If not run:

pre-commit install

This will automatically run the following on every commit:

uv-lock: Validates your UV lock file.
ruff: Checks code style and formatting.
commitizen: Validates commit messages against the conventional commits specification.

Once you have UV installed, dependencies synced, and pre-commit hooks set, you’re ready for development. A typical workflow might look like:

Work on a feature or bug fix. Just tell other people what you will be working on in issues
Run your tests – our project uses Pytest for testing.
Commit your changes – pre-commit hooks ensure that your code meets our quality standards and that your commit messages follow the Conventional Commits guidelines.
Submit your PR - Create a branch with suitable name as per as your changes and raise PR