Skip to content

Commit a2bd315

Browse files
popyson1648Your Name
andauthored
feat: Integrate uv for development workflow (#17)
Co-authored-by: Your Name <[email protected]>
1 parent 36f104c commit a2bd315

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

.github/workflows/ci.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,13 @@ jobs:
2121
with:
2222
python-version: ${{ matrix.python-version }}
2323

24+
- name: Install uv
25+
run: curl -LsSf https://astral.sh/uv/install.sh | sh
26+
2427
- name: Install dependencies
2528
run: |
26-
python -m pip install --upgrade pip
27-
pip install -e .[dev]
29+
source $HOME/.cargo/env
30+
uv pip install --system -e .[dev]
2831
2932
- name: Lint and Format Check with ruff
3033
run: |

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -161,17 +161,24 @@ Contributions are welcome! Please feel free to open an issue or submit a pull re
161161

162162
### Development Setup
163163

164+
We use [uv](https://github.com/astral-sh/uv) for managing our development environment.
165+
164166
1. Clone the repository.
165-
2. Create a virtual environment and activate it.
166-
3. Install pre-commit hooks:
167+
2. Install `uv` (see [official instructions](https://github.com/astral-sh/uv#installation)).
168+
3. Create and activate a virtual environment:
169+
```bash
170+
uv venv
171+
source .venv/bin/activate
172+
```
173+
4. Install pre-commit hooks:
167174
```bash
168175
pre-commit install
169176
```
170-
4. Install the package in editable mode with development dependencies:
177+
5. Install the package in editable mode with development dependencies:
171178
```bash
172-
pip install -e .[dev]
179+
uv pip install -e .[dev]
173180
```
174-
5. Run tests:
181+
6. Run tests:
175182
```bash
176183
pytest
177184
```

mise.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
[tools]
22
node = "24.4.0"
33
python="3.13.5"
4-
4+
uv = "0.7.20"

0 commit comments

Comments
 (0)