Skip to main content

Greenbone Logo

Troubadix

A linting and QA check tool for NASL files

GitHub releases PyPI release codecov Build and test

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

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.

Metadata

Release files for troubadix 26.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for troubadix 26.10.1
File Size Uploaded Provenance Actions
troubadix-26.10.1.tar.gz 201.3 kB Without provenance Details for troubadix-26.10.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for troubadix 26.10.1
File Interpreter ABI Platform Actions
troubadix-26.10.1-py3-none-any.whl Python 3 none any Details for troubadix-26.10.1-py3-none-any.whl

Total release size: 433.2 kB

Release files / troubadix-26.10.1.tar.gz

Download URL troubadix-26.10.1.tar.gz
Size 201.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b47b8b2d9565e5475c82622498fa744e22288a904d7c4df4f1d3528ae12e8b1d
BLAKE2b-256 checksum
How to use checksums
4a41dea25695cbef55aeca21bdfbcee6006d10be55462000d379d766a02bd95a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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.10.1-py3-none-any.whl

Download URL troubadix-26.10.1-py3-none-any.whl
Size 231.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
07db10f9a5e9ad43db39ccb6e408d7394d23de05cffd37ca420f38de07531846
BLAKE2b-256 checksum
How to use checksums
5685e11abc8e6ee878d82902dcc06dc2def1eb427d34593386150d625e68fb49
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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}

Security for troubadix 26.10.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

26.10.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page