A library to ease creation of an Alexa Skills Kit
Project description
# `pylexa`
*NOTE: This library is NOT ready for production use yet!*
`pylexa` is a library that aims to ease development of an [Alexa Skills Kits](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit).
`pylexa` allows one to define a simple Flask application that will be able to accept requests and return appropriate responses to the Alexa service.
## Example
Let's say you want to define an Alexa Skill that echoes whatever the user says. So far, you've:
* created a skill in the [Amazon Developer Console](https://developer.amazon.com/edw/home.html#/skills/list)
* Added a `Echo` intent with a single slot, `message`:
```javascript
{
"intent": "Echo",
"slots": [
{
"name": "message",
"type": "AMAZON.LITERAL"
}
]
}
```
* Added an utterance to allow users to interact with the skill:
`Echo echo { something | message }`
Now, you're ready to create a server that will accept the request and return a response echoing the input. Using `pylexa`, we'd need only the following code to accomplish this:
```python
from flask import Flask
from pylexa.app import alexa_blueprint
from pylexa.intent import handle_intent
from pylexa.response import AlexaResponseWrapper, PlainTextSpeech
app = Flask(__name__)
app.register_blueprint(alexa_blueprint)
app.response_class = AlexaResponseWrapper
@handle_intent('Echo')
def handle_echo_intent(request):
return PlainTextSpeech(request.slots.get('message', 'Nothing to echo'))
```
And that's it! You can push the above code, configure the skill to point to the server running the `flask` app and use the service simulator to test your skill.
## Testing
After installing requirements with `pip install -r requirements.pip`, tests can be run with `nosetests`.
*NOTE: This library is NOT ready for production use yet!*
`pylexa` is a library that aims to ease development of an [Alexa Skills Kits](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit).
`pylexa` allows one to define a simple Flask application that will be able to accept requests and return appropriate responses to the Alexa service.
## Example
Let's say you want to define an Alexa Skill that echoes whatever the user says. So far, you've:
* created a skill in the [Amazon Developer Console](https://developer.amazon.com/edw/home.html#/skills/list)
* Added a `Echo` intent with a single slot, `message`:
```javascript
{
"intent": "Echo",
"slots": [
{
"name": "message",
"type": "AMAZON.LITERAL"
}
]
}
```
* Added an utterance to allow users to interact with the skill:
`Echo echo { something | message }`
Now, you're ready to create a server that will accept the request and return a response echoing the input. Using `pylexa`, we'd need only the following code to accomplish this:
```python
from flask import Flask
from pylexa.app import alexa_blueprint
from pylexa.intent import handle_intent
from pylexa.response import AlexaResponseWrapper, PlainTextSpeech
app = Flask(__name__)
app.register_blueprint(alexa_blueprint)
app.response_class = AlexaResponseWrapper
@handle_intent('Echo')
def handle_echo_intent(request):
return PlainTextSpeech(request.slots.get('message', 'Nothing to echo'))
```
And that's it! You can push the above code, configure the skill to point to the server running the `flask` app and use the service simulator to test your skill.
## Testing
After installing requirements with `pip install -r requirements.pip`, tests can be run with `nosetests`.
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
File details
Details for the file pylexa-0.0.8-py2-none-any.whl
.
File metadata
- Download URL: pylexa-0.0.8-py2-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6145c1392f01ade79f665ea87a20523be7a8489b4969eba008ef0040f7111617 |
|
MD5 | ebda7fc5ac5500a783ef7d8e21aa7633 |
|
BLAKE2b-256 | 65324736ed2d85e55d830d2ddd900d2c31101c6f661c8d3113a124b50f90edb9 |