Crypto Price is an Amazon Web Services (AWS) Lambda Function that pairs with the Alexa Skills Kit (ASK) to respond to an Amazon Echo user's request for the current price of any leading cryptocurrency (such as Bitcoin, Ethereum, Monero, Litecoin, etc.) in any world currency. By default the function will return the price in US Dollars, however, if a user specifies a currency it will return the price in that currency. Furthermore, if the user enables the app location permissions on their Alexa App it will return the price in the currency of their current country. Some typical questions and responses are as follows:
User: Alexa, tell me the price of Bitcoin from Crypto Price. (location disabled by the user)
Alexa: The current price of Bitcoin is 1,487.91 US dollars.
User: Alexa, open Crypto Price and tell me the price of Ethereum. (location enabled by the user and they live in the United Kingdom)
Alexa: The current price of Ethereum is 53.72 pounds.
User: Alexa, load Crypto Price.
Alexa: Welcome to Crypto Price. Please ask a question like: What is the price of Bitcoin?
User: Give me the price of Monero in yen.
Alexa: The current price of Monero is 3,070.75 yen.
User: Alexa, get help from Crypto Price.
Alexa: Crypto Price returns the price of the leading cryptocurrencies in any country's currency. You can ask questions like...
These instructions will you get a copy of the project up and running on your local machine for deployment and testing purpose. Please checkout the blogpost for full deployment details and how to integrate the app with the Alexa Skill Kit.
This app runs using Python 3.6.1. Please checkout www.python.org to install it on your own system. It is recommended to build the project in a contained virtual environment. This can be achieved with a combination of Virtualenv and the Virtualenv Wrapper which allows you to create and delete Virtualenvs easily.
The first step to installing the app is to clone the git repository:
$ git clone https://github.com/CraigLangford/Crypto-Price.gitIf you have virtualenv and virtualenvwrapper installed (See Prerequisites), create your Python 3.6 environment.
$ mkvirtualenv --python=python3.6 cryptopriceYou can set the root directory of the project as well so whenever you run workon cryptoprice you'll be in your virtualenv in your root folder immediately.
$ setvirtualenvprojectYou should now be in the root directory with Python 3.6.x as your Python version.
$ ls
cryptoprice.py data docs LICENSE README.md requirements.txt setup.py test_cryptoprice.py
$ python --version
Python 3.6.1For API requests the project uses requests and for testing it uses Pytest. To install these simply install via the requirements file.
$ pip install --requirement requirements.txtThat's it! You're now set up to work locally. You can build some tests in test_cryptoprice.py to test locally (see Running the Tests) or checkout the steps from Deployment to set up the project as an Amazon Lambda function and integrate it with your own Alexa Skills Kit App!
Pytest is used for testing the application, and is included in the requirements.txt file. If you already followed the steps in Installing and you're good to go! Just run the following on the root directory of the project to run the tests for the project. Note: You must have an internet connection as the app will gather the prices from www.cryptocompare.com
$ py.testTo deploy the system as an Amazon Lambda function you must create a zip composed of the core cryptoprice.py file, the data directory and the third party requests module. This is handled by the setup.py script which can be run in the root directory as below.
$ python setup.pyThis will generate a cryptoprice.zip file which can be uploaded as your lambda function to AWS Lambda. For more details see the AWS Lambda Documentation.
- Craig Langford - Initial Work - https://github.com/CraigLangford
Please feel free to contribute to be added to the project!
This project is licensed under the MIT License - see the LICENSE file for details.
- Hats off to to www.cryptocompare.com for their easy to use and extensive API