smoke-zephyr
============

Python utility collection

|Documentation Status| |Github Issues| |PyPi Release|

**Version 2.0** -- From version 2.0 onwards, Python 2.7 is no longer supported.
For Python 2.7 support, use the latest 1.x version (`v1.4.1`_).

License
-------

smoke-zephyr is released under the BSD 3-clause license, for more details see
the `LICENSE`_ file.

Supported Versions
------------------

The following version of Python are currently supported:

- Python 3.4
- Python 3.5
- Python 3.6
- Python 3.7

Code Documentation
------------------

smoke-zephyr uses Sphinx for internal code documentation. This documentation can
be generated from source with the command
``sphinx-build docs/source docs/html``. The latest documentation is
kindly hosted on `ReadTheDocs`_ at `smoke-zephyr.readthedocs.io`_.

.. _LICENSE: https://github.com/zeroSteiner/smoke-zephyr/blob/master/LICENSE
.. _ReadTheDocs: https://readthedocs.org/
.. _smoke-zephyr.readthedocs.io: https://smoke-zephyr.readthedocs.io/en/latest/
.. _v1.4.1: https://github.com/zeroSteiner/smoke-zephyr/releases/tag/v1.4.1
.. |Documentation Status| image:: https://readthedocs.org/projects/smoke-zephyr/badge/?version=latest&style=flat-square
   :target: http://smoke-zephyr.readthedocs.io/en/latest
.. |Github Issues| image:: http://img.shields.io/github/issues/zerosteiner/smoke-zephyr.svg?style=flat-square
   :target: https://github.com/zerosteiner/smoke-zephyr/issues
.. |PyPi Release| image:: https://img.shields.io/pypi/v/smoke-zephyr.svg?style=flat-square
   :target: https://pypi.python.org/pypi/smoke-zephyr