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 installcommand 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.
Release files for troubadix 26.8.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| troubadix-26.8.5.tar.gz | 201.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| troubadix-26.8.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 433.4 kB
Release files / troubadix-26.8.5.tar.gz
| Download URL | troubadix-26.8.5.tar.gz |
|---|---|
| Size | 201.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fbc9374d3226c8e52b6a209e2318069997f3bb862219a8d89592f6a9ed923af6
|
|
BLAKE2b-256 checksum How to use checksums |
248e021ca5d0fad886c022faf42250d4846f0c2c0921731b11fd24c2ea538ddb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / troubadix-26.8.5-py3-none-any.whl
| Download URL | troubadix-26.8.5-py3-none-any.whl |
|---|---|
| Size | 232.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
19e12354d1772243cc0a6ed6b6a1814b257b8231b21a9a6c2bb0548cfb7969d7
|
|
BLAKE2b-256 checksum How to use checksums |
b376518248784d9ee8d8d052a9533b3c469e4ab948a17caf6f31b96e9281c71a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
