# šØ simplisafe-python: A Python3, async interface to the SimpliSafeā¢ API
[![CI][ci-badge]][ci]
[![PyPI][pypi-badge]][pypi]
[![Version][version-badge]][version]
[![License][license-badge]][license]
[![Code Coverage][codecov-badge]][codecov]
[![Maintainability][maintainability-badge]][maintainability]
<a href="https://www.buymeacoffee.com/bachya1208P" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
`simplisafe-python` (hereafter referred to as `simplipy`) is a Python3,
`asyncio`-driven interface to the unofficial [SimpliSafeā¢][simplisafe] API. With it,
users can get data on their system (including available sensors), set the system state,
and more.
# Documentation
You can find complete documentation [here][docs].
# Contributing
Thanks to all of [our contributors][contributors] so far!
1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].
2. [Fork the repository][fork].
3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`
4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`
5. Install the dev environment: `script/setup`
6. Code your new feature or bug fix on a new branch.
7. Write tests that cover your new functionality.
8. Run tests and ensure 100% code coverage: `poetry run pytest --cov simplipy tests`
9. Update `README.md` with any new documentation.
10. Submit a pull request!
[ci-badge]: https://img.shields.io/github/actions/workflow/status/bachya/simplisafe-python/test.yml
[ci]: https://github.com/bachya/simplisafe-python/actions
[codecov-badge]: https://codecov.io/gh/bachya/simplisafe-python/branch/dev/graph/badge.svg
[codecov]: https://codecov.io/gh/bachya/simplisafe-python
[contributors]: https://github.com/bachya/simplisafe-python/graphs/contributors
[docs]: https://simplisafe-python.readthedocs.io
[fork]: https://github.com/bachya/simplisafe-python/fork
[issues]: https://github.com/bachya/simplisafe-python/issues
[license-badge]: https://img.shields.io/pypi/l/simplisafe-python.svg
[license]: https://github.com/bachya/simplisafe-python/blob/main/LICENSE
[maintainability-badge]: https://api.codeclimate.com/v1/badges/f46d8b1dcfde6a2f683d/maintainability
[maintainability]: https://codeclimate.com/github/bachya/simplisafe-python/maintainability
[new-issue]: https://github.com/bachya/simplisafe-python/issues/new
[pypi-badge]: https://img.shields.io/pypi/v/simplisafe-python.svg
[pypi]: https://pypi.python.org/pypi/simplisafe-python
[simplisafe]: https://simplisafe.com
[version-badge]: https://img.shields.io/pypi/pyversions/simplisafe-python.svg
[version]: https://pypi.python.org/pypi/simplisafe-python
Raw data
{
"_id": null,
"home_page": "https://github.com/bachya/simplisafe-python",
"name": "simplisafe-python",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Aaron Bach",
"author_email": "bachya1208@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1a/7b/b2895319988a1473abd171542c594a194fda508e37efda31c515249f94de/simplisafe_python-2024.1.0.tar.gz",
"platform": null,
"description": "# \ud83d\udea8 simplisafe-python: A Python3, async interface to the SimpliSafe\u2122 API\n\n[![CI][ci-badge]][ci]\n[![PyPI][pypi-badge]][pypi]\n[![Version][version-badge]][version]\n[![License][license-badge]][license]\n[![Code Coverage][codecov-badge]][codecov]\n[![Maintainability][maintainability-badge]][maintainability]\n\n<a href=\"https://www.buymeacoffee.com/bachya1208P\" target=\"_blank\"><img src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"41\" width=\"174\"></a>\n\n`simplisafe-python` (hereafter referred to as `simplipy`) is a Python3,\n`asyncio`-driven interface to the unofficial [SimpliSafe\u2122][simplisafe] API. With it,\nusers can get data on their system (including available sensors), set the system state,\nand more.\n\n# Documentation\n\nYou can find complete documentation [here][docs].\n\n# Contributing\n\nThanks to all of [our contributors][contributors] so far!\n\n1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].\n2. [Fork the repository][fork].\n3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`\n4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`\n5. Install the dev environment: `script/setup`\n6. Code your new feature or bug fix on a new branch.\n7. Write tests that cover your new functionality.\n8. Run tests and ensure 100% code coverage: `poetry run pytest --cov simplipy tests`\n9. Update `README.md` with any new documentation.\n10. Submit a pull request!\n\n[ci-badge]: https://img.shields.io/github/actions/workflow/status/bachya/simplisafe-python/test.yml\n[ci]: https://github.com/bachya/simplisafe-python/actions\n[codecov-badge]: https://codecov.io/gh/bachya/simplisafe-python/branch/dev/graph/badge.svg\n[codecov]: https://codecov.io/gh/bachya/simplisafe-python\n[contributors]: https://github.com/bachya/simplisafe-python/graphs/contributors\n[docs]: https://simplisafe-python.readthedocs.io\n[fork]: https://github.com/bachya/simplisafe-python/fork\n[issues]: https://github.com/bachya/simplisafe-python/issues\n[license-badge]: https://img.shields.io/pypi/l/simplisafe-python.svg\n[license]: https://github.com/bachya/simplisafe-python/blob/main/LICENSE\n[maintainability-badge]: https://api.codeclimate.com/v1/badges/f46d8b1dcfde6a2f683d/maintainability\n[maintainability]: https://codeclimate.com/github/bachya/simplisafe-python/maintainability\n[new-issue]: https://github.com/bachya/simplisafe-python/issues/new\n[pypi-badge]: https://img.shields.io/pypi/v/simplisafe-python.svg\n[pypi]: https://pypi.python.org/pypi/simplisafe-python\n[simplisafe]: https://simplisafe.com\n[version-badge]: https://img.shields.io/pypi/pyversions/simplisafe-python.svg\n[version]: https://pypi.python.org/pypi/simplisafe-python\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python3, async interface to the SimpliSafe API",
"version": "2024.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/bachya/simplipy/issues",
"Changelog": "https://github.com/bachya/simplipy/releases",
"Homepage": "https://github.com/bachya/simplisafe-python",
"Repository": "https://github.com/bachya/simplisafe-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "810248dab7bad19138f253894a080a05cf76f16bd7be7498d42c4a27a1e4605a",
"md5": "36310b70f7e733e17533ef80820a1605",
"sha256": "4b159ddb416e6184061184b574773bd8340bddaa28c592548ee126bc6e7abb0d"
},
"downloads": -1,
"filename": "simplisafe_python-2024.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36310b70f7e733e17533ef80820a1605",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 33511,
"upload_time": "2024-01-20T17:31:07",
"upload_time_iso_8601": "2024-01-20T17:31:07.386094Z",
"url": "https://files.pythonhosted.org/packages/81/02/48dab7bad19138f253894a080a05cf76f16bd7be7498d42c4a27a1e4605a/simplisafe_python-2024.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a7bb2895319988a1473abd171542c594a194fda508e37efda31c515249f94de",
"md5": "81a039258d9f3ded44fb586feed770da",
"sha256": "6ab42d2bdb67f491c5197cf1a63aadb9b495002cbddfacb4ba4443c196b17096"
},
"downloads": -1,
"filename": "simplisafe_python-2024.1.0.tar.gz",
"has_sig": false,
"md5_digest": "81a039258d9f3ded44fb586feed770da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 26772,
"upload_time": "2024-01-20T17:31:09",
"upload_time_iso_8601": "2024-01-20T17:31:09.956070Z",
"url": "https://files.pythonhosted.org/packages/1a/7b/b2895319988a1473abd171542c594a194fda508e37efda31c515249f94de/simplisafe_python-2024.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-20 17:31:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bachya",
"github_project": "simplisafe-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "simplisafe-python"
}
JSON
