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

Uploaded Source

Built Distribution

troubadix-23.1.0-py3-none-any.whl (172.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: troubadix-23.1.0.tar.gz
  • Upload date:
  • Size: 142.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.15

File hashes

Hashes for troubadix-23.1.0.tar.gz
Algorithm Hash digest
SHA256 79fcff8b72ab5ca9ffe6e3a83463842fc393b37bae759bcaf9fae87f05407e02
MD5 3140d6af0879f5153dc8a9121c0d8d74
BLAKE2b-256 8f07f786669215ed12cb905c04b65b0b7843fec1a5d488fc149660364dcd6d87

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: troubadix-23.1.0-py3-none-any.whl
  • Upload date:
  • Size: 172.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.15

File hashes

Hashes for troubadix-23.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 59c1ad7f62890a7bb7d3817d21e2df1a7422ce7c4829fe18c0480ae55907c64a
MD5 50367ea0d337c5a8fe2a1b7181f97180
BLAKE2b-256 c1abb6992c45053d1975f1468e1f81e611ff6cce9a173551b4db1acc43230823

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