Skip to content

Commit 0cad1d5

Browse files
authored
docs: write the instructions for UV into the readme file (#15)
1 parent c773968 commit 0cad1d5

File tree

3 files changed

+1275
-13
lines changed

3 files changed

+1275
-13
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,20 @@ gh repo create NAME --template seedcase-project/template-example-repo
99

1010
## Setting things up after cloning
1111

12-
To add Poetry:
12+
To add uv:
13+
14+
1. Delete the `pyproject.toml` file.
15+
2. In the terminal run `uv init`.
16+
3. Look at the Git pane and take what was removed and move it over into the new `pyproject.toml` file. You can mimic what was done in `example-seed-beetle` repo.
17+
18+
Then, in the terminal, run:
1319

1420
``` bash
15-
cd new-project
16-
poetry init
21+
uv add polars pyjanitor
22+
uv add "seedcase-sprout @ git+<https://github.com/seedcase-project/seedcase-sprout>"
23+
uv add --dev ruff commitizen pre-commit
1724
```
1825

19-
Search for `NAME` and `REPO` and replace them with the name of your project and the repository name. Then look for any `TODO` items.
20-
2126
## Setting things up
2227

2328
Use the commands found in [`spaid`](https://github.com/seedcase-project/spaid) repo to run the next setup steps.

poetry.lock

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)