troubadix


Nametroubadix JSON
Version 25.3.4 PyPI version JSON
download
home_pageNone
SummaryA linting and QA check tool for NASL files
upload_time2025-03-18 11:16:31
maintainerNone
docs_urlNone
authorGreenbone
requires_python<4.0,>=3.10
licenseGPL-3.0-or-later
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            ![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)

# Troubadix
A linting and QA check tool for NASL files

[![GitHub releases](https://img.shields.io/github/release/greenbone/troubadix.svg)](https://github.com/greenbone/troubadix/releases)
[![PyPI release](https://img.shields.io/pypi/v/troubadix.svg)](https://pypi.org/project/troubadix/)
[![codecov](https://codecov.io/gh/greenbone/troubadix/branch/main/graph/badge.svg?token=FFMmVmAmtb)](https://codecov.io/gh/greenbone/troubadix)
[![Build and test](https://github.com/greenbone/troubadix/actions/workflows/ci-python.yml/badge.svg)](https://github.com/greenbone/troubadix/actions/workflows/ci-python.yml)


## Installation

### Requirements

Python 3.9 and later is supported.

### Install using pipx

You can install the latest stable release of **troubadix** from the Python
Package Index (pypi) using [pipx]

    python3 -m pipx install troubadix

### Install using pip

> [!NOTE]
> The `pip install` command does no longer work out-of-the-box in newer
> distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668).
> Please use the [installation via pipx](#install-using-pipx) instead.

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][pipenv].

## Development

**troubadix** uses [poetry] for its own dependency management and build
process.

First install poetry (see [documentation](https://python-poetry.org/docs/#installation)).

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][Greenbone]

## Contributing

Your contributions are highly appreciated. Please
[create a pull request](https://github.com/greenbone/troubadix/pulls)
on GitHub. Bigger changes need to be discussed with the development team via the
[issues section at GitHub](https://github.com/greenbone/troubadix/issues)
first.

## License

Copyright (C) 2021-2022 [Greenbone AG][Greenbone]

Licensed under the [GNU General Public License v3.0 or later](LICENSE).

[Greenbone]: https://www.greenbone.net/
[poetry]: https://python-poetry.org/
[pip]: https://pip.pypa.io/
[pipx]: https://pypa.github.io/pipx/
[pipenv]: https://pipenv.pypa.io/
[autohooks]: https://github.com/greenbone/autohooks


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "troubadix",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Greenbone",
    "author_email": "info@greenbone.net",
    "download_url": "https://files.pythonhosted.org/packages/88/b9/b5cb6a54eddad060a0735c1c894b4b5397967eb5b1d15869be0f6f171ff5/troubadix-25.3.4.tar.gz",
    "platform": null,
    "description": "![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)\n\n# Troubadix\nA linting and QA check tool for NASL files\n\n[![GitHub releases](https://img.shields.io/github/release/greenbone/troubadix.svg)](https://github.com/greenbone/troubadix/releases)\n[![PyPI release](https://img.shields.io/pypi/v/troubadix.svg)](https://pypi.org/project/troubadix/)\n[![codecov](https://codecov.io/gh/greenbone/troubadix/branch/main/graph/badge.svg?token=FFMmVmAmtb)](https://codecov.io/gh/greenbone/troubadix)\n[![Build and test](https://github.com/greenbone/troubadix/actions/workflows/ci-python.yml/badge.svg)](https://github.com/greenbone/troubadix/actions/workflows/ci-python.yml)\n\n\n## Installation\n\n### Requirements\n\nPython 3.9 and later is supported.\n\n### Install using pipx\n\nYou can install the latest stable release of **troubadix** from the Python\nPackage Index (pypi) using [pipx]\n\n    python3 -m pipx install troubadix\n\n### Install using pip\n\n> [!NOTE]\n> The `pip install` command does no longer work out-of-the-box in newer\n> distributions like Ubuntu 23.04 because of [PEP 668](https://peps.python.org/pep-0668).\n> Please use the [installation via pipx](#install-using-pipx) instead.\n\nYou can install the latest stable release of **troubadix** from the Python\nPackage Index (pypi) using [pip]\n\n    python3 -m pip install --user troubadix\n\n### Install using poetry\n\nBecause **troubadix** is a Python application you most likely need a tool to\nhandle Python package dependencies and Python environments. Therefore we\nstrongly recommend using [pipenv] or [poetry].\n\nYou can install the latest stable release of **troubadix** and add it as\na dependency for your current project using [poetry]\n\n    poetry add troubadix\n\nFor installation via pipenv please take a look at their [documentation][pipenv].\n\n## Development\n\n**troubadix** uses [poetry] for its own dependency management and build\nprocess.\n\nFirst install poetry (see [documentation](https://python-poetry.org/docs/#installation)).\n\nAfterwards run\n\n    poetry install\n\nin the checkout directory of **troubadix** (the directory containing the\n`pyproject.toml` file) to install all dependencies including the packages only\nrequired for development.\n\nAfterwards activate the git hooks for auto-formatting and linting via\n[autohooks].\n\n    poetry run autohooks activate\n\nValidate the activated git hooks by running\n\n    poetry run autohooks check\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG][Greenbone]\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/troubadix/pulls)\non GitHub. Bigger changes need to be discussed with the development team via the\n[issues section at GitHub](https://github.com/greenbone/troubadix/issues)\nfirst.\n\n## License\n\nCopyright (C) 2021-2022 [Greenbone AG][Greenbone]\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n\n[Greenbone]: https://www.greenbone.net/\n[poetry]: https://python-poetry.org/\n[pip]: https://pip.pypa.io/\n[pipx]: https://pypa.github.io/pipx/\n[pipenv]: https://pipenv.pypa.io/\n[autohooks]: https://github.com/greenbone/autohooks\n\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "A linting and QA check tool for NASL files",
    "version": "25.3.4",
    "project_urls": {
        "Homepage": "https://github.com/greenbone/troubadix",
        "Repository": "https://github.com/greenbone/troubadix"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fd98cf81fc7f803dac4ec3be58ca15558d802ad8e195990be697fa9d22f3222e",
                "md5": "5a073316c8671d464c89cbe5d3fc9f72",
                "sha256": "8797ce00eb3d0ac3cc7491894250a30ac466a2e09e2862aa39b8e84a00980dc6"
            },
            "downloads": -1,
            "filename": "troubadix-25.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5a073316c8671d464c89cbe5d3fc9f72",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 215743,
            "upload_time": "2025-03-18T11:16:29",
            "upload_time_iso_8601": "2025-03-18T11:16:29.930068Z",
            "url": "https://files.pythonhosted.org/packages/fd/98/cf81fc7f803dac4ec3be58ca15558d802ad8e195990be697fa9d22f3222e/troubadix-25.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "88b9b5cb6a54eddad060a0735c1c894b4b5397967eb5b1d15869be0f6f171ff5",
                "md5": "6dfbda2f626e15227be7a9d82d3d946f",
                "sha256": "5ffa4e80e7175e0e845c74021cea1df5423c02eaaa722b4771fff2d9fb7fb124"
            },
            "downloads": -1,
            "filename": "troubadix-25.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "6dfbda2f626e15227be7a9d82d3d946f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 179274,
            "upload_time": "2025-03-18T11:16:31",
            "upload_time_iso_8601": "2025-03-18T11:16:31.503864Z",
            "url": "https://files.pythonhosted.org/packages/88/b9/b5cb6a54eddad060a0735c1c894b4b5397967eb5b1d15869be0f6f171ff5/troubadix-25.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-18 11:16:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "greenbone",
    "github_project": "troubadix",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "troubadix"
}
        
Elapsed time: 0.58116s