Skip to content

virtual environment on Debian 12 #851

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −0
Open

virtual environment on Debian 12 #851

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
3 changes: 3 additions & 0 deletions docs/install/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ InvenioRDM is set up with a command line management tool, `invenio-cli`, which i
pip install invenio-cli
```

!!! warning "Create a virtual environment"
When installing on Debian 12 with Python 3.11, one has to create the virtual environment first with the `venv` module. For example: ```python -m venv venv --prompt invenioDRM.```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slight modification to emphasize PEP 668 as the root reason here.

Suggested change
When installing on Debian 12 with Python 3.11, one has to create the virtual environment first with the `venv` module. For example: ```python -m venv venv --prompt invenioDRM.```
When installing on an environment adhering to [PEP 668](https://peps.python.org/pep-0668/), e.g., Debian 12 with Python 3.11, one has to create the virtual environment first. For example, with the `venv` module: `python -m venv .venv --prompt invenioDRM`.

It must be said too that invenio-cli is not necessarily meant to be installed in the same virtualenv as the application. It's an independent tool that can be used to create other instances on the same machine for instance. This is why pip install -U or pipx or (probably will be the recommended default in next version of InvenioRDM like @carlinmack mentioned) uv tool install invenio-cli are good avenues. But Python environments are tricky so a generic pip install was the default recommendation.


=== "uv"

```shell
Expand Down