Skip to main content

A library to help create apps for the voice assistant Snips

Project description

Build status Maintainability Test coverage Code quality Documentation status PyPI package version Supported Python versions License

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.

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:

from snipskit.hermes.apps import HermesSnipsApp
from snipskit.hermes.decorators 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.

System requirements

SnipsKit is a Python 3-only library, requiring Python 3.5 or higher. It’s currently tested on Python 3.5, 3.6 and 3.7.

Installation

SnipsKit is packaged on PyPI. The latest stable version with all functionality can be installed with the following command:

pip install snipskit[hermes,mqtt]

Documentation

The full documentation can be found on Read the Docs, for both the stable version and the development version.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snipskit-0.5.4.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

snipskit-0.5.4-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file snipskit-0.5.4.tar.gz.

File metadata

  • Download URL: snipskit-0.5.4.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for snipskit-0.5.4.tar.gz
Algorithm Hash digest
SHA256 a09928f8e344c772699489a4010db82fbc94d2fe669df675e9fa3c55423fe270
MD5 340cf99cf3330b77671ae5ca65705acf
BLAKE2b-256 243a688aba9c5daa8ac81b22c3086a89d3e95351315ba383cf2d2b4021b0610b

See more details on using hashes here.

File details

Details for the file snipskit-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: snipskit-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for snipskit-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 76af598eb25bbb00e0f72179a2f113c34c348c78eeb470addc5a6071bbe8fd73
MD5 94f2fef5fbe5e68a764a995ef95aab5d
BLAKE2b-256 5956f9353cf654bf97d52e32306e59b76a4f161e3705672d0c44de82131507cb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page