Metadata-Version: 2.1
Name: ansible2puml
Version: 0.2.18
Summary: Create an PlantUML Activity Diagram from Playbooks or Roles trough Python.
Home-page: https://github.com/ProfileID/ansible2puml
Author: profileid
Author-email: profileid@protonmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: click
Requires-Dist: pyyaml
Requires-Dist: jinja2
Requires-Dist: plantuml
Requires-Dist: six

ansible2puml
============

|CI| |PyPI package| |PyPI download month| |PyPI pyversions| |PyPI
license|

About ansible2puml
------------------

Create an PlantUML activity diagram from playbooks (in future also
roles) trough python.

A .puml file with the PlantUML syntax is generated and a link to display
the diagram as PNG is generated.

Requirements
------------

Python version >3.6

Install package
---------------

Install via pypi

.. code:: bash

    pip install ansible2puml

Install via git

.. code:: bash

    pip install git+https://github.com/ProfileID/ansible2puml

How to
------

Playbook
~~~~~~~~

::

    ansible2puml --source play.yml --destination play.puml 

Example
-------

| |Example|
| **Source: `example-playbook.yml <./example/example-playbook.yml>`__**

.. |CI| image:: https://github.com/ProfileID/ansible2puml/workflows/CI/badge.svg
   :target: https://github.com/ProfileID/ansible2puml/actions?query=workflow%3ACI
.. |PyPI package| image:: https://img.shields.io/pypi/v/ansible2puml
   :target: https://pypi.python.org/pypi/ansible2puml/
.. |PyPI download month| image:: https://img.shields.io/pypi/dm/ansible2puml.svg
   :target: https://pypi.python.org/pypi/ansible2puml/
.. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/ansible2puml.svg
   :target: https://pypi.python.org/pypi/ansible2puml/
.. |PyPI license| image:: https://img.shields.io/pypi/l/ansible2puml.svg
   :target: https://pypi.python.org/pypi/ansible2puml/
.. |Example| image:: ./example/example-diagram.png
   :target: ./example/example-playbook.yml


