django-ask-sdk 1.0.0

The Django ASK SDK package provides support for using ASK SDK and Django, to deploy custom skills as webservice

Django ASK SDK - Extending ASK SDK to work with Django

django-ask-sdk is the extension package, that will let skill developers use ASK SDK package in their Django application. It provides an easy way to register and use skills as custom webservices.

Quick Start

If you already have a skill built using the ASK SDK skill builders, then you only need to do the following, to set this up in your django app (example_app):

example_app/my_skill.py

from ask_sdk_core.skill_builder import SkillBuilder
from ask_sdk_core.handler_input import HandlerInput
from ask_sdk_core.dispatch_components import AbstractRequestHandler
from ask_sdk_core.utils import is_request_type
from ask_sdk_model import Response

sb = SkillBuilder()

class LaunchRequestHandler(AbstractRequestHandler):
    """Handler for skill launch."""
    def can_handle(self, handler_input):
        # type: (HandlerInput) -> bool
        return is_request_type("LaunchRequest")(handler_input)

    def handle(self, handler_input):
        # type: (HandlerInput) -> Response
        speech = "Hello"
        handler_input.response_builder.speak(speech)
        return handler_input.response_builder.response

# Other skill components here ....

# Register all handlers, interceptors etc.
# For eg : sb.add_request_handler(LaunchRequestHandler())

skill = sb.create()

example_app/urls.py

from .my_skill import skill
from django_ask_sdk.skill_adapter import SkillAdapter

my_skill_view = SkillAdapter.as_view(
    skill=skill)

urlpatterns = [
    path('/', my_skill_view, name='index'),
]

Are you planning to deploy your skill on AWS Lambda? Then, you don’t even need this package. The ASK SDK provides a lambda_handler that can be directly used in your lambda console.

More code examples can be found here.

Features

• Works as an extension on skills built using ASK SDK. No need to learn something new.

• Provides default request signature and request timestamp verification. These can be configured on app level by setting / unsetting default parameters on the view.

• Provides a way to register multiple skills on your app, at different endpoints.

Installation

Note

This package is compatible only with Python >= 3.6, since it required Django >= 2.0 which is only Python3 compatible.

Important

cryptography is a dependency for this package. If you have not already installed cryptography, you might need to install additional prerequisites as detailed in the cryptography installation guide for your operating system.

Assuming that you have Python and virtualenv installed, you can install the package and it’s dependencies (ask-sdk-webservice-support) from PyPi as follows:

$ virtualenv venv
$ . venv/bin/activate
$ pip install django-ask-sdk

This package is not installed along-side ask-sdk standard distribution, and has to be installed separately if you need support for skill deployment as webservice, using Django.

SDK Usage and Getting Started

Getting started guides, SDK Features, API references, samples etc. can be found in the technical documentation

Got Feedback?

• We would like to hear about your bugs, feature requests, questions or quick feedback. Please search for the existing issues before opening a new one. It would also be helpful if you follow the templates for issue and pull request creation. Please follow the contributing guidelines!!

• Request and vote for Alexa features!

CHANGELOG

0.1

• Initial release of Django ASK SDK extension package.

0.1.1

This release contains the following changes :

• Fix setting the custom user agent on the skill instance, when initializing the handler.

1.0.0

This release contains the following changes :

• Move the webservice adapters to GA.