A linting and QA check tool for NASL files
Project description
Troubadix
A linting and QA check tool for NASL files
Installation
Requirements
Python 3.7 and later is supported.
Install using pip
pip 19.0 or later is required.
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 via pip
python3 -m pip install --user poetry
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
Environment Options
| ENV Variable | Default | Description |
|---|---|---|
| NASLINTER_DOCKER_RUN | 'false' |
If we use 'true' we use the Docker with the greenbone/ospd-openvas:stable image from DockerHub to run the tests via openvas-nasl-lint for the check_openvas_lintplugin. If default'false'` is used we expect that openvas is installed local. |
Maintainer
This project is maintained by Greenbone Networks GmbH
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 Networks GmbH
Licensed under the GNU General Public License v3.0 or later.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file troubadix-22.3.3.tar.gz.
File metadata
- Download URL: troubadix-22.3.3.tar.gz
- Upload date:
- Size: 117.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 22e8a505c85b48a0c542223a333f53d8550c126edf3bde0991a20aeefb2dd76b |
|
| MD5 | 812ff5de03ae4dcfdf05bec596ad7692 |
|
| BLAKE2b-256 | 04681e00b2c6cd8fc4a86c2900c77d9e21a0ac355584ca853d98ef87731aee32 |
Provenance
File details
Details for the file troubadix-22.3.3-py3-none-any.whl.
File metadata
- Download URL: troubadix-22.3.3-py3-none-any.whl
- Upload date:
- Size: 151.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6f741237eefe8ad075ed04f3cc724522b0783e7e576d433af229530405b3062d |
|
| MD5 | 4ebd411454a85739cb6bbe2fb35d18d9 |
|
| BLAKE2b-256 | 8eb5b6853fcf8656a2701e714e236d2128392896f2908776edc5d1105995fb28 |
