zylo

POC Snowflake for Zylo

Project requirements

Astral/uv

• Install uv to manage your Python version, virtual environments, dependencies and tooling configs: see installation docs.

Installation

Python virtual environment and dependencies

Run the following command:

uv sync

or else:

make install

Install git hooks (running before commit and push commands)

uv run pre-commit install

Testing

To run unit tests, run pytest with:

uv run pytest tests --cov src

or

make test

Formatting and static analysis

Code formatting with ruff

To check code formatting, run ruff format with:

uv run ruff format --check .

or

make format-check

You can also integrate it to your IDE to reformat your code each time you save a file.

Static analysis with ruff

To run static analysis, run ruff with:

uv run ruff check src tests

or

make lint-check

To run static analysis and to apply auto-fixes, run ruff with:

make lint-fix

Type checking with mypy

To type check your code, run mypy with:

uv run mypy src --explicit-package-bases --namespace-packages

or

make type-check

Streamlit

The project includes a Streamlit app. See its documentation in the specific README.