troubadix 24.10.0

A linting and QA check tool for NASL files

Troubadix

A linting and QA check tool for NASL files

Installation

Requirements

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

[!NOTE] The pip install command does no longer work out-of-the-box in newer distributions like Ubuntu 23.04 because of PEP 668. Please use the installation via pipx instead.

You can install the latest stable release of troubadix from the Python Package Index (pypi) using pip

python3 -m pip install --user troubadix

Install using poetry

Because troubadix is a Python application you most likely need a tool to handle Python package dependencies and Python environments. Therefore we strongly recommend using pipenv or poetry.

You can install the latest stable release of troubadix and add it as a dependency for your current project using poetry

poetry add troubadix

For installation via pipenv please take a look at their documentation.

Development

troubadix uses poetry for its own dependency management and build process.

First install poetry (see documentation).

Afterwards run

poetry install

in the checkout directory of troubadix (the directory containing the pyproject.toml file) to install all dependencies including the packages only required for development.

Afterwards activate the git hooks for auto-formatting and linting via autohooks.

poetry run autohooks activate

Validate the activated git hooks by running

poetry run autohooks check

Maintainer

This project is maintained by Greenbone AG

Contributing

Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.

License

Copyright (C) 2021-2022 Greenbone AG

Licensed under the GNU General Public License v3.0 or later.