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

Uploaded Source

Built Distribution

snipskit-0.5.1-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: snipskit-0.5.1.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/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for snipskit-0.5.1.tar.gz
Algorithm Hash digest
SHA256 03a86168ed2137460c64fd5398b64705bcdf43eb289d207d82cf1d5a6fca2e9f
MD5 2b95361542008c982d5181751f7355ba
BLAKE2b-256 72c3a9e502bd97851d3cc69d4388da01f192284823b224b094d2a554971d70a9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: snipskit-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 20.1 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 53892c32a9fdf7b648ed3c1c7daa18eeabd4db4300868773d9f7a499ad6316ab
MD5 16e8134197cba0a9672db73ac2209b29
BLAKE2b-256 f013f101319b40ec3323641aec7095206a09c35fd65c9f72188de60c0b432924

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