Skip to main content

Asynchronous Python client for Knocki.

Project description

Python: Knocki

GitHub Release Python Versions Project Stage Project Maintenance License

Build Status Code Coverage

Asynchronous Python client for Knocki.

About

This package is for connecting Knocki to Home Assistant.

Installation

pip install knocki

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

  • Python 3.11+
  • Poetry
  • NodeJS 12+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

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

knocki-0.4.1.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

knocki-0.4.1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file knocki-0.4.1.tar.gz.

File metadata

  • Download URL: knocki-0.4.1.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.7

File hashes

Hashes for knocki-0.4.1.tar.gz
Algorithm Hash digest
SHA256 87dc3ce1da4582b87783162369cb825b1477df7ff0925b359acec40582f58754
MD5 779109e28a3ebe7c8cce66c56f599036
BLAKE2b-256 f0c51ed6420a29f927f5f879fb124910c5d7d7aa3bb3970b567fcbc1904b87f2

See more details on using hashes here.

File details

Details for the file knocki-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: knocki-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.7

File hashes

Hashes for knocki-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 13a0cc5332965bf9e41633f300f248b0879043e15e2626e539cae45d226b6cb0
MD5 afc061e8ca872082a101cf6395bd1533
BLAKE2b-256 17875197084f3a03ea08f7e599ddb0953f05203c976f2038019141c2b6edcdd4

See more details on using hashes here.

Supported by

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