Skip to content

Commit

Permalink
Add: Update readme to document installation via pipx
Browse files Browse the repository at this point in the history
With newest distros the externally-managed flag is considered and pip
doesn't allow to install python packages without virtual environments
anymore (see [PEP 668](https://peps.python.org/pep-0668)).

Therefore add a section about installing via pipx.
  • Loading branch information
bjoernricks committed Apr 26, 2023
1 parent 6fc0e58 commit 1f875e2
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ the titan of the sea.
- [Documentation](#documentation)
- [Installation](#installation)
- [Requirements](#requirements)
- [Install using pipx](#install-using-pipx)
- [Install using pip](#install-using-pip)
- [Install using poetry](#install-using-poetry)
- [Development](#development)
Expand All @@ -35,8 +36,19 @@ The documentation for pontos can be found at https://greenbone.github.io/pontos/

Python 3.9 and later is supported.

### Install using pipx

You can install the latest stable release of **pontos** from the Python
Package Index (pypi) using [pipx]

python3 -m pipx install pontos

### Install using pip

**NOTE:** The ‘pip install’ command does no longer work out-of-the-box in newer
distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668).
Please use the [installation via pipx](#install-using-pipx) instead.

You can install the latest stable release of **pontos** from the Python
Package Index (pypi) using [pip]

Expand All @@ -58,9 +70,9 @@ a dependency for your current project using [poetry]
**pontos** uses [poetry] for its own dependency management and build
process.

First install poetry via pip
First install poetry via pipx

python3 -m pip install --user poetry
python3 -m pipx install poetry

Afterwards run

Expand Down Expand Up @@ -100,4 +112,5 @@ Licensed under the [GNU General Public License v3.0 or later](LICENSE).
[Greenbone Networks]: https://www.greenbone.net/
[poetry]: https://python-poetry.org/
[pip]: https://pip.pypa.io/
[pipx]: https://pypa.github.io/pipx/
[autohooks]: https://github.com/greenbone/autohooks

0 comments on commit 1f875e2

Please sign in to comment.