How to set up a development environment

Set up a local environment to contribute to ezqt-widgets.

🔧 Prerequisites

• Python >= 3.11 (python.org)
• uv installed (pip install uv)
• git installed

📝 Steps

1. Clone the repository.

git clone https://github.com/neuraaak/ezqt-widgets.git
cd ezqt-widgets

1. Create a virtual environment and install all dependencies.

uv sync --extra dev

You should see all packages resolved and installed from the lockfile.

1. Install pre-commit hooks.

uv run pre-commit install

You should see pre-commit installed at .git/hooks/pre-commit.

✅ Result

You now have a working development environment. Run uv run pytest to verify the test suite passes.

➡️ Next steps

• How to run and write tests
• API Reference