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

Jump to bottom

pip install fails with error: externally-managed-environment #4497

Open
fujitatomoya opened this issue May 29, 2024 · 3 comments · May be fixed by #4757
Open

pip install fails with error: externally-managed-environment #4497

fujitatomoya opened this issue May 29, 2024 · 3 comments · May be fixed by #4757
Assignees
@fujitatomoya

Comments

@fujitatomoya
Copy link
Collaborator

Using Ubuntu Nobel to build the documentation fails with the following error during installation of required packages.

root@tomoyafujita:~/ros2_ws/work/ros2_documentation# pip install -r requirements.txt -c constraints.txt
error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
    python3-xyz, where xyz is the package you are trying to
    install.

    If you wish to install a non-Debian-packaged Python package,
    create a virtual environment using python3 -m venv path/to/venv.
    Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
    sure you have python3-full installed.

    If you wish to install a non-Debian packaged Python application,
    it may be easiest to use pipx install xyz, which will manage a
    virtual environment for you. Make sure you have pipx installed.

    See /usr/share/doc/python3.12/README.venv for more information.

note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.

This is due to Ubuntu Nobel adopting PEP 668 – Marking Python base environments as “externally managed”

The followings are suggested fixes,
@clalancette
Copy link
Contributor

So the thing is, the README here already says that you need a virtualenv:

To build this you need to install

* make
* graphviz
* python virtualenv


In the virtualenv

``
pip install -r requirements.txt -c constraints.txt
``

I guess we can reword it to make it clearer, but I'm not sure what else to do here.

@christophebedard
Copy link
Member

Could we add the commands needed to create the venv? Before running pip install.

@fujitatomoya
Copy link
Collaborator Author

@clalancette you can assign this to me.

@fujitatomoya fujitatomoya linked a pull request Sep 20, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fujitatomoya fujitatomoya

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add how to build the doc with devcontainer. ros2/ros2_documentation
3 participants
@clalancette @christophebedard @fujitatomoya