Metadata-Version: 2.1
Name: snipskit
Version: 0.2.0
Summary: A library to help create apps for the voice assistant Snips
Home-page: https://github.com/koenvervloesem/snipskit
Author: Koen Vervloesem
Author-email: koen@vervloesem.eu
License: MIT
Description: ########
        SnipsKit
        ########
        
        .. image:: https://api.travis-ci.com/koenvervloesem/snipskit.svg?branch=master
           :target: https://travis-ci.com/koenvervloesem/snipskit
           :alt: Build status
        
        .. image:: https://api.codeclimate.com/v1/badges/46806611ac7c0e5c1613/maintainability
           :target: https://codeclimate.com/github/koenvervloesem/snipskit/maintainability
           :alt: Maintainability
        
        .. image:: https://api.codeclimate.com/v1/badges/46806611ac7c0e5c1613/test_coverage
           :target: https://codeclimate.com/github/koenvervloesem/snipskit/test_coverage
           :alt: Test coverage
        
        .. image:: https://api.codacy.com/project/badge/Grade/10e65e471a044d2e9ea0b171626a3333
           :target: https://www.codacy.com/app/koenvervloesem/snipskit
           :alt: Code quality
        
        .. image:: https://readthedocs.org/projects/snipskit/badge/?version=latest
           :target: https://snipskit.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation status
        
        .. image:: https://img.shields.io/pypi/v/snipskit.svg
           :target: https://pypi.python.org/pypi/snipskit
           :alt: PyPI package version
        
        .. image:: https://img.shields.io/pypi/pyversions/snipskit.svg
           :target: https://pypi.python.org/pypi/snipskit
           :alt: Supported Python versions
        
        .. image:: https://img.shields.io/github/license/koenvervloesem/snipskit.svg
           :target: https://github.com/koenvervloesem/snipskit/blob/master/LICENSE
           :alt: License
        
        .. inclusion-marker-start-intro
        
        SnipsKit is a Python library with some helper tools to work with the voice assistant Snips_. This can be used by Snips apps or other programs that work with Snips.
        
        .. _Snips: https://snips.ai/
        
        With SnipsKit, you can create Snips apps without having to write much boilerplate code. The simplest example of an app using SnipsKit is the following:
        
        .. code-block:: python
        
            from snipskit.apps import HermesSnipsApp
            from snipskit.decorators.hermes import intent
        
            class SimpleSnipsApp(HermesSnipsApp):
        
                @intent('User:ExampleIntent')
                def example_intent(self, hermes, intent_message):
                    hermes.publish_end_session(intent_message.session_id,
                                               "I received ExampleIntent")
        
            if __name__ == "__main__":
                SimpleSnipsApp()
        
        And that's it! No need to connect to an MQTT broker, no need to register callbacks, because the HermesSnipsApp class:
        
        - reads the MQTT connection settings from the snips.toml file;
        - connects to the MQTT broker;
        - registers the method with the @intent decorator as a callback method for the intent 'User:ExampleIntent';
        - starts the event loop.
        
        SnipsKit also has decorators for other events, and there's also a class MQTTSnipsApp to listen to MQTT topics directly. Moreover, SnipsKit also gives the app easy access to:
        
        - the Snips configuration;
        - the Hermes or MQTT connection object;
        - the assistant's configuration;
        - the app's configuration.
        
        .. warning:: SnipsKit is currently alpha software. Anything may change at any time. The public API should not be considered stable.
        
        .. inclusion-marker-end-intro
        
        *******************
        System requirements
        *******************
        
        .. inclusion-marker-start-requirements
        
        SnipsKit is a Python 3-only library, requiring Python 3.5 or higher. It's currently tested on Python 3.5 and Python 3.6.
        
        .. inclusion-marker-end-requirements
        
        ************
        Installation
        ************
        
        .. inclusion-marker-start-installation
        
        SnipsKit can be installed with the following command:
        
        .. code-block:: sh
        
            pip install snipskit
        
        .. inclusion-marker-end-installation
        
        *************
        Documentation
        *************
        
        The `full documentation`_ can be found on Read the Docs.
        
        .. _`full documentation`: https://snipskit.readthedocs.io
        
        *********
        Copyright
        *********
        
        This library is provided by `Koen Vervloesem`_ as open source software. See LICENSE_ for more information.
        
        .. _`Koen Vervloesem`: mailto:koen@vervloesem.eu
        
        .. _LICENSE: LICENSE
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/x-rst
