Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
105 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
skillful | ||
======== | ||
|
||
|PyPIVersion| |BuildStatus| |Coverage| | ||
|
||
*A Python package for building Amazon Alexa skills.* | ||
|
||
Features | ||
-------- | ||
|
||
- Request and response objects for `custom | ||
skills <https://goo.gl/JpVGm4>`__ | ||
- Simple definition of response logic for each request type | ||
- Built-in request parsing/validation, intent dispatch, and response | ||
construction | ||
|
||
Installation | ||
------------ | ||
|
||
:: | ||
|
||
pip install skillful | ||
|
||
Example | ||
------- | ||
|
||
:: | ||
|
||
import skillful | ||
from skillful.tests import data | ||
|
||
application_id = 'amzn1.echo-sdk-ams.app.000000-d0ed-0000-ad00-000000d00ebe' | ||
skill = skillful.Skill(application_id) | ||
|
||
@skill.launch | ||
def on_launch(): | ||
print('Launched: {}'.format(skill.request.session.session_id)) | ||
text = 'Welcome to skillful. Would you like to build an Alexa skill?' | ||
skill.response.set_speech_text(text) | ||
ssml = ('<speak>Please tell me if you would like to build an Alexa ' | ||
'skill.</speak>') | ||
skill.response.set_reprompt_ssml(ssml) | ||
|
||
@skill.intent('yes') | ||
def on_intent_yes(): | ||
text = ('Great! Building Alexa skills is easy with skillful. Open ' | ||
'the Alexa app to see more information on skillful, a ' | ||
'Python package for building Alexa skills.') | ||
skill.response.set_speech_text(text) | ||
title = 'skillful' | ||
content = ('A Python package for building Alexa skills.\n\n' | ||
'Visit: https://github.com/bmweiner/skillful') | ||
skill.response.set_card_simple(title, content) | ||
skill.terminate() | ||
|
||
@skill.intent('no') | ||
def on_intent_no(): | ||
text = ('Well, if you change your mind, open the Alexa app to see ' | ||
'more information on skillful, a Python package for ' | ||
'building Alexa skills.') | ||
skill.response.set_speech_text(text) | ||
title = 'skillful' | ||
content = ('A Python package for building Alexa skills.\n\n' | ||
'Visit: https://github.com/bmweiner/skillful') | ||
skill.response.set_card_simple(title, content) | ||
skill.terminate() | ||
|
||
@skill.session_ended | ||
def on_session_ended(): | ||
print('Ended: {}'.format(skill.request.session.session_id)) | ||
skill.terminate() | ||
|
||
# simulate request body | ||
body = data.SAMPLE_LAUNCH_REQUEST | ||
skill.process(body) | ||
|
||
Output: | ||
|
||
:: | ||
|
||
Launched: amzn1.echo-api.session.0000000-0000-0000-0000-00000000000 | ||
|
||
{ | ||
"version": "1.0", | ||
"response": { | ||
"outputSpeech": { | ||
"text": "Welcome to skillful. Would you like to build an Alexa skill?", | ||
"type": "PlainText" | ||
}, | ||
"shouldEndSession": false, | ||
"reprompt": { | ||
"outputSpeech": { | ||
"ssml": "<speak>Please tell me if you would like to build an Alexa skill.</speak>", | ||
"type": "SSML" | ||
} | ||
} | ||
} | ||
} | ||
|
||
.. |PyPIVersion| image:: https://img.shields.io/pypi/v/skillful.svg | ||
:target: https://pypi.python.org/pypi/skillful | ||
.. |BuildStatus| image:: https://travis-ci.org/bmweiner/skillful.svg?branch=master | ||
:target: https://travis-ci.org/bmweiner/skillful | ||
.. |Coverage| image:: https://coveralls.io/repos/github/bmweiner/skillful/badge.svg?branch=master | ||
:target: https://coveralls.io/github/bmweiner/skillful?branch=master |