Metadata-Version: 2.4
Name: nuki-web-api
Version: 0.1.14
Summary: A Python wrapper for the Nuki Web API
Author-email: barghest89 <blachosf@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/barghest89/nuki-web-api
Project-URL: Bug Tracker, https://github.com/barghest89/nuki-web-api/issues
Keywords: nuki,api,smartlock
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown
Requires-Dist: requests==2.32.5
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: python-dotenv; extra == "dev"
Requires-Dist: pyotp; extra == "dev"
Requires-Dist: mkdocs; extra == "dev"
Requires-Dist: mkdocs-material; extra == "dev"
Requires-Dist: mkdocstrings[python]; extra == "dev"

# nuki-web-api

![PyPI - Version](https://img.shields.io/pypi/v/nuki-web-api)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/barghest89/nuki-web-api/python-build-on-push.yml)
![PyPI - License](https://img.shields.io/pypi/l/nuki-web-api)


A Python wrapper for the [Nuki Web API](https://api.nuki.io/).

## Installation

```bash
pip install nuki-web-api
```


## Usage
```Python
from nukiwebapi import NukiWebAPI

client = NukiWebAPI("YOUR_ACCESS_TOKEN")

for lock_id, lock in client.lock_instances:
    print(lock.name)
    print(lock.hex_id)

    print(lock.is_locked)
    print(lock.battery_charge)

```

## Documentation
    
[API Reference](https://api.nuki.io/)

[nuki-web-api reference](https://barghest89.github.io/nuki-web-api/)

## Disclaimer

This API wrapper is in **Alpha** stage. I do not have the resources to fully test all provided methods against the API (e.g. account deletion).
The methods provided by the API can potentially mess with devices directly linked to your personal safety (i.e. your home!).

**Use with caution.**

