.. htmlPy documentation master file, created by
   sphinx-quickstart on Thu Aug 20 03:04:59 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to htmlPy's documentation!
==================================


.. image:: https://img.shields.io/travis/amol-mandhane/htmlPy/master.svg
   :target: https://travis-ci.org/amol-mandhane/htmlPy

.. image:: https://img.shields.io/pypi/v/htmlPy.svg
   :target: https://pypi.python.org/pypi/htmlPy/

.. image:: https://img.shields.io/pypi/dm/htmlPy.svg
   :target: https://pypi.python.org/pypi/htmlPy/

**HTML5-CSS3-Javascript based GUI libary in Python**

htmlPy is a wrapper around `PySide <http://pyside.org/>`_'s QtWebKit library. It helps with creating beautiful GUIs using **HTML5, CSS3 and Javascript** for standalone Python applications. It is built on `Qt <http://qt.io/>`_ which makes it highly **customizable and cross-platform**. htmlPy is compatible with both **Python2 and Python3**. It can be used with any python library or environment like `django <https://www.djangoproject.com/>`_, `flask <http://flask.pocoo.org/>`_, `scipy <http://www.scipy.org/>`_, `virtualenv <http://virtualenv.readthedocs.org/>`_ etc. You can use front-end libraries and frameworks like `bootstrap <http://getbootstrap.com/>`_, `jQuery <http://jquery.com/>`_, `jQuery UI <http://jqueryui.com/>`_ etc. and create GUIs for your applications in no time.

To start using htmlPy, please read :doc:`installation instructions <installation>`.

You can get the source at `GitHub repository <https://github.com/amol-mandhane/htmlPy>`_. Versions older than 2.0.0 are not recommended for use in production.

Contents:

.. toctree::
   :maxdepth: 2

   installation
   quickstart
   important
   tutorials
   reference


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

