Skip to content

Commit

Permalink
Remove unsupported API example
Browse files Browse the repository at this point in the history
* Python API example is unsupported and difficult to maintain with each
  new release.

Signed-off-by: Abhijeet Kasurde <[email protected]>
  • Loading branch information
Akasurde committed Sep 24, 2024
1 parent e16dbd3 commit 8c889c2
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 153 deletions.
24 changes: 1 addition & 23 deletions docs/docsite/rst/dev_guide/developing_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,11 @@ Python API

.. contents:: Topics

.. note:: This API is intended for internal Ansible use. Ansible may make changes to this API at any time that could break backward compatibility with older versions of the API. Because of this, external use is not supported by Ansible. If you want to use Python API only for executing playbooks or modules, consider `ansible-runner <https://ansible-runner.readthedocs.io/en/latest/>`_ first.

There are several ways to use Ansible from an API perspective. You can use
the Ansible Python API to control nodes, you can extend Ansible to respond to various Python events, you can
write plugins, and you can plug in inventory data from external data sources. This document
gives a basic overview and examples of the Ansible execution and playbook API.
.. attention:: The Ansible API is intended for internal Ansible use. Ansible may make changes to this API at any time that could break backward compatibility with older versions of the API. Because of this, external use is not supported by Ansible. If you want to use Python API only for executing playbooks or modules, consider `ansible-runner <https://ansible-runner.readthedocs.io/en/latest/>`_ first.

If you would like to use Ansible programmatically from a language other than Python, trigger events asynchronously,
or have access control and logging demands, please see the `AWX project <https://github.com/ansible/awx/>`_.

.. note:: Because Ansible relies on forking processes, this API is not thread safe.

.. _python_api_example:

Python API example
==================

This example is a simple demonstration that shows how to minimally run a couple of tasks:

.. literalinclude:: ../../../../examples/scripts/uptime.py
:language: python

.. note:: Ansible emits warnings and errors through the display object, which prints directly to stdout, stderr and the Ansible log.

The source code for the ``ansible``
command line tools (``lib/ansible/cli/``) is `available on GitHub <https://github.com/ansible/ansible/tree/devel/lib/ansible/cli>`_.

.. seealso::

:ref:`developing_inventory`
Expand Down
130 changes: 0 additions & 130 deletions examples/scripts/uptime.py

This file was deleted.

0 comments on commit 8c889c2

Please sign in to comment.