.. include:: shared.rst

.. _tools:

Tools
=====

This are the tools for the user using Photon.
You should not directly use them,
instead they will get provided to you by :ref:`photon`.

.. seealso:: |allcore|

Some functionality here is bought from the :ref:`util`:

.. seealso:: |allutil|


.. _tools_git:

Git Tool
--------

.. automodule:: photon.tools.git
    :members:
    :undoc-members:
    :private-members:


.. _tools_mail:

Mail Tool
---------

.. automodule:: photon.tools.mail
    :members:
    :undoc-members:
    :private-members:


.. _tools_mail_example:

Mail Tool Example
^^^^^^^^^^^^^^^^^

.. rubric:: mail.sample.yaml

.. literalinclude:: ../examples/mail.sample.yaml
    :linenos:
    :language: yaml

.. rubric:: mail.sample.py

.. literalinclude:: ../examples/mail.sample.py
    :linenos:
    :language: python3

.. seealso:: |allexamples|


.. _tools_ping:

Ping Tool
---------

.. automodule:: photon.tools.ping
    :members:
    :undoc-members:
    :private-members:


.. _tools_ping_example:

Ping Tool Example
^^^^^^^^^^^^^^^^^

.. rubric:: ping.sample.yaml

.. literalinclude:: ../examples/ping.sample.yaml
    :linenos:
    :language: yaml

.. rubric:: ping.sample.py

.. literalinclude:: ../examples/ping.sample.py
    :linenos:
    :language: python3

.. seealso:: |allexamples|


.. _tools_signal:

Signal Tool
-----------

.. automodule:: photon.tools.signal
    :members:
    :undoc-members:
    :private-members:


.. _tools_template:

Template Tool
-------------

.. automodule:: photon.tools.template
    :members:
    :undoc-members:
    :private-members: