Skip to content

docs: Update install docs for v25.02 #8204

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.

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

Conversation

chrisguida
Copy link
Contributor

@chrisguida chrisguida commented Apr 4, 2025

Also removes usage of pip due to this error that crops up on newer versions of Ubuntu:

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.

I've been recommending installing Poetry from the official installer for the past several months and it always works.

Changelog-None

Important

25.02 FREEZE JANUARY 31ST: Non-bugfix PRs not ready by this date will wait for 25.05.

Checklist

Before submitting the PR, ensure the following tasks are completed. If an item is not applicable to your PR, please mark it as checked:

  • The changelog has been updated in the relevant commit(s) according to the guidelines.
  • Tests have been added or modified to reflect the changes.
  • Documentation has been reviewed and updated as needed.
  • Related issues have been listed and linked, including any that this PR closes.

Copy link
Collaborator

@vincenzopalazzo vincenzopalazzo left a comment

Choose a reason for hiding this comment

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

ACK 3128fd3

Also removes usage of pip due to this error that crops up on newer
versions of Ubuntu:

```
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.
```

I've been recommending installing Poetry from the official
installer for the past several months and it always works.

Changelog-None
@chrisguida
Copy link
Contributor Author

rebased on master

@ShahanaFarooqui this is ready for re-review!

related: #8161

@chrisguida
Copy link
Contributor Author

@daywalker90 @ZenenTreadwell would love an ACK here :)

@ZenenTreadwell
Copy link

ACK 07c9c8e

I am ambivalent about poetry as a package manager - I much prefer using the standard venv package - but seeing as it is already integrated into CLN's installation process, I think that having it properly documented is a good thing.

+1 to everything else for improving readability and keeping things updated

@endothermicdev
Copy link
Collaborator

I think it's also time to clean up the poetry shell part as that command is removed from 2.0 onward, but this looks good.
ACK 07c9c8e

@chrisguida
Copy link
Contributor Author

@endothermicdev thanks for the review!

Are you planning to make the mentioned edits to the poetry shell stuff or should I? Sounds like you have a pretty good idea of what you want to see?

@endothermicdev
Copy link
Collaborator

I can do that in another PR.

@endothermicdev endothermicdev merged commit d3c7d2c into ElementsProject:master Apr 9, 2025
33 of 40 checks passed
@ShahanaFarooqui ShahanaFarooqui added this to the v25.05 milestone Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants