Skip to main content

Snips Skills Manager

Project description

Build Status PyPI MIT License

The Snips Skills Manager is a tool for easily setting up and managing a Snips assistant.

A single configuration file, the Snipsfile, is required to create a Snips assistant. In it, you specify:

  • The URL of your assistant, as created in the Snips Console

  • The skills you want to install

  • Bindings between intents and skills

  • If required, additional parameters for you skill, such as an API key or the address of a lamp

  • Various configuration parameters, such as language and logging preferences.

Check out Awesome Snips, a curated list of Snips skills, assistants and other resources to get you started. In particular, make sure to read the Getting Started guide.

Installation

The Snips Skills Manager is on PyPI, so you can just install it with pip:

$ pip install snipsskills

Note: you may need to install pip, python-dev and pyaudio and pygame on your system beforehand. On Raspberry, this can be done via apt-get:

$ sudo apt-get update
$ sudo apt-get install python-pip
$ sudo apt-get install libsdl-mixer1.2 libusb-1.0 python-pyaudio libsdl1.2-dev cython libudev-dev

Usage

Start your project by creating a Snipsfile, which is where all the configuration is set. This is a simple text file, adhering to the YAML format. Here is a basic configuration:

assistant: SNIPS_ASSISTANT_URL
locale: en_US
logging: True
default_location: Paris,fr
skills:
  - package_name: snipshue
    class_name: SnipsHue
    pip: snipshue=0.1.2
    params:
      hostname: PHILIPS_HUE_IP
      username: PHILIPS_HUE_USERNAME
      light_ids: [1, 2, 3, 4, 5, 6]
    intents:
      - intent: DeactivateObject
        action: "turn_off"
      - intent: ActivateLightColor
        action: "turn_on"

For further explanations and examples, check out our Snipsfile Wiki.

Next, setup the system by running the install command:

$ snipsskills install

Note: make sure that the snipsskills is found in your $PATH. If the above does not work, add the following to your ~/.bashrc or equivalent:

$ export PATH=$PATH:~/.local/bin

You may need to restart your device. We are now ready to start the service, using the run command:

$ snipsskills run

Troubleshooting

On OSX, you might need to install SDL:

$ brew install sdl

The Snips Skills Manager is based on Python 3. To install it on a Raspberry, run:

$ sudo apt-get install python3

Also, pip3 is used for dependency management. On Raspberry, the following might be needed:

$ sudo apt-get remove python3-pip; sudo apt-get install python3-pip
$ sudo apt-get remove python-setuptools
$ wget https://bootstrap.pypa.io/get-pip.py
$ sudo python ./get-pip.py
$ sudo pip install -U pip setuptools

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

snipsskills-0.1.4.834-py2.py3-none-any.whl (692.2 kB view hashes)

Uploaded Python 2 Python 3

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