diff --git a/README.md b/README.md index 65bc8f2..bfce469 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# pykevo +# pykevoplus Python module for controlling Kwikset Kevo locks Kwikset does not provide an official API for their Kevo locks; I reverse engineered this module from the mykevo.com web app. @@ -11,7 +11,7 @@ The Kevo.GetLocks() function will attempt to scrape the mykevo.com web site to f find all of your locks, but scraping the HTML might break at any time if Kwikset changes the website. ```python -from pykevo import Kevo +from pykevoplus import Kevo locks = Kevo.GetLocks("username@email.com", "password123") for lock in locks: print repr(lock) @@ -23,15 +23,15 @@ A better way is to explicitly instantiate a KevoLock object using the UUID of th logging into mykevo.com, click Details for the lock, click Settings, the lock ID is on the right. ```python -from pykevo import KevoLock -lock = KevoLock.FromLockID("8f61e0fe-8584-442f-9ea0-b2dde6ff4d5a", "username@gmail.com", "password123") +from pykevoplus import KevoLock +lock = KevoLock.FromLockID("cca7cd1d-c1d5-43ce-a087-c73b974b3529, state=Locked) ", "username@email.com", "password123") ``` #####Locking and Unlocking ```python -from pykevo import KevoLock -lock = KevoLock.FromLockID(lock_is, username, password) +from pykevoplus import KevoLock +lock = KevoLock.FromLockID(lock_id, username, password) lock.Unlock() print lock.GetBoltState() lock.Lock() @@ -43,7 +43,7 @@ print lock.GetBoltState() ##### Multiple operations in the same session The KevoLockSession context manager allows you to perform multiple operations on a lock with a single auth session ```python -from pykevo import KevoLock, KevoLockSession +from pykevoplus import KevoLock, KevoLockSession lock = KevoLock.FromLockID(lock_id, username, password) with KevoLockSession(lock): lock.Unlock() diff --git a/pykevo/__init__.py b/pykevoplus/__init__.py similarity index 100% rename from pykevo/__init__.py rename to pykevoplus/__init__.py diff --git a/setup.py b/setup.py index 749392f..e8d5510 100644 --- a/setup.py +++ b/setup.py @@ -1,13 +1,14 @@ from setuptools import setup setup( - name = "pykevo", + name = "pykevoplus", version = "1.0", author = "Carl Seelye", author_email = "cseelye@gmail.com", description = "Control Kwikset Kevo locks", - liscense = "MIT", + license = "MIT", keywords = "kevo kwikset", - packages = ["pykevo"], - url = "https://github.com/cseelye/pykevo", + packages = ["pykevoplus"], + url = "https://github.com/cseelye/pykevoplus", + long_description = read("README.md") )