Metadata-Version: 1.0
Name: snipsskills
Version: 0.1.4.927
Summary: Snips Skills Manager
Home-page: https://github.com/snipsco/snipsskills
Author: Snips
Author-email: michael.fester@snips.ai
License: MIT
Description: Snips Skills Manager
        ====================
        
        |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 <https://github.com/michaelfester/awesome-snips/>`_, is required to create a Snips assistant. In it, you specify:
        
        - The URL of your assistant, as created in the `Snips Console <https://console.snips.ai>`_
        - The `skills <https://github.com/michaelfester/awesome-snips/>`_ 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 <https://github.com/michaelfester/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 <https://github.com/michaelfester/awesome-snips/>`_.
        
        Getting Started
        ===============
        
        Prerequisites
        -------------
        
        Raspbian
        ~~~~~~~~
        
        Depending on your setup, you may need to update pip, and install some packages via ``apt-get``.
        
        .. code-block:: console
        
            $ sudo apt-get update
            $ sudo apt-get install python-pip libsdl-mixer1.2 libusb-1.0 python-pyaudio libsdl1.2-dev cython cython3 libudev-dev python-dev libsdl-image1.2-dev libsdl-mixer1.2-dev libsdl-ttf2.0-dev libsmpeg-dev python-numpy libportmidi-dev libswscale-dev libavformat-dev libavcodec-dev portaudio19-dev -y
            $ pip install pip --upgrade
        
        macOS
        ~~~~~
        
        On macOS, pip can be installed via easy_install:
        
        .. code-block:: console
        
          $ sudo easy_install pip
        
        On macOS, the SDL library is required. It can be installed via Homebrew:
        
        .. code-block:: console
        
          $ brew install sdl
          $ pip install --global-option='build_ext' --global-option='-I/usr/local/include' --global-option='-L/usr/local/lib' pyaudio
        
        
        Installation
        ------------
        
        The Snips Skills Manager is on `PyPI <https://pypi.python.org/pypi/snipsskills>`_, so you can just install it with `pip <http://www.pip-installer.org>`_:
        
        .. code-block:: console
        
            $ pip install snipsskills
        
        A note on virtualenv
        ~~~~~~~~~~~~~~~~~~~~
        
        We suggest installing and running Snips Skills using a `virtualenv <https://virtualenv.pypa.io/en/latest/>`_ to avoid granting root privileges, and ensure your setup does not break when other packages are installed. Virtualenv should be enabled before installing the ``snipsskills`` pip package, can be installed and activated as follows:
        
        .. code-block:: console
        
          $ sudo pip install --upgrade virtualenv
          $ virtualenv --python=/usr/bin/python2.7 snips
          $ source snips/bin/activate
          $ pip install pip --upgrade
          $ pip install snipsskills
        
        To exit the virtualenv, simply run:
        
        .. code-block:: console
        
          $ deactivate
        
        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:
        
        .. code-block:: yaml
        
            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 <https://github.com/snipsco/snipsskills/wiki/The-Snipsfile>`_.
        
        Next, setup the system by running the ``install`` command:
        
        .. code-block:: console
        
            $ snipsskills install
        
        You may need to restart your device. We are now ready to start the service, using the ``run`` command:
        
        .. code-block:: console
        
            $ snipsskills run
        
        
        Copyright
        =========
        
        This skill is provided by `Snips <https://www.snips.ai>`_ as Open Source software. See `LICENSE.txt <https://github.com/snipsco/snips-skill-smartercoffee/blob/master/LICENSE.txt>`_ for more
        information.
        
        .. |Build Status| image:: https://travis-ci.org/snipsco/snipsskills.svg
           :target: https://travis-ci.org/snipsco/snipsskills
           :alt: Build Status
        .. |PyPI| image:: https://img.shields.io/pypi/v/snipsskills.svg
           :target: https://pypi.python.org/pypi/snipsskills
           :alt: PyPI
        .. |MIT License| image:: https://img.shields.io/badge/license-MIT-blue.svg
           :target: https://raw.githubusercontent.com/snipsco/snipsskills/master/LICENSE.txt
           :alt: MIT License
        
Keywords: cli,snips
Platform: UNKNOWN
