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.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.

System 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.

Installation

SnipsKit can be installed with the following command:

pip install snipskit

Documentation

The full documentation can be found on Read the Docs.

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.2.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

snipskit-0.2.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: snipskit-0.2.0.tar.gz
  • Upload date:
  • Size: 10.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/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for snipskit-0.2.0.tar.gz
Algorithm Hash digest
SHA256 bf6924210970526469afed605ebd121e372c382528f1e02c41353817c5714592
MD5 be049f1a3284118e230bf0cb2b4eafba
BLAKE2b-256 ec16e9f15b9876902e7d6b06c110b9e621965fe6384d481a4ff4898e31b4cf9c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: snipskit-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.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/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for snipskit-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c712e95e5d40b851a07b077c46d2afe67ec5e2e9100236bfee6d1525cec552fb
MD5 4e6b02bc93cb3f5013df1ff5459963e6
BLAKE2b-256 dd1a00f5767ed46f9c636d1fb62736645bbed5f16f15c85b1113373510163dcc

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