| Name | ansible-dev-environment JSON |
| Version |
24.12.0
JSON |
| download |
| home_page | None |
| Summary | A pip-like ansible collection installer. |
| upload_time | 2024-12-12 05:27:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | GPL-3.0-only |
| keywords |
ansible
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ansible-dev-environment
A pip-like install for ansible collections.
## Features
- Promotes an "ephemeral" development approach
- Ensures the current development environment is isolated
- Install all collection python requirements
- Install all collection test requirements
- Checks for missing system packages
- Symlinks the current collection into the current python interpreter's site-packages
- Install all collection collection dependencies into the current python interpreter's site-packages
By placing collections into the python site-packages directory they are discoverable by ansible as well as python and pytest.
## Communication
- Join the Ansible forum:
- [Get Help](https://forum.ansible.com/c/help/6): get help or help others. Please add appropriate tags if you start new discussions.
- [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
- [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.
- [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
## Usage
### Setting up a development environment
```
$ pip install ansible-dev-environment --user
$ git clone <collection_repo>
$ cd <collection_repo>
$ ade install -e .\[test] --venv venv
INFO: Found collection name: network.interfaces from /home/bthornto/github/network.interfaces/galaxy.yml.
INFO: Creating virtual environment: /home/bthornto/github/network.interfaces/venv
INFO: Virtual environment: /home/bthornto/github/network.interfaces/venv
INFO: Using specified interpreter: /home/bthornto/github/network.interfaces/venv/bin/python
INFO: Requirements file /home/bthornto/github/network.interfaces/requirements.txt is empty, skipping
INFO: Installing python requirements from /home/bthornto/github/network.interfaces/test-requirements.txt
INFO: Installing ansible-core.
INFO: Initializing build directory: /home/bthornto/github/network.interfaces/build
INFO: Copying collection to build directory using git ls-files.
INFO: Running ansible-galaxy to build collection.
INFO: Running ansible-galaxy to install collection and it's dependencies.
INFO: Removing installed /home/bthornto/github/network.interfaces/venv/lib64/python3.11/site-packages/ansible_collections/network/interfaces
INFO: Symlinking /home/bthornto/github/network.interfaces/venv/lib64/python3.11/site-packages/ansible_collections/network/interfaces to /home/bthornto/github/network.interfaces
WARNING: A virtual environment was specified but has not been activated.
WARNING: Please activate the virtual environment:
source venv/bin/activate
```
### Tearing down the development environment
```
$ ade uninstall ansible.scm
INFO Found collection name: ansible.scm from /home/bthornto/github/ansible.scm/galaxy.yml.
INFO Requirements file /home/bthornto/github/ansible.scm/requirements.txt is empty, skipping
INFO Uninstalling python requirements from /home/bthornto/github/ansible.scm/test-requirements.txt
INFO Removed ansible.utils: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections/ansible/utils
INFO Removed ansible.utils*.info: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections/ansible.utils-2.10.3.info
INFO Removed ansible.scm: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections/ansible/scm
INFO Removed collection namespace root: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections/ansible
INFO Removed collection root: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections
```
## Help
`ade --help`
`ade install --help`
`ade uninstall --help`
Raw data
{
"_id": null,
"home_page": null,
"name": "ansible-dev-environment",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Ansible by Red Hat <info@ansible.com>",
"keywords": "ansible",
"author": null,
"author_email": "\"Bradley A. Thornton\" <bthornto@redhat.com>",
"download_url": "https://files.pythonhosted.org/packages/37/fb/abfe9e73f575deb44a266de220ff0c9ba4c12dac8e875e395f49ab17320e/ansible_dev_environment-24.12.0.tar.gz",
"platform": null,
"description": "# ansible-dev-environment\n\nA pip-like install for ansible collections.\n\n## Features\n\n- Promotes an \"ephemeral\" development approach\n- Ensures the current development environment is isolated\n- Install all collection python requirements\n- Install all collection test requirements\n- Checks for missing system packages\n- Symlinks the current collection into the current python interpreter's site-packages\n- Install all collection collection dependencies into the current python interpreter's site-packages\n\nBy placing collections into the python site-packages directory they are discoverable by ansible as well as python and pytest.\n\n## Communication\n\n- Join the Ansible forum:\n\n - [Get Help](https://forum.ansible.com/c/help/6): get help or help others. Please add appropriate tags if you start new discussions.\n - [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.\n - [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.\n - [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.\n\nFor more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).\n\n## Usage\n\n### Setting up a development environment\n\n```\n$ pip install ansible-dev-environment --user\n$ git clone <collection_repo>\n$ cd <collection_repo>\n$ ade install -e .\\[test] --venv venv\nINFO: Found collection name: network.interfaces from /home/bthornto/github/network.interfaces/galaxy.yml.\nINFO: Creating virtual environment: /home/bthornto/github/network.interfaces/venv\nINFO: Virtual environment: /home/bthornto/github/network.interfaces/venv\nINFO: Using specified interpreter: /home/bthornto/github/network.interfaces/venv/bin/python\nINFO: Requirements file /home/bthornto/github/network.interfaces/requirements.txt is empty, skipping\nINFO: Installing python requirements from /home/bthornto/github/network.interfaces/test-requirements.txt\nINFO: Installing ansible-core.\nINFO: Initializing build directory: /home/bthornto/github/network.interfaces/build\nINFO: Copying collection to build directory using git ls-files.\nINFO: Running ansible-galaxy to build collection.\nINFO: Running ansible-galaxy to install collection and it's dependencies.\nINFO: Removing installed /home/bthornto/github/network.interfaces/venv/lib64/python3.11/site-packages/ansible_collections/network/interfaces\nINFO: Symlinking /home/bthornto/github/network.interfaces/venv/lib64/python3.11/site-packages/ansible_collections/network/interfaces to /home/bthornto/github/network.interfaces\nWARNING: A virtual environment was specified but has not been activated.\nWARNING: Please activate the virtual environment:\nsource venv/bin/activate\n```\n\n### Tearing down the development environment\n\n```\n$ ade uninstall ansible.scm\nINFO Found collection name: ansible.scm from /home/bthornto/github/ansible.scm/galaxy.yml.\nINFO Requirements file /home/bthornto/github/ansible.scm/requirements.txt is empty, skipping\nINFO Uninstalling python requirements from /home/bthornto/github/ansible.scm/test-requirements.txt\nINFO Removed ansible.utils: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections/ansible/utils\nINFO Removed ansible.utils*.info: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections/ansible.utils-2.10.3.info\nINFO Removed ansible.scm: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections/ansible/scm\nINFO Removed collection namespace root: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections/ansible\nINFO Removed collection root: /home/bthornto/github/ansible.scm/venv/lib64/python3.11/site-packages/ansible_collections\n```\n\n## Help\n\n`ade --help`\n\n`ade install --help`\n\n`ade uninstall --help`\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "A pip-like ansible collection installer.",
"version": "24.12.0",
"project_urls": {
"changelog": "https://github.com/ansible/ansible-dev-environment/releases",
"documentation": "https://ansible.readthedocs.io/projects/dev-environment/",
"homepage": "https://github.com/ansible/ansible-dev-environment",
"repository": "https://github.com/ansible/ansible-dev-environment"
},
"split_keywords": [
"ansible"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1c185e394e04a7a1187e75ec99bd36cb5178fd0a0add4a234b3d20f56f9cc63b",
"md5": "784ce9c77f608014ba7c7a11afaceb1c",
"sha256": "be135ba96acfecfb9cdf62aa38fd5fa9c5cef7593c29fea7408359fc8a43400c"
},
"downloads": -1,
"filename": "ansible_dev_environment-24.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "784ce9c77f608014ba7c7a11afaceb1c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 44608,
"upload_time": "2024-12-12T05:27:18",
"upload_time_iso_8601": "2024-12-12T05:27:18.300195Z",
"url": "https://files.pythonhosted.org/packages/1c/18/5e394e04a7a1187e75ec99bd36cb5178fd0a0add4a234b3d20f56f9cc63b/ansible_dev_environment-24.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37fbabfe9e73f575deb44a266de220ff0c9ba4c12dac8e875e395f49ab17320e",
"md5": "0d9420356e05935363be53663268fd60",
"sha256": "1a6169486c2f2c3a450b52518a7356ae026443460cf32bbd7ee1fce02befd596"
},
"downloads": -1,
"filename": "ansible_dev_environment-24.12.0.tar.gz",
"has_sig": false,
"md5_digest": "0d9420356e05935363be53663268fd60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 68991,
"upload_time": "2024-12-12T05:27:21",
"upload_time_iso_8601": "2024-12-12T05:27:21.006987Z",
"url": "https://files.pythonhosted.org/packages/37/fb/abfe9e73f575deb44a266de220ff0c9ba4c12dac8e875e395f49ab17320e/ansible_dev_environment-24.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 05:27:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansible",
"github_project": "ansible-dev-environment",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ansible-dev-environment"
}
