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.9 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 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.

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-24.1.0.tar.gz (158.9 kB view details)

Uploaded Source

Built Distribution

troubadix-24.1.0-py3-none-any.whl (192.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: troubadix-24.1.0.tar.gz
  • Upload date:
  • Size: 158.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1018-azure

File hashes

Hashes for troubadix-24.1.0.tar.gz
Algorithm Hash digest
SHA256 6524719ad241c924000ce100e55445b2833c10971524d9c436b9835acd7a2382
MD5 a1e5b63738b72a16da2f36ce455f0fee
BLAKE2b-256 87938c222358e5c0fd071f2c7597b5c0470aee5daa6ec88ba18d329bde8f1e9e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: troubadix-24.1.0-py3-none-any.whl
  • Upload date:
  • Size: 192.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1018-azure

File hashes

Hashes for troubadix-24.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cf4b861735dd049076900f37fc4e1cc3ef8cad652b6bc205dda19cd9682911d3
MD5 30ab54944d949e296ad45608e3ca0b45
BLAKE2b-256 517cb9f91e8d08bbaa7dea4b441ec077af7eaaf4697b8337f7a184d88978e293

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