# alexapy
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Python version compatibility](https://img.shields.io/pypi/pyversions/alexapy)](https://pypi.org/project/alexapy)
[![Version on PyPi](https://img.shields.io/pypi/v/alexapy)](https://pypi.org/project/alexapy)
[![pipeline status](https://gitlab.com/keatontaylor/alexapy/badges/master/pipeline.svg)](https://gitlab.com/keatontaylor/alexapy/commits/master)
![PyPI - Downloads](https://img.shields.io/pypi/dd/alexapy)
![PyPI - Downloads](https://img.shields.io/pypi/dw/alexapy)
![PyPI - Downloads](https://img.shields.io/pypi/dm/alexapy)
Python Package for controlling Alexa devices (echo dot, etc) programmatically. This was originally designed for [alexa_media_player](https://github.com/custom-components/alexa_media_player) a custom_component for [Home Assistant](https://www.home-assistant.io/).
**NOTE:** Alexa has no official API; therefore, this library may stop
working at any time without warning.
# Credits
Originally inspired by [this blog](https://blog.loetzimmer.de/2017/10/amazon-alexa-hort-auf-die-shell-echo.html) [(GitHub)](https://github.com/thorsten-gehrig/alexa-remote-control).
Additional scaffolding from [simplisafe-python](https://github.com/bachya/simplisafe-python)
# Contributing
1. [Check for open features/bugs](https://gitlab.com/keatontaylor/alexapy/issues)
or [initiate a discussion on one](https://gitlab.com/keatontaylor/alexapy/issues/new).
2. [Fork the repository](https://gitlab.com/keatontaylor/alexapy/forks/new).
3. Install the dev environment: `make init`.
4. Enter the virtual environment: `pipenv shell`
5. Code your new feature or bug fix.
6. Write a test that covers your new functionality.
7. Update `README.md` with any new documentation.
8. Run tests and ensure 100% code coverage for your contribution: `make coverage`
9. Ensure you have no linting errors: `make lint`
10. Ensure you have typed your code correctly: `make typing`
11. Add yourself to `AUTHORS.md`.
12. Submit a pull request!
# License
[Apache-2.0](LICENSE). By providing a contribution, you agree the contribution is licensed under Apache-2.0.
# API Reference
[See the docs 📚](https://alexapy.readthedocs.io/en/latest/index.html).
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/keatontaylor/alexapy",
"name": "AlexaPy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4",
"maintainer_email": "",
"keywords": "amazon,alexa,homeassistant",
"author": "Keaton Taylor",
"author_email": "keatonstaylor@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3b/32/f1c40677bd878e9cc0e7c03b2616fc0af1b49932e697d23106f7a0bf33be/alexapy-1.27.10.tar.gz",
"platform": null,
"description": "# alexapy\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Python version compatibility](https://img.shields.io/pypi/pyversions/alexapy)](https://pypi.org/project/alexapy)\n[![Version on PyPi](https://img.shields.io/pypi/v/alexapy)](https://pypi.org/project/alexapy)\n[![pipeline status](https://gitlab.com/keatontaylor/alexapy/badges/master/pipeline.svg)](https://gitlab.com/keatontaylor/alexapy/commits/master)\n![PyPI - Downloads](https://img.shields.io/pypi/dd/alexapy)\n![PyPI - Downloads](https://img.shields.io/pypi/dw/alexapy)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/alexapy)\n\nPython Package for controlling Alexa devices (echo dot, etc) programmatically. This was originally designed for [alexa_media_player](https://github.com/custom-components/alexa_media_player) a custom_component for [Home Assistant](https://www.home-assistant.io/).\n\n**NOTE:** Alexa has no official API; therefore, this library may stop\nworking at any time without warning.\n\n# Credits\n\nOriginally inspired by [this blog](https://blog.loetzimmer.de/2017/10/amazon-alexa-hort-auf-die-shell-echo.html) [(GitHub)](https://github.com/thorsten-gehrig/alexa-remote-control).\nAdditional scaffolding from [simplisafe-python](https://github.com/bachya/simplisafe-python)\n\n# Contributing\n\n1. [Check for open features/bugs](https://gitlab.com/keatontaylor/alexapy/issues)\n or [initiate a discussion on one](https://gitlab.com/keatontaylor/alexapy/issues/new).\n2. [Fork the repository](https://gitlab.com/keatontaylor/alexapy/forks/new).\n3. Install the dev environment: `make init`.\n4. Enter the virtual environment: `pipenv shell`\n5. Code your new feature or bug fix.\n6. Write a test that covers your new functionality.\n7. Update `README.md` with any new documentation.\n8. Run tests and ensure 100% code coverage for your contribution: `make coverage`\n9. Ensure you have no linting errors: `make lint`\n10. Ensure you have typed your code correctly: `make typing`\n11. Add yourself to `AUTHORS.md`.\n12. Submit a pull request!\n\n# License\n\n[Apache-2.0](LICENSE). By providing a contribution, you agree the contribution is licensed under Apache-2.0.\n\n# API Reference\n\n[See the docs \ud83d\udcda](https://alexapy.readthedocs.io/en/latest/index.html).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python API to control Amazon Echo Devices Programmatically.",
"version": "1.27.10",
"project_urls": {
"Homepage": "https://gitlab.com/keatontaylor/alexapy",
"Repository": "https://gitlab.com/keatontaylor/alexapy"
},
"split_keywords": [
"amazon",
"alexa",
"homeassistant"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b0bb6337e6410c303417db6a76f19c8ca4e5f7bc9eac053c65b235dc2ab420b",
"md5": "851eed270baab5f4184e2920f784fa4a",
"sha256": "7af758227f5f6faed552997aad15ce8e63da41c4c2b43795b8ec715dd6cb07b7"
},
"downloads": -1,
"filename": "alexapy-1.27.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "851eed270baab5f4184e2920f784fa4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4",
"size": 51156,
"upload_time": "2023-11-29T07:46:59",
"upload_time_iso_8601": "2023-11-29T07:46:59.444965Z",
"url": "https://files.pythonhosted.org/packages/4b/0b/b6337e6410c303417db6a76f19c8ca4e5f7bc9eac053c65b235dc2ab420b/alexapy-1.27.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b32f1c40677bd878e9cc0e7c03b2616fc0af1b49932e697d23106f7a0bf33be",
"md5": "0df113ac0db8e781f984b76b5ed9f5a4",
"sha256": "d05389777f713f35521b8bf2001215d76aee730575f51ffbb2e13263f64206e1"
},
"downloads": -1,
"filename": "alexapy-1.27.10.tar.gz",
"has_sig": false,
"md5_digest": "0df113ac0db8e781f984b76b5ed9f5a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4",
"size": 43900,
"upload_time": "2023-11-29T07:47:01",
"upload_time_iso_8601": "2023-11-29T07:47:01.295473Z",
"url": "https://files.pythonhosted.org/packages/3b/32/f1c40677bd878e9cc0e7c03b2616fc0af1b49932e697d23106f7a0bf33be/alexapy-1.27.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 07:47:01",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "keatontaylor",
"gitlab_project": "alexapy",
"lcname": "alexapy"
}