Skip to main content

A Python wrapper for the Nuki Web API

Project description

nuki-web-api

PyPI - Version GitHub Actions Workflow Status PyPI - License

A Python wrapper for the Nuki Web API.

Installation

pip install nuki-web-api

Usage

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

nuki-web-api reference

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nuki_web_api-0.1.14.tar.gz (23.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nuki_web_api-0.1.14-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file nuki_web_api-0.1.14.tar.gz.

File metadata

  • Download URL: nuki_web_api-0.1.14.tar.gz
  • Upload date:
  • Size: 23.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nuki_web_api-0.1.14.tar.gz
Algorithm Hash digest
SHA256 722841e9785941e0531308e248666a13c1340b6b2828b668c8a558d9301254ae
MD5 f711494eaded16baa8f96c6d873f8e41
BLAKE2b-256 7132bc055cc8eb3d6d0726330fdb6aa4bec42402c310e0f6590f6f4e661e1c37

See more details on using hashes here.

Provenance

The following attestation bundles were made for nuki_web_api-0.1.14.tar.gz:

Publisher: python-build-on-push.yml on barghest89/nuki-web-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nuki_web_api-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: nuki_web_api-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nuki_web_api-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 b66ceac6189ead889db1f5e5b0bea773441469a28908cb92651fdd1d08ef8857
MD5 57390da0b27134d8b6f57d371b52ee28
BLAKE2b-256 43b61cb7a00dd948f932fda2f4396af551399e8b205919a4eb669e5bef299d41

See more details on using hashes here.

Provenance

The following attestation bundles were made for nuki_web_api-0.1.14-py3-none-any.whl:

Publisher: python-build-on-push.yml on barghest89/nuki-web-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page