andebox
andebox is a script to assist Ansible developers by encapsulating some boilerplate tasks, especially the ability of running tests from the root directory of the collection project without any additional setup.
Highlights
Setup-less ansible-test
No need to clone in specific locations or keep track of env variables. Simply clone whichever collection you want and
run the ansible-test command as:
$ andebox test sanity -- --docker default --test validate-modules plugins/modules/mymodule.py
$ andebox test units -- --docker default test/units/plugins/modules/mymodule.py
$ andebox test integration -- --docker default mymodule
If you want to test your code against multiple versions of ansible-core or other component, you
will like the tox-test subcommand as well.
Stats on ignore files
Gathering stats from the ignore files can be quite annoying, especially if they are long. One can run:
$ andebox ignores -s2.20 -fc validate-modules:parameter-state-invalid-choice
1 plugins/modules/consul_session.py validate-modules:parameter-state-invalid-choice
1 plugins/modules/osx_defaults.py validate-modules:parameter-state-invalid-choice
1 plugins/modules/parted.py validate-modules:parameter-state-invalid-choice
1 plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
Runtime config
Quickly peek what is the runtime.yml status for a specific module:
$ andebox runtime scaleway_ip_facts
D modules scaleway_ip_facts: deprecation in 3.0.0 (current=2.4.0): Use community.general.scaleway_ip_info instead.
Or using a regular expression:
$ andebox runtime -r 'gc[pe]' | head -5
R lookup gcp_storage_file: redirected to community.google.gcp_storage_file
T modules gce: terminated in 2.0.0: Use google.cloud.gcp_compute_instance instead.
R modules gce_eip: redirected to community.google.gce_eip
R modules gce_img: redirected to community.google.gce_img
R modules gce_instance_template: redirected to community.google.gce_instance_template
where D=Deprecated, T=Tombstone, R=Redirect.
Run Integration Tests in Vagrant VMs
To run integration tests inside a VM managed by vagrant:
# Run test in VM named "fedora37" using sudo
$ andebox vagrant -n fedora37 -s -- --python 3.9 xfs_quota --color yes
andebox does not manage your Vagrantfile. The user is responsible for creating and setting up the VM definition.
Installation
Install it as usual:
pip install andebox
If you use pipx (strongly recommended), you may use:
pipx install andebox
1 maintainer
Metadata
1 maintainer
Release files for andebox 2.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| andebox-2.1.0.tar.gz | 20.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| andebox-2.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 46.4 kB
Release files / andebox-2.1.0.tar.gz
| Download URL | andebox-2.1.0.tar.gz |
|---|---|
| Size | 20.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d888d17c63fab2b377d853b455cf9ff4f017bd6ea708e7125fecc34919db175
|
|
BLAKE2b-256 checksum How to use checksums |
b27e691b603e231ba177f55e22406883c97eb315e02bceca511f5c0037d08d19
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logRelease files / andebox-2.1.0-py3-none-any.whl
| Download URL | andebox-2.1.0-py3-none-any.whl |
|---|---|
| Size | 26.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3d98ff5fd94cc7243178c6359bdd159d7da1b1d6a26f4f73cbd45b9eb91e8865
|
|
BLAKE2b-256 checksum How to use checksums |
27caa33bf23073a743abad8b2f17aeddd23c13fcb4b4caa29756f9c2468d819b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency log
