| Name | pyschlage JSON |
| Version |
2024.11.0
JSON |
| download |
| home_page | None |
| Summary | Python API for interacting with Schlage WiFi locks. |
| upload_time | 2024-11-25 14:11:47 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | Apache-2.0 |
| keywords |
schlage
api
iot
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyschlage
Python 3 library for interacting with Schlage Encode WiFi locks.
*Note that this project has no official relationship with Schlage or Allegion. Use at your own risk.*
## Usage
```python
from pyschlage import Auth, Schlage
# Create a Schlage object and authenticate with your credentials.
s = Schlage(Auth("username", "password"))
# List the locks attached to your account.
locks = s.locks()
# Print the name of the first lock
print(locks[0].name)
"My lock"
# Lock the first lock.
lock[0].lock()
```
## Installation
### Pip
To install pyschlage, run this command in your terminal:
```sh
$ pip install pyschlage
```
### Source code
Pyschlage is actively developed on Github, where the code is [always available](https://github.com/dknowles2/pyschlage).
You can either clone the public repository:
```sh
$ git clone https://github.com/dknowles2/pyschlage
```
Or download the latest [tarball](https://github.com/dknowles2/pyschlage/tarball/main):
```sh
$ curl -OL https://github.com/dknowles2/pyschlage/tarball/main
```
Once you have a copy of the source, you can embed it in your own Python package, or install it into your site-packages easily:
```sh
$ cd pyschlage
$ python -m pip install .
```
## Documentation
API reference can be found on [Read the Docs](https://pyschlage.readthedocs.io)
Raw data
{
"_id": null,
"home_page": null,
"name": "pyschlage",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "schlage, api, iot",
"author": null,
"author_email": "David Knowles <dknowles2@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/41/b0/db38450dbdace4457d6f4c0e9b02c5254260377e5c5a15f6b50af208b1c1/pyschlage-2024.11.0.tar.gz",
"platform": "any",
"description": "# pyschlage\nPython 3 library for interacting with Schlage Encode WiFi locks.\n\n*Note that this project has no official relationship with Schlage or Allegion. Use at your own risk.*\n\n## Usage\n\n```python\nfrom pyschlage import Auth, Schlage\n\n# Create a Schlage object and authenticate with your credentials.\ns = Schlage(Auth(\"username\", \"password\"))\n\n# List the locks attached to your account.\nlocks = s.locks()\n\n# Print the name of the first lock\nprint(locks[0].name)\n\"My lock\"\n\n# Lock the first lock.\nlock[0].lock()\n```\n\n## Installation\n\n### Pip\n\nTo install pyschlage, run this command in your terminal:\n\n```sh\n$ pip install pyschlage\n```\n\n### Source code\n\nPyschlage is actively developed on Github, where the code is [always available](https://github.com/dknowles2/pyschlage).\n\nYou can either clone the public repository:\n\n```sh\n$ git clone https://github.com/dknowles2/pyschlage\n```\n\nOr download the latest [tarball](https://github.com/dknowles2/pyschlage/tarball/main):\n\n```sh\n$ curl -OL https://github.com/dknowles2/pyschlage/tarball/main\n```\n\nOnce you have a copy of the source, you can embed it in your own Python package, or install it into your site-packages easily:\n\n```sh\n$ cd pyschlage\n$ python -m pip install .\n```\n\n## Documentation\n\nAPI reference can be found on [Read the Docs](https://pyschlage.readthedocs.io)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python API for interacting with Schlage WiFi locks.",
"version": "2024.11.0",
"project_urls": {
"Bug Reports": "https://github.com/dknowles2/pyschlage/issues",
"Documentation": "https://pyschlage.readthedocs.io",
"Homepage": "https://github.com/dknowles2/pyschlage",
"Source Code": "https://github.com/dknowles2/pyschlage"
},
"split_keywords": [
"schlage",
" api",
" iot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa5e7b0c58a63048461bb4b5637cdb0562b3d9e977b07ab2654c343daae3a556",
"md5": "ba71a855d67d2ff54447e9f1e5e93016",
"sha256": "94602adfc42a0de72de7d424f6e19e22a4ac4a122b48ff2a3547ac8ee76424b5"
},
"downloads": -1,
"filename": "pyschlage-2024.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba71a855d67d2ff54447e9f1e5e93016",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 20917,
"upload_time": "2024-11-25T14:11:46",
"upload_time_iso_8601": "2024-11-25T14:11:46.698352Z",
"url": "https://files.pythonhosted.org/packages/fa/5e/7b0c58a63048461bb4b5637cdb0562b3d9e977b07ab2654c343daae3a556/pyschlage-2024.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41b0db38450dbdace4457d6f4c0e9b02c5254260377e5c5a15f6b50af208b1c1",
"md5": "98137087f5bbc80f1c5ab4c6ca23adaa",
"sha256": "1d04bda612946059f6e7ea8db52c447d7634370e547437ddcdf8793ab6f17a57"
},
"downloads": -1,
"filename": "pyschlage-2024.11.0.tar.gz",
"has_sig": false,
"md5_digest": "98137087f5bbc80f1c5ab4c6ca23adaa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 30734,
"upload_time": "2024-11-25T14:11:47",
"upload_time_iso_8601": "2024-11-25T14:11:47.599689Z",
"url": "https://files.pythonhosted.org/packages/41/b0/db38450dbdace4457d6f4c0e9b02c5254260377e5c5a15f6b50af208b1c1/pyschlage-2024.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 14:11:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dknowles2",
"github_project": "pyschlage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyschlage"
}
