| Name | ansibug JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Ansible Debug Adapter Protocol Implementation |
| upload_time | 2024-11-10 02:02:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Jordan Borean, Red Hat Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
ansible
debug
lsp
dap
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Ansibug
[](https://github.com/jborean93/ansibug/actions/workflows/ci.yml)
[](https://codecov.io/gh/jborean93/ansibug)
[](https://badge.fury.io/py/ansibug)
[](https://github.com/jborean93/ansibug/blob/main/LICENSE)
The core component of the Ansible Debug Adapter Protocol used for debugging Ansible playbooks.
See more documentation for `ansibug` at https://jborean93.github.io/ansibug/.
Please note this library should be considered a preview.
New features and behaviour changes should be expected during this preview period.
# Debug Adapter
This library combined with a [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/) client, like Visual Studio Code, can be used to run and debug Ansible playbook's interactively.
It supports basic features like stepping in, over, and out of tasks in a play with support for getting and setting variables at runtime.
More information about the debug adapter and debugging experience of Ansible can be found under [the docs](https://jborean93.github.io/ansibug/).
# Requirements
The following Python requirements must be met before using this library:
+ Python 3.10+ (dependent on `ansible-core` support)
+ `ansible-core >= 2.16.0`
+ Linux or macOS (no Windows)
The debugger aims to continue to support the current `ansible-core` versions that have no reached End Of Life.
See the [ansible-core support matrix](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix) to see the current versions and the control node python versions for those versions.
There are no guarantees that all features will be supported across Ansible versions, new features might be reliant on changes only present in newer Ansible versions.
Any such features will be explicitly called out in the documentation.
# Installation
This library has been published on PyPI and can be installed with:
```bash
python -m pip install ansibug
```
To test out the changes locally run the following:
```bash
git clone https://github.com/jborean93/ansibug.git
python -m pip install -e .[dev]
pre-commit install
```
This will install the current code in editable mode and also include some development libraries needed for testing or other development features.
# Testing
This library uses [tox](https://tox.wiki/) to run the sanity and integration tests.
Once the dev extras for this library has been installed, all the tests can be run by running the `tox` command.
As the support matrix for this library can take some time to run it might be beneficial to run only certain tests.
The following factors are available in tox
+ `sanity`
+ `py3{10,11,12,13}`
+ `ansible_{2.16,2.17,2.18,devel}`
Here are some example factors that can be invoked with tox:
```bash
# Run only the sanity tests
tox run -f sanity
# Run Ansible 2.16 on all its supported Python versions
tox run -f ansible_2.16
# Run Python 3.12 on all the supported Ansible versions
tox run -f py312
# Run Ansible 2.16 tests on Python 3.12
tox run -f py312 ansible_2.16
```
Raw data
{
"_id": null,
"home_page": null,
"name": "ansibug",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ansible, debug, lsp, dap",
"author": null,
"author_email": "Jordan Borean <jborean93@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/23/40/8738b2155fabde5a6ddde009ab99c5720c49f699162d4279be9653dffd16/ansibug-0.2.0.tar.gz",
"platform": null,
"description": "# Ansibug\n\n[](https://github.com/jborean93/ansibug/actions/workflows/ci.yml)\n[](https://codecov.io/gh/jborean93/ansibug)\n[](https://badge.fury.io/py/ansibug)\n[](https://github.com/jborean93/ansibug/blob/main/LICENSE)\n\nThe core component of the Ansible Debug Adapter Protocol used for debugging Ansible playbooks.\nSee more documentation for `ansibug` at https://jborean93.github.io/ansibug/.\n\nPlease note this library should be considered a preview.\nNew features and behaviour changes should be expected during this preview period.\n\n# Debug Adapter\nThis library combined with a [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/) client, like Visual Studio Code, can be used to run and debug Ansible playbook's interactively.\nIt supports basic features like stepping in, over, and out of tasks in a play with support for getting and setting variables at runtime.\n\n\n\nMore information about the debug adapter and debugging experience of Ansible can be found under [the docs](https://jborean93.github.io/ansibug/).\n\n# Requirements\nThe following Python requirements must be met before using this library:\n\n+ Python 3.10+ (dependent on `ansible-core` support)\n+ `ansible-core >= 2.16.0`\n+ Linux or macOS (no Windows)\n\nThe debugger aims to continue to support the current `ansible-core` versions that have no reached End Of Life.\nSee the [ansible-core support matrix](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix) to see the current versions and the control node python versions for those versions.\nThere are no guarantees that all features will be supported across Ansible versions, new features might be reliant on changes only present in newer Ansible versions.\nAny such features will be explicitly called out in the documentation.\n\n# Installation\nThis library has been published on PyPI and can be installed with:\n\n```bash\npython -m pip install ansibug\n```\n\nTo test out the changes locally run the following:\n```bash\ngit clone https://github.com/jborean93/ansibug.git\n\npython -m pip install -e .[dev]\npre-commit install\n```\n\nThis will install the current code in editable mode and also include some development libraries needed for testing or other development features.\n\n# Testing\nThis library uses [tox](https://tox.wiki/) to run the sanity and integration tests.\nOnce the dev extras for this library has been installed, all the tests can be run by running the `tox` command.\n\nAs the support matrix for this library can take some time to run it might be beneficial to run only certain tests.\nThe following factors are available in tox\n\n+ `sanity`\n+ `py3{10,11,12,13}`\n+ `ansible_{2.16,2.17,2.18,devel}`\n\nHere are some example factors that can be invoked with tox:\n\n```bash\n# Run only the sanity tests\ntox run -f sanity\n\n# Run Ansible 2.16 on all its supported Python versions\ntox run -f ansible_2.16\n\n# Run Python 3.12 on all the supported Ansible versions\ntox run -f py312\n\n# Run Ansible 2.16 tests on Python 3.12\ntox run -f py312 ansible_2.16\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Jordan Borean, Red Hat Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Ansible Debug Adapter Protocol Implementation",
"version": "0.2.0",
"project_urls": {
"homepage": "https://github.com/jborean93/ansibug"
},
"split_keywords": [
"ansible",
" debug",
" lsp",
" dap"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25233a978e85fe2a096ad99c167d95d9dc6e640da3316cd6897e23995cf9075c",
"md5": "65ff20e70c18eaaaef1a3dffb28ff8f0",
"sha256": "7e5e40f0f784b3792edecd1bbcf52a0a4199b864e1ff9678d0da1666519d6127"
},
"downloads": -1,
"filename": "ansibug-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65ff20e70c18eaaaef1a3dffb28ff8f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 64650,
"upload_time": "2024-11-10T02:02:50",
"upload_time_iso_8601": "2024-11-10T02:02:50.708676Z",
"url": "https://files.pythonhosted.org/packages/25/23/3a978e85fe2a096ad99c167d95d9dc6e640da3316cd6897e23995cf9075c/ansibug-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "23408738b2155fabde5a6ddde009ab99c5720c49f699162d4279be9653dffd16",
"md5": "05071b43c3dab7b36af772a8f17ef152",
"sha256": "b89ea8b41f0547b070b6f4abb0e1d03899425f39bdcfc3a81dc4399e2b47bc93"
},
"downloads": -1,
"filename": "ansibug-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "05071b43c3dab7b36af772a8f17ef152",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 56434,
"upload_time": "2024-11-10T02:02:52",
"upload_time_iso_8601": "2024-11-10T02:02:52.272434Z",
"url": "https://files.pythonhosted.org/packages/23/40/8738b2155fabde5a6ddde009ab99c5720c49f699162d4279be9653dffd16/ansibug-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-10 02:02:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jborean93",
"github_project": "ansibug",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ansibug"
}
