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

Uploaded Source

Built Distribution

troubadix-24.7.3-py3-none-any.whl (202.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: troubadix-24.7.3.tar.gz
  • Upload date:
  • Size: 169.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for troubadix-24.7.3.tar.gz
Algorithm Hash digest
SHA256 52ae59f29d07edaa1593d0827e9d2e3c6e6129699372c3854744e29d9db67d6f
MD5 bf40874abe8ccba6bd15085c5781d41a
BLAKE2b-256 ca237d0a20fb07c131b21da502f9360d1fbc27c7f9c8418fd69835c43472a66c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: troubadix-24.7.3-py3-none-any.whl
  • Upload date:
  • Size: 202.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for troubadix-24.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 911fd39da59d411b72d6515a63c2796f4ab17ff03c90fde3a871c7314f07bfce
MD5 9daaf65977f16a073a5c517d22d58d75
BLAKE2b-256 814a4af64f24c5723a5bd4dbdd113b7b23fb9c2e50fc32c8a7aaf852444879cb

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