# Pyschlage

Pyschlage is a Python 3 library for interacting with Schlage Encode WiFi locks.

# Basic usage

    >>> 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:

    $ pip install pyschlage

## Source code

Pyschlage is actively developed on Github, where the code is always available.

You can either clone the public repository:

    $ git clone https://github.com/dknowles2/pyschlage

Or download the latest tarball:

    $ 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:

    $ cd pyschlage
    $ python -m pip install .

# API Reference

- API Reference
  - Main API
  - Authentication
  - Locks
  - Exceptions