Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ansible/ansible-sdk
The Ansible SDK
https://github.com/ansible/ansible-sdk
Last synced: about 2 months ago
JSON representation
The Ansible SDK
- Host: GitHub
- URL: https://github.com/ansible/ansible-sdk
- Owner: ansible
- License: apache-2.0
- Created: 2022-07-25T16:12:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-20T16:15:52.000Z (12 months ago)
- Last Synced: 2024-05-21T07:07:08.012Z (4 months ago)
- Language: Python
- Size: 107 KB
- Stars: 23
- Watchers: 13
- Forks: 14
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- License: LICENSE.md
Awesome Lists containing this project
README
Ansible SDK for Python
======================
The Ansible SDK provides a lightweight Python library for dispatching and live-monitoring
Ansible tasks, roles, and playbooks from the product or project.
Dispatching of jobs can be local to the machine you are running your python application from or over Ansible Mesh using the receptor integrations.
### [Demo application to show how you can use the SDK in real use case](https://github.com/ansible/ansible_sdk_demo)
## Documentation
We are building extensive documentation and API reference [here](https://ansible-sdk.readthedocs.io/en/latest/install.html).
Please feel free to contribute and help the documentation effort.
You can build the documentation from this repository as follows:
```
$ tox -e docs
$ firefox docs/build/html/
```
If you want to run Sphinx commands directly, open the `tox.ini` file and use the commands in the `[testenv:docs]` section.
Remember that you need to pip install `docs/doc-requirements.txt` before running Sphinx.
## Releases and maintenance
| Release | Status | Expected end of life |
| ------: | --------------------------: | -------------------: |
| 1 | Maintained | TBA |
## Ansible version compatibility
This library has been tested against following Ansible versions: **>=2.9.10**.
## Installation
You can follow the installation guide specified in [`docs`](https://github.com/ansible/ansible-sdk/tree/main/docs/source/install.rst).
### Required Python libraries and SDKs
The Ansible-SDK depends on Python 3.8+, Ansible Core, Ansible Runner and other third party libraries:
* [`ansible-core`](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)
* [`asyncio`](https://docs.python.org/3/library/asyncio.html)
* [`ansible-runner`](https://ansible-runner.readthedocs.io/en/stable/install/)
* [`receptorctl`](https://receptor.readthedocs.io/en/latest/#installation)
## Testing and Development
* Red Hat Enterprise Linux - Install Ansible-SDK and dependecies directly on/into a RHEL virtual machine.
* MacOS - Install [`podman`](https://github.com/containers/podman) using `brew`, and pull the RHEL8 image, ssh to that and follow the RHEL instructions above.
## Publishing a new version
This section assumes that you have configured the following git remotes for your local repository:
- `origin` tracks your GitHub fork.
- `upstream` tracks this repository.
### Prepare the release:
1. Make sure your fork is up to date with the `upstream` remote:
```
git checkout main && git pull origin main && git fetch upstream && git merge upstream/main
```
2. Create a release branch that follows the naming convention `prepare_$VERSION_release`:
```
git checkout -b prepare_$VERSION_release -t upstream/main
```
3. Run the following command to autogenerate `CHANGELOG.rst`:
```
towncrier build --yes --version $VERSION`
```
4. Push the created release branch `prepare_$VERSION_release` to your GitHub repo and open a PR for review.
### Push the release:
- Tag the release: `git tag -s $VERSION`
- Push the tag: `git push origin $VERSION`
## Communication
We welcome community contributions to this repo. If you find problems, please open an issue or create a PR against the [repo](https://github.com/ansible/ansible-sdk/issues/new).
You can also join us on:
- IRC - the ``#ansible-devel`` [irc.libera.chat](https://libera.chat/) channel
See the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) for details on contributing to Ansible.
## License
See [LICENSE](LICENSE.md) to see the full text.