/alexa-client

Python client for Amazon Alexa Voice Service (AVS). http://ewenchou.github.io/blog/2016/03/20/alexa-voice-service/

Primary LanguagePythonApache License 2.0Apache-2.0

Alexa Client

Python client for Amazon's Alexa Voice Service (AVS).

Prerequisites

Amazon Developer Account

In order to use Alexa Voice Service you will need to signup for an Amazon Developer account. You can read about it on my blog post and get the details from Amazon's Getting Started Guide.

In order to access Alexa Voice Service, you will also need to make an Authorization Code Grant request to get a refresh token. This is detailed in Amazon's guide.

See the Authorization Code Grant section below for an example of how to do this.

Installation

  1. Clone this repository

    git clone https://github.com/ewenchou/alexa-client.git
    
  2. Configure settings. Set the PRODUCT_ID, CLIENT_ID, CLIENT_SECRET, and REFRESH_TOKEN values in alexa_client/settings.py.

    Note: If you do not have a refresh token, see the Authorization Code Grant section below for an example of how to get one.

  3. Install requirements

    pip install -r requirements.txt
    
  4. Install alexa_client

    python setup.py install
    

Authorization Code Grant

The Python script, auth_web.py is included in this repository to make it easier to request an Authorization Code Grant as detailed in Amazon's guide.

NOTE: The auth_web.py script is taken and modified from the respeaker/Alexa Github repository.

You should have followed Amazon's Getting Started Guide and created a developer account as well as a new Alexa Voice Service device with a Security Profile.

You should now have the following values and they should be saved in alexa_client/settings.py:

  • Device Type ID
  • Client ID
  • Client Secret

In order to authorize a client, you will also need to configure the Web Settings tab of the Security Profile of your device.

  1. Log into the Amazon Developer Portal and navigate to the Alexa Voice Service section. Click on the device you created in the list.

  2. Click on Security Profile on the left menu.

  3. Click on the Web Settings tab

  4. Click on the Edit button and add the following:

    • Allowed Origins: http://localhost:3000/
    • Allowed Return URLs: http://localhost:3000/authresponse
  5. Click the Save button to save the settings.

Install the requirements for auth_web.py:

    sudo pip install -r auth_web_requirements.txt

Now you can run the auth_web.py script.

  1. Run the script: python auth_web.py
  2. Open a web browser and go to http://localhost:3000
  3. You should be redirected to an Amazon Login page. Enter your username and password and login.
  4. You should now see a simple page that says Success! and the refresh token value.
  5. Copy the refresh token value and set it in alexa_client/settings.py

Tests

Some sample tests are available in the test directory. Once installed and configured, you can run them to check if everything is working.

  • Test a single request: python test/test_ask.py

  • Test multiple concurrent requests: python test/test_multiple.py