Metadata-Version: 2.0
Name: interactiveTutorial
Version: 0.1.1
Summary: 
Requires-Dist: fancytools (>=0.2.0)
Requires-Dist: fancywidgets (>=0.1.0)

An interactive tutorial viewer and editor based on PyQt4.

Home-page: http://pypi.python.org/pypi/interactiveTutorial/
Author: Karl Bedrich
Author-email: karl@bedrich.de
License: GPLv3
Description: ==================================================================
        *interactiveTutorial* - fast and easy interactive tutorials for Qt
        ==================================================================
        Based on `PyQt4 <http://www.riverbankcomputing.co.uk/software/pyqt/download>`_.
        
        - Browse the `API Documentation <http://radjkarl.github.io/interactiveTutorial>`_
        - Fork the code on `github <https://github.com/radjkarl/interactiveTutorial>`_
        
        
        .. image:: https://raw.githubusercontent.com/radjkarl/interactiveTutorial/master/interactiveTutorial_showcase.png
            :align: center
            :alt: showcase
        
        
        Installation
        ^^^^^^^^^^^^
        
        **interactiveTutorial** is listed in the Python Package Index. You can install it typing::
        
            pip install interactiveTutorial
        
        Scope
        ^^^^^
        
        Instead of a static PDF tutorial this package allows you to *run* and *create*
        tutorials within your PyQt4 based application. Tutorials are created through choosing
        a point of interest (POI), e.g. a widget, and typing an explaining text for each step.
        
        Usage
        ^^^^^
        
        **RunTutorial**
        
        * widget to execute a given tutorial
        
        **CreateTutorial**
        
        * widget to create and edit tutorials
        
        **TutorialMenu**
        
        * QMenu listing all created tutorials and allowing to run and edit them.
        * Embedd this one in your QMenuBar and you have all functionalities of **interactiveTutorial**
        
        Issues
        ^^^^^^
        
        * Instances of QMenu and QAction cannot be chosen as POI
        * QWidgets within QTreeWidgetItems are only marked on focus
        
        ... if you find more´, please let me know!
        
        
        Tests
        ^^^^^
        **interactiveTutorial** uses mostly the 'one class/function per module' rule. Running each module as program, like::
        
            python -m interactiveTutorial.TutorialMenu.TutorialMenu
        
        will execute the test case of this module.
        
        v0.1, <13/01/2015> -- Initial release.
        
        Karl Bedrich 2014 -
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
