Skip to content
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

DOC: recommend uv over pipx #364

Merged
merged 3 commits into from
Sep 8, 2024
Merged

DOC: recommend uv over pipx #364

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d6b6d82
DOC: recommend uv over pipx
neutrinoceros Sep 8, 2024
0ce8093
Update README.md
neutrinoceros Sep 8, 2024
5a8f834
Update README.md
neutrinoceros Sep 8, 2024
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
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,17 @@ It defines a `idfx` command familly. The builtin command set (`idfx conf`, `idfx

`idefix_cli` is distributed via the Python Packaging Index (PyPI).

It is recommended to install this tool in isolation with [`pipx`](https://pipxproject.github.io/pipx/) as
It is recommended to install this tool at the system level, but still in isolation,
using for instance with
[`uv`](https://docs.astral.sh/uv/) as
neutrinoceros marked this conversation as resolved.
Show resolved Hide resolved
```shell
$ pipx install "idefix_cli[isolated]"
$ uv tool install 'idefix-cli[isolated]'
```
(adding `[isolated]` has the effect of pinning dependencies)
or [`pipx`](https://pipxproject.github.io/pipx/)
```shell
$ pipx install 'idefix-cli[isolated]'
```
(adding `[isolated]` has the effect of pinning dependencies, but is optional)

Otherwise, the most portable way to install the latest stable version is
```shell
Expand Down