README.rst
===============================
fedmsg-ansible
===============================


.. .. image:: https://img.shields.io/pypi/v/fedmsg_ansible.svg
..         :target: https://pypi.python.org/pypi/fedmsg_ansible
..
.. .. image:: https://img.shields.io/travis/maxamillion/fedmsg_ansible.svg
..         :target: https://travis-ci.org/maxamillion/fedmsg_ansible
..
.. .. image:: https://readthedocs.org/projects/fedmsg-ansible/badge/?version=latest
..         :target: https://fedmsg-ansible.readthedocs.io/en/latest/?badge=latest
..         :alt: Documentation Status
..
.. .. image:: https://pyup.io/repos/github/maxamillion/fedmsg_ansible/shield.svg
..      :target: https://pyup.io/repos/github/maxamillion/fedmsg_ansible/
..      :alt: Updates


NOTE: This is considered Demo or Proof of Concept Quality at this time
======================================================================

ALL OF THIS IS SUBJECT TO CHANGE, IT'S BEING ACTIVELY DEVELOPED/DESIGNED.
Please see the ``poc`` directory for current working idea/implementation.

Utility and Python API to execute Ansible Playbooks based on fedmsg data.


* Free software: GNU General Public License v3
* Documentation: https://fedmsg-ansible.readthedocs.io. (TODO)

Design
------

Messages are sent over `fedmsg`_, fedmsg-ansible will listen to them and then
dispatch `Ansible`_ `playbooks`_ with variable data injected into them from the
fedmsg payload.

`Ansible`_ playbooks are named after the `fedmsg topic`_ that will trigger them,
for example the fedmsg topic ``org.fedoraproject.prod.copr.build.start`` would
trigger a playbook named ``org.fedoraproject.prod.copr.build.start.yml``.


Features
--------

* TODO

Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _fedmsg: http://www.fedmsg.com/en/latest/
.. _Ansible: https://github.com/ansible/ansible
.. _playbooks: http://docs.ansible.com/ansible/playbooks.html