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.15.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.15-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nuki_web_api-0.1.15.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.15.tar.gz
Algorithm Hash digest
SHA256 44e4dd151929f0fc7f0d1b71bb624bb61e5717e8e6a363556857bfad05e596fe
MD5 03f77c796fed982557ebe413786fc217
BLAKE2b-256 2ea793de2f2546cd44ab79c141645b940d7f88cc0c3e41bf9044674f78da5e13

See more details on using hashes here.

Provenance

The following attestation bundles were made for nuki_web_api-0.1.15.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.15-py3-none-any.whl.

File metadata

  • Download URL: nuki_web_api-0.1.15-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.15-py3-none-any.whl
Algorithm Hash digest
SHA256 8d5a55280b59bf16225e4ba78c1f3ea70c1d5734528282e453f86dcd8eb21a97
MD5 ec00e8b6ccb90495ec8abc706cfa99c4
BLAKE2b-256 7b063230662f7b288db43ed197d74e88390aa2440595f60db090e869463431d9

See more details on using hashes here.

Provenance

The following attestation bundles were made for nuki_web_api-0.1.15-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