Skip to main content

A linting and QA check tool for NASL files

Project description

Greenbone Logo

Troubadix

A linting and QA check tool for NASL files

GitHub releases PyPI release codecov Build and test

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

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.

Project details


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

troubadix-22.10.2.tar.gz (140.3 kB view details)

Uploaded Source

Built Distribution

troubadix-22.10.2-py3-none-any.whl (170.4 kB view details)

Uploaded Python 3

File details

Details for the file troubadix-22.10.2.tar.gz.

File metadata

  • Download URL: troubadix-22.10.2.tar.gz
  • Upload date:
  • Size: 140.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.14

File hashes

Hashes for troubadix-22.10.2.tar.gz
Algorithm Hash digest
SHA256 b4932ede4567bfef74385e05f2e03ddc942f597a0ef3d701b80c4216c5b21e89
MD5 87c94c60ef3f9be25ff35fc37f0ca105
BLAKE2b-256 2fc70612b90921d660f192c5a4257fed73d7b473584ba3083c642bbca9aa5354

See more details on using hashes here.

Provenance

File details

Details for the file troubadix-22.10.2-py3-none-any.whl.

File metadata

  • Download URL: troubadix-22.10.2-py3-none-any.whl
  • Upload date:
  • Size: 170.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.14

File hashes

Hashes for troubadix-22.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 66c03b7111554894104441575ee06fb7a02ca14694983bd132e740a13993f458
MD5 e959b3bce44cf43c03dac02d6ac01bcb
BLAKE2b-256 dc5f766e900d28b034a80f0eb13c1d03d44d8adfd81f1de7861cbbceeb9ea76f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page