Skip to content

Add uv setup instructions to README Environment section #14

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

Merged
mahynski merged 1 commit into from
May 5, 2026
Merged

Add uv setup instructions to README Environment section #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,17 @@ python -m ipykernel install --user --name=awesome_env # register Jupyter kerne
jupyter notebook --port 4321 # launch on localhost (default auth enabled)
```

Or, using [uv](https://docs.astral.sh/uv/) (a fast drop-in for `pip` and `venv` from Astral):

```bash
uv venv awesome_env --python 3.12 # create virtual env in ./awesome_env
source awesome_env/bin/activate # Windows: awesome_env\Scripts\activate
cd my_awesome_new_package
uv pip install -e ".[dev]" # editable install with dev/test/docs/notebook extras
python -m ipykernel install --user --name=awesome_env # register Jupyter kernel
jupyter notebook --port 4321 # launch on localhost (default auth enabled)
```

The package declares the following extras in `pyproject.toml`:

- `test` — `pytest` + `pytest-cov` (what CI installs)
Expand Down
Loading