Metadata-Version: 2.4
Name: suitable
Version: 0.23.0
Summary: Suitable is a thin wrapper around the Ansible API.
Author-email: Denis Krienbühl <denis@href.ch>
Maintainer-email: Seantis GmbH <info@seantis.ch>
License-Expression: GPL-3.0-only
Project-URL: Repository, http://github.com/seantis/suitable/
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: ansible>=9
Requires-Dist: ansible-core>=2.16
Requires-Dist: packaging
Dynamic: license-file

.. image:: https://seantis.github.io/suitable/_static/logo.svg
    :alt: Suitable
    :width: 50%
    :align: center

An Ansible API for humans.

Documentation
-------------

`<https://seantis.github.io/suitable/>`_

Quick Start
-------------

Suitable provides a simple wrapper over Ansible's internal API, that allows you to use Ansible programmatically.

.. code-block:: pycon

    >>> from suitable import Api
    >>> api = Api('localhost')
    >>> api.command('whoami').stdout()
    'myuser'

Warning
-------

Suitable is not endorsed by Ansible and it is not affilated with it. Use at
your own peril.

The official way to use Ansible from Python is documented here:
`<http://docs.ansible.com/ansible/developing_api.html>`_

Compatibility
-------------

* Python 3.10+
* Ansible 9+
* Mitogen 0.3.7+

Support for older releases is kept only if possible. New Ansible releases
are favored over old ones.

Run Tests
---------

.. code-block:: console

    pip install tox
    tox

Build Status
------------

.. image:: https://github.com/seantis/suitable/actions/workflows/python-tox.yaml/badge.svg
    :target: https://github.com/seantis/suitable/actions
    :alt:    Tests

Test Coverage
-------------

.. image:: https://codecov.io/github/seantis/suitable/coverage.svg?branch=master
    :target: https://codecov.io/github/seantis/suitable?branch=master
    :alt: Test coverage

Latest Release
--------------

.. image:: https://badge.fury.io/py/suitable.svg
    :target: https://badge.fury.io/py/suitable
    :alt: Latest release
