Skip to content

Commit f9512b6

Browse files
committed
Move to UV, adjust docs
1 parent 0d62c35 commit f9512b6

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@ Hi there! Welcome to the tilesets-cli contributing document. Issues, comments, a
44

55
## Installation
66

7-
First, clone the repo and `cd` into the folder:
7+
Install uv (https://docs.astral.sh/uv/) and then clone the repo and `cd` into the folder:
88

99
```bash
1010
# clone
1111
git clone [email protected]:mapbox/tilesets-cli.git
1212
cd tilesets-cli
1313

14-
# virtual env (optional)
15-
mkvirtualenv tilesets-cli
14+
# install deps (creates .venv)
15+
uv sync --group dev
1616

17-
# install deps
18-
pip install -e '.[test]'
17+
# include optional estimate-area dependencies
18+
uv sync --group dev --extra estimate-area
1919

2020
# confirm installation was successful
21-
tilesets --help
22-
tilesets --version
21+
uv run tilesets --help
22+
uv run tilesets --version
2323
```
2424

2525
## Pre-commit hooks
2626

27-
We use [pre-commit hooks](https://pre-commit.com/) to auto-format and validate code before committing. `pre-commit` is included with the `[test]` extras, but you must run:
27+
We use [pre-commit hooks](https://pre-commit.com/) to auto-format and validate code before committing. `pre-commit` is included with the `dev` dependency group, but you must run:
2828

2929
```bash
30-
$ pre-commit install
30+
$ uv run pre-commit install
3131
```
3232
within the repo to have the actions specified in `.pre-commit-config.yaml` registered.
3333

@@ -47,14 +47,14 @@ Releases to PyPi are handled via Github Actions and GitHub tags. Once changes ha
4747

4848
## Tests
4949

50-
All tests are runnable with pytest. pytest is not installed by default and can be installed with the pip test extras
50+
All tests are runnable with pytest. pytest is installed via the `dev` dependency group:
5151

5252
```shell
53-
pip install -e '.[test]'
53+
uv sync --group dev
5454
```
5555

5656
Running tests
5757

5858
```
59-
pytest
59+
uv run pytest
6060
```

0 commit comments

Comments
 (0)