Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add optional uv-based setup and Windows notes #5325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Vanshikadahaliya wants to merge 3 commits into
base: main
Choose a base branch
from
+37 −0
Open

docs: add optional uv-based setup and Windows notes #5325

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cd76cc
docs: document optional uv setup and Windows limitations
Dec 17, 2025
be7f162
docs: fix uv install code block and add setup steps
Dec 17, 2025
424c50c
docs: add uv usage steps
Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,43 @@ Before you start contributing, you'll need to set up your development environmen

### Python Virtual Environment Setup


### Optional: Python Virtual Environment Setup using `uv`

BLT can also be set up using [`uv`](https://github.com/astral-sh/uv), a fast Python package manager
and virtual environment tool. This is an **optional** alternative to the Poetry-based setup
described above.

This option is useful for contributors who prefer faster dependency resolution and installation.

#### Install `uv`

> ⚠️ Note (Windows):
> On some Windows setups, `uv` may fail to auto-detect Python installations
> due to registry or PATH resolution issues. In such cases, explicitly
> specifying the Python interpreter or using Docker/Poetry is recommended.


```bash
pip install uv
```

#### Set up the BLT project using `uv`

From the project root, run:

```bash
uv sync

To start the development server:

uv run python manage.py migrate
uv run python manage.py runserver

Open your browser at:
http://localhost:8000


1. Install Python 3.11.2 (using pyenv or another tool):

```bash
Expand Down
Loading