Follow the installation instructions provided by the uv documentation to install the latest version of uv package.
Open a terminal window in the project's root and run command:
uv sync --no-devThis will install required version of Python, create a virtual environment at .venv and install all the required packages. Finally, activate your virtual environment:
- MacOS/Linux:
source .venv/bin/activate - Windows:
.venv\Scripts\activate
Use .venv for running application.
Entry point: main.py
Example:
source .venv/bin/activate
uv run main.pyIf you are contributing to the project, please install the development dependencies by running uv sync without the --no-dev flag and install pre-commit hooks:
pre-commit installDon't push any changes to the master branch. Instead, create a new branch and submit a pull request.
Project uses ruff linter. Cheks are run in pre-commit hook. Some errors can be fixed automatically by running uv run ruff --fix.