# Troubadix
A linting and QA check tool for NASL files
[](https://github.com/greenbone/troubadix/releases)
[](https://pypi.org/project/troubadix/)
[](https://codecov.io/gh/greenbone/troubadix)
[](https://github.com/greenbone/troubadix/actions/workflows/ci-python.yml)
## 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][pipenv].
## 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][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/
[pipenv]: https://pipenv.pypa.io/
[autohooks]: https://github.com/greenbone/autohooks
Raw data
{
"_id": null,
"home_page": "https://github.com/greenbone/troubadix",
"name": "troubadix",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Greenbone",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/d3/f6/71379115c6efaf4f868b6534d442ac21d55c684d8df03bc12c8e08629441/troubadix-24.4.1.tar.gz",
"platform": null,
"description": "\n\n# Troubadix\nA linting and QA check tool for NASL files\n\n[](https://github.com/greenbone/troubadix/releases)\n[](https://pypi.org/project/troubadix/)\n[](https://codecov.io/gh/greenbone/troubadix)\n[](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 pip\n\npip 19.0 or later is required.\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 via pip\n\n python3 -m pip install --user poetry\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[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": "24.4.1",
"project_urls": {
"Homepage": "https://github.com/greenbone/troubadix",
"Repository": "https://github.com/greenbone/troubadix"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "039eb7cb58888913a383fc81c6c4b55702ef0a6fdd5d47e7974d91c62954941b",
"md5": "26818f7ed669ff5f4c5b71df66ec1b33",
"sha256": "482cbee72a603d5d3c0a3057db13b26277f371430846113fc7f5e3ccbf088522"
},
"downloads": -1,
"filename": "troubadix-24.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26818f7ed669ff5f4c5b71df66ec1b33",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 196117,
"upload_time": "2024-04-16T14:43:09",
"upload_time_iso_8601": "2024-04-16T14:43:09.348383Z",
"url": "https://files.pythonhosted.org/packages/03/9e/b7cb58888913a383fc81c6c4b55702ef0a6fdd5d47e7974d91c62954941b/troubadix-24.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3f671379115c6efaf4f868b6534d442ac21d55c684d8df03bc12c8e08629441",
"md5": "8ad90e94454b32d876492358d561ac88",
"sha256": "760551f7f930f154694dc04adf37d218065cf6a99cb788a60f78ff70bc40f235"
},
"downloads": -1,
"filename": "troubadix-24.4.1.tar.gz",
"has_sig": false,
"md5_digest": "8ad90e94454b32d876492358d561ac88",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 162074,
"upload_time": "2024-04-16T14:43:11",
"upload_time_iso_8601": "2024-04-16T14:43:11.886946Z",
"url": "https://files.pythonhosted.org/packages/d3/f6/71379115c6efaf4f868b6534d442ac21d55c684d8df03bc12c8e08629441/troubadix-24.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 14:43:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greenbone",
"github_project": "troubadix",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "troubadix"
}
JSON
