Skip to main content

Alexa Browser Client

code-climate-image circle-ci-image [[codecov-image]][codecov]

Alexa client in your browser. Django app. Talk to Alexa from your desktop, phone, or tablet browser.


Demo

The demo should really be heard, so click the gif below to view it in youtube.

Demo

Dependencies

This project depends on: - django-channels. - Snowboy

Install and configure those first.

Snowboy

Snowboy detects when the wakeword “Alexa” is uttered.

You must compile Snowboy manually. Copy the compiled snowboy folder to the top level of you project. By default, the folder structure should be:

.
├── ...
├── snowboy
|   ├── snowboy-detect-swig.cc
|   ├── snowboydetect.py
|   └── resources
|       ├── alexa.umdl
|       └── common.res
└── ...

If the default folder structure does not suit your needs you can customize the wakeword detector.

Installation

pip install alexa_browser_client

Make sure your settings INSTALLED_APPS contains at least these entries:

INSTALLED_APPS = [
    'django.contrib.contenttypes',
    'django.contrib.auth',
    'django.contrib.sessions',
    'channels',
    'alexa_browser_client',
]

Routing and urls

Add url(r'^', include('alexa_browser_client.config.urls')), to urls.py url_patterns.

Add include('alexa_browser_client.config.routing.channel_routing') to your routing.py channel_routing.

Authentication

This app uses Alexa Voice Service. To use AVS you must first have a developer account. Then register your product here. Choose “Application” under “Is your product an app or a device”?

Ensure you update your settings.py:

Setting

Notes

ALEXA_BROWSER_CLIENT_AVS_CLIENT_I D

Retrieve by clicking on the your product listed here

ALEXA_BROWSER_CLIENT_AVS_CLIENT_S ECRET

Retrieve by clicking on the your product listed here

ALEXA_BROWSER_CLIENT_AVS_DEVICE_T YPE_ID

Retrieve by reading “Product ID” here

Refresh token

You will need to login to Amazon via a web browser to get your refresh token.

To enable this first go here and click on your product to set some security settings under Security Profile and, assuming you’re running on localhost:8000, set the following:

setting

value

Allowed Origins

https://localhost:8000/refreshtoken/

Allowed Return URLs

https://localhost:8000/refreshtoken/callback/

Usage

Once you have all the settings configured:

  • Run django: ./manage.py runserver

  • Go to http://localhost:8000 and start talking to Alexa.

Customization

Wakeword

The default wakeword is “Alexa”. You can change this by customizing the lifecycle’s audio_detector_class:

# my_project/consumers.py

import alexa_browser_client
import command_lifecycle


class CustomAudioDetector(command_lifecycle.wakeword.SnowboyWakewordDetector):
    wakeword_library_import_path = 'dotted.import.path.to.wakeword.Detector'
    resource_file = b'path/to/resource_file.res'
    decoder_model = b'path/to/model_file.umdl'


class CustomAudioLifecycle(alexa_browser_client.AudioLifecycle):
    audio_detector_class = CustomAudioDetector


class CustomAlexaConsumer(alexa_browser_client.AlexaConsumer):
    audio_lifecycle_class = CustomAudioLifecycle

Then in your routes.py:

from my_project import consumers


channel_routing = [
    consumers.CustomAlexaConsumer.as_route(path='/'),
]

Unit test

To run the unit tests, call the following commands:

pip install -r requirements-dev.txt
./scripts/tests.sh

To test a specific file, call the following command:

./scripts/tests.sh /path/to/test-file.py

Versioning

We use SemVer for versioning. For the versions available, see the PyPI.

Other projects

This project uses Voice Command Lifecycle and Alexa Voice Service Client.

Metadata

Release files for alexa-browser-client 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for alexa-browser-client 2.0.1
File Interpreter ABI Platform Actions
alexa_browser_client-2.0.1-py3-none-any.whl Python 3 none any Details for alexa_browser_client-2.0.1-py3-none-any.whl

Release files / alexa_browser_client-2.0.1-py3-none-any.whl

Download URL alexa_browser_client-2.0.1-py3-none-any.whl
Size 13.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4a7981fb29768c18d9631a1235cf843a65994d5d30959b93e9bc405d90ca404b
BLAKE2b-256 checksum
How to use checksums
e2af27c5d18f069fbce1ebce15867ec6284cb5e5e2ed0280a575554ed9a140d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.9.1 pkginfo/1.4.1 requests/2.19.1 setuptools/36.3.0 requests-toolbelt/0.8.0 tqdm/4.15.0 CPython/3.5.2

Security for alexa-browser-client 2.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page