Registry / devops / ansible-dev-environment

ansible-dev-environment

JSON →
library26.4.0pypypiunverified

Ansible Development Environment (ade) is a command-line tool designed to manage isolated virtual environments for Ansible content development. It simplifies the installation and removal of Ansible collections, handles Python dependency resolution for collections, and ensures consistent and reproducible development workspaces. As of version 26.4.0, it promotes an "ephemeral" development approach and is typically released as part of the broader `ansible-dev-tools` package, which has a regular maintenance and release cadence.

pip install ansible-dev-environment
INSTALL
IMPORT
SIG · ANSIBLE-DEV-ENVIRO
A
ansible-dev-environment
devopspythonv26.4.0
Install
7.3s avg
Import
Disk
32MB
Pass rate
4/ 10
Env Coverage4 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v26.4.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
glibc
py 3.10
4/8 runs
✓ 7.79s
py 3.11
4/8 runs
✓ 7.19s
py 3.12
4/8 runs
✓ 7.13s
py 3.13
4/8 runs
✓ 6.94s
py 3.9
✕ build_error
✕ build_error
32MB installed
● package 32MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

ade
This library is primarily a command-line interface (CLI) tool. Direct Python imports for programmatic use are not a common pattern as its functionality is exposed via the `ade` command.
ansible-dev-environment is a CLI tool, not typically imported as a Python library for direct programmatic use.

This quickstart demonstrates how to set up an isolated development environment for an Ansible collection using `ade`. It clones a sample collection, installs it in editable mode within a dedicated virtual environment, and then activates that environment for further development.

# Assuming you have a Git repository for your Ansible collection # git clone https://github.com/your_namespace/your_collection.git # cd your_collection ade install -e . --venv .venv # The above command creates a virtual environment '.venv' and installs # your collection in editable mode, along with its dependencies. # It also sets up isolation to prevent collection search path pollution. source .venv/bin/activate # Now you can use ansible-playbook, ansible-test, pytest, etc., # with the isolated environment and your collection. ansible-galaxy collection list
ade --version
Debug
Known issues
gotchaAnsible's collection search path behavior can lead to 'workspace pollution' where global collections override those in your virtual environment. This can cause silent version conflicts, inconsistent behavior, and debugging nightmares.
fix
`ade` (ansible-dev-environment) addresses this by installing collections into the virtual environment's site-packages and using isolation modes (like `cfg` which modifies `ansible.cfg` in the current directory with `collections_path = .`) to ensure the correct collection versions are used. Avoid using the `none` isolation mode for development.
affects: All versions
breakingWhile `ansible-dev-environment` itself generally focuses on environment management and less on direct API breaking changes, its functionality is tightly coupled with `ansible-core` and Ansible collections. Major releases of the broader Ansible community package (which `ansible-dev-environment` is part of conceptually, and often installed via `ansible-dev-tools`) can contain breaking changes in modules, plugins, and core features, following semantic versioning.
fix
Refer to the Ansible Porting Guides and changelogs for `ansible-core` and specific collections when upgrading. Validate your content to ensure compatibility with new templating changes or other behavioral shifts.
affects: Dependent on `ansible-core` and collection versions. Be cautious when upgrading major versions of `ansible-core` or collections.
gotcha`ansible-dev-environment` requires Python 3.10 or later. Using older Python versions will result in installation failures or unexpected behavior.
fix
Ensure your development environment uses Python 3.10 or a newer compatible version. Check `python3 --version` before installation.
affects: <26.0.0 (and potentially earlier major versions)
Upgrade
Version history
26.4.0latest on PyPI · released Apr 1, 2026
Audit
Dependencies
pythonrequiredRuntime requirement, specifically Python 3.10 or later.
ansible-coreoptionalCore Ansible functionality, often installed as a dependency or alongside `ade`.
uvoptionalUsed for performance boost in virtual environment management, if available. Can be disabled with `SKIP_UV=1`.
Agent activity
30 hits · last 30 days
node
28
OpenAI (training)
1
Resources
ansible-dev-environment — pip install ansible-dev-environment · libregistry