Skip to content

Commit

Permalink
Merge pull request #748 from greenbone/update_installation_readme
Browse files Browse the repository at this point in the history
Update installation instrucations in README
  • Loading branch information
n-thumann authored Sep 2, 2024
2 parents 4cbe38c + a907a19 commit a52071f
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,19 @@ A linting and QA check tool for NASL files

Python 3.9 and later is supported.

### Install using pipx

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

python3 -m pipx install troubadix

### Install using pip

pip 19.0 or later is required.
> [!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 **troubadix** from the Python
Package Index (pypi) using [pip]
Expand All @@ -42,9 +52,7 @@ For installation via pipenv please take a look at their [documentation][pipenv].
**troubadix** uses [poetry] for its own dependency management and build
process.

First install poetry via pip

python3 -m pip install --user poetry
First install poetry (see [documentation](https://python-poetry.org/docs/#installation)).

Afterwards run

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

0 comments on commit a52071f

Please sign in to comment.