Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arcward/echokit

Lightweight SDK for the Alexa Skills Kit
https://github.com/arcward/echokit

alexa alexa-skill alexa-skills-kit amazon-alexa amazon-alexa-skill amazon-echo amazon-lambda amazon-web-services aws aws-lambda lambda python python-3-6 python-library sdk skill

Last synced: 3 days ago
JSON representation

Lightweight SDK for the Alexa Skills Kit

Awesome Lists containing this project

README 

        
echokit 0.4

===========



A light(er)weight toolkit to create Alexa skills (Python 3.6)



Installation

------------



Requirements:



* Python 3.6 or newer



**From GitHub**:



Clone/download this repo and run this from the ``echokit/`` directory:



.. code-block:: bash



    python setup.py install



Getting Started

---------------



Sample skills can be found at https://github.com/arcward/echokit under

the *samples/* directory.



More comprehensive documentation can be found on ReadTheDocs_



Application ID/Handler

----------------------



When you're configuring your skill in the `Alexa developer console`_, you'll

be given an ID for your skill. This can be specified in EchoKit, as well

as whether it should verify incoming application IDs.



When you configure your Lambda function, you'll need to specify a handler

for incoming requests as well. To set these:



.. code-block:: python



    from echokit import EchoKit



    app = EchoKit("your_app_id")

    handler = app.handler



If, for example, your skill's module is ``sample.py``, then you would

define ``sample.handler`` as the handler in your Lambda function.



Handling Requests

-----------------



Responses to requests are created via :class:`echokit.response.Response`



There are three decorators to handle each basic request type, as well as

one to handle slots:



.. code-block:: python



    from echokit import EchoKit



    app = EchoKit("your_app_id")

    handler = app.handler



    # LaunchRequest

    @app.launch

    def on_launch(request, session):

        pass



    # SessionEndedRequest

    @app.session_ended

    def on_session_ended(request, session):

        pass



    # IntentRequest

    @app.intent("MyIntentName")

    def on_my_intent(request, session):

        pass



    # IntentRequest (with slots)

    @app.intent("MyIntentWithSlots")

    @app.slot("first_slot", "second_slot")

    def on_intent_with_slots(request, session, first_slot, second_slot):

        pass



Creating a ZIP file for upload to AWS Lambda

--------------------------------------------



EchoZip

--------

``echozip`` is a script included to help create ZIP deployment

packages. If you installed via *setup.py*, you can run it from the command

line (try ``echozip --help``).



Specify your top-level package directory. For example, if

your ``__init__.py`` is located at ``example/__init__.py`` you would

run ``echozip example``



This would create a ZIP file in your current directory, named like

*example_{YY-MM-DD-HHMMSS}.zip*. If you extract it again, you'll see that it

includes the full subtree of the directory you specified, with an

additional *echokit/* directory at the top level.



Manually

--------

Your ZIP file should be created from within your top-level package (don't

just zip the enclosing directory). You'll need to download/clone echokit

and include ``echokit/`` in in that same top-level directory. So if your

``__init__.py`` is in ``~/my_project/`` you should have ``~/my_project/echokit``.



See the `official docs`_ for more info.



.. _ReadTheDocs: http://echokit.readthedocs.io/en/latest/

.. _flask-ask: https://github.com/johnwheeler/flask-ask

.. _flask: https://github.com/pallets/flask

.. _zappa: https://github.com/Miserlou/Zappa

.. _handler: http://docs.aws.amazon.com/lambda/latest/dg/python-programming-model.html

.. _`Alexa developer console`: https://developer.amazon.com/alexa

.. _`three basic request types`: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/custom-standard-request-types-reference

.. _`official docs`: http://docs.aws.amazon.com/lambda/latest/dg/lambda-python-how-to-create-deployment-package.html