Skip to content

Commit

Permalink
refactor: More uses of uv in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Oct 8, 2024
1 parent 977fe75 commit 0e3300e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
5 changes: 2 additions & 3 deletions project/CONTRIBUTING.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,11 @@ make setup
> You can install it with:
>
> ```bash
> python3 -m pip install --user pipx
> pipx install uv
> curl -LsSf https://astral.sh/uv/install.sh | sh
> ```
>
> Now you can try running `make setup` again,
> or simply `uv install`.
> or simply `uv sync`.

You now have the dependencies installed.

Expand Down
9 changes: 4 additions & 5 deletions project/README.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,17 @@
## Installation

{% if not insiders or public_release -%}
With `pip`:

```bash
pip install {{ python_package_distribution_name }}
```

With [`pipx`](https://github.com/pipxproject/pipx):
{% if python_package_command_line_name -%}
With [`uv`](https://docs.astral.sh/uv/):

```bash
python3.8 -m pip install --user pipx
pipx install {{ python_package_distribution_name }}
uv tool install {{ python_package_distribution_name }}
```
{%- endif -%}
{%- else -%}
This project is available to sponsors only, through my Insiders program.
See Insiders [explanation](https://{{ repository_namespace }}.github.io/{{ repository_name }}/insiders/)
Expand Down

0 comments on commit 0e3300e

Please sign in to comment.