---
id: yalexs
version: "9.2.10"
license: MIT
license_treatment: permissive
maintenance: active
---

# yalexs — Python API for Yale Access (formerly August) Smart Lock and Doorbell

License: permissive · Maintenance: active · Downloads: 76.4K/mo

## What it is and what it does

yalexs is an async-only Python client for Yale Access smart locks and doorbells (the rebranded August product). It handles the full authentication flow—including email/phone verification codes and token caching—and provides methods to query locks, control them, and manage alarms on supported brands. The library depends on aiohttp for HTTP communication, pyjwt for token handling, and several utility libraries (ciso8601, python-dateutil, python-socketio, requests) for date parsing and real-time updates.

The library is actively maintained and used in Home Assistant, but with an important caveat: as of v9, only the async API is supported (synchronous classes were removed in v8), and the historically embedded public API key no longer works—you must obtain an official partner key from Yale Access or authenticate through Home Assistant's OAuth for Yale Global accounts. The library targets modern Python (3.10–3.14) and is permissively licensed under MIT.

Use it for:

- Integrate Yale Access smart locks into a Python home automation system or custom IoT application.
- Build a monitoring dashboard that queries lock status and alarm state from Yale Access accounts.
- Automate lock/unlock and alarm arm/disarm actions based on time, location, or other triggers.
- Cache authentication tokens to avoid repeated login flows in long-running services.
- Manage multiple Yale Access devices (locks, doorbells, alarms) through a unified async interface.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Async Python client library for Yale Access (formerly August) smart locks and doorbells, handling authentication, device control, and alarm management.

Yes, if you have a valid Yale Access API key and need async smart-lock control in Python. The library is actively maintained, has no known vulnerabilities, low install friction, and clean dependencies. The main gotcha is that you must supply your own partner API key—the public key no longer works—and confirm compatibility with your specific Yale Access brand variant (August, Yale Home, or Yale Global).

## Install

pip install yalexs
uv add yalexs
poetry add yalexs

## Installing yalexs

Before you install: Low install friction with a pure-Python wheel. Actively maintained with recent release (53 days ago) and clean commit history. Supports current Python versions (3.10–3.14).

License in practice: MIT license is permissive; you can use, modify, and distribute this library freely with minimal restrictions.

Quickstart:

pip install yalexs

import asyncio
from aiohttp import ClientSession
from yalexs.api_async import ApiAsync
from yalexs.authenticator_async import AuthenticatorAsync
from yalexs.const import Brand

async with ClientSession() as session:
    api = ApiAsync(session, brand=Brand.AUGUST)
    authenticator = AuthenticatorAsync(api, "email", "user@example.com", "password")
    await authenticator.async_setup_authentication()
    auth = await authenticator.async_authenticate()
    locks = await api.async_get_locks(auth.access_token)

Requires aiohttp ClientSession; you must supply a valid API key from Yale Access (the public key is no longer accepted by the backend).

Verify before relying:

- Whether freenub is a typo or intentional dependency; its purpose in the runtime stack is unclear.
- Current working status with Yale Access backend given recent API key policy changes mentioned in the description.

## Package facts

- License: MIT (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 76.4K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

yale access smart lock api, august lock python client, smart lock authentication, doorbell api integration, async smart home lock control, yale home automation, iot lock management, smart-home, async-io, iot

[View on SkillFed](https://skillfed.io/packages/yalexs) · [View on PyPI](https://pypi.org/project/yalexs/)