# 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/c3/43/e065403719c73a594a649ec92f76a205f3b8d09acf1a52c86c88fd040498/pyschlage-2024.8.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 License 2.0",
"summary": "Python API for interacting with Schlage WiFi locks.",
"version": "2024.8.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": "6505f4bd3540bf29f85ea097649f40c959cf096509c95597013b47cf26b4b159",
"md5": "997ef5c4b6d7857b4d923552faabea17",
"sha256": "9b974980f0feca962f01c6606555cbf9812e3ff28e3b48798c0c59ce7cd526f2"
},
"downloads": -1,
"filename": "pyschlage-2024.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "997ef5c4b6d7857b4d923552faabea17",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 20763,
"upload_time": "2024-08-12T15:46:55",
"upload_time_iso_8601": "2024-08-12T15:46:55.134306Z",
"url": "https://files.pythonhosted.org/packages/65/05/f4bd3540bf29f85ea097649f40c959cf096509c95597013b47cf26b4b159/pyschlage-2024.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c343e065403719c73a594a649ec92f76a205f3b8d09acf1a52c86c88fd040498",
"md5": "9d53303598060862beed0d7f6ae2d5e5",
"sha256": "f82683969d6e1c8ee674039c7be905de0d0bd235293d2811251e91f3684f6418"
},
"downloads": -1,
"filename": "pyschlage-2024.8.0.tar.gz",
"has_sig": false,
"md5_digest": "9d53303598060862beed0d7f6ae2d5e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 30615,
"upload_time": "2024-08-12T15:46:56",
"upload_time_iso_8601": "2024-08-12T15:46:56.945896Z",
"url": "https://files.pythonhosted.org/packages/c3/43/e065403719c73a594a649ec92f76a205f3b8d09acf1a52c86c88fd040498/pyschlage-2024.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 15:46:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dknowles2",
"github_project": "pyschlage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pycognito",
"specs": [
[
"==",
"2024.5.1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
}
],
"lcname": "pyschlage"
}
JSON
