knocki


Nameknocki JSON
Version 0.3.5 PyPI version JSON
download
home_pagehttps://github.com/swan-solutions/knocki-homeassistant
SummaryAsynchronous Python client for Knocki.
upload_time2024-09-20 12:29:51
maintainerJoost Lekkerkerker
docs_urlNone
authorJoost Lekkerkerker
requires_python<4.0,>=3.11
licenseMIT
keywords knocki api async client
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Python: Knocki

[![GitHub Release][releases-shield]][releases]
[![Python Versions][python-versions-shield]][pypi]
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE.md)

[![Build Status][build-shield]][build]
[![Code Coverage][codecov-shield]][codecov]

Asynchronous Python client for Knocki.

## About

This package is for connecting Knocki to Home Assistant.

## Installation

```bash
pip install knocki
```

## Changelog & Releases

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

Releases are based on [Semantic Versioning][semver], 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](.github/CONTRIBUTING.md).

Thank you for being involved! :heart_eyes:

## Setting up development environment

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

You need at least:

- Python 3.11+
- [Poetry][poetry-install]
- NodeJS 12+ (including NPM)

To install all packages, including all development requirements:

```bash
npm install
poetry install
```

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

```bash
poetry run pre-commit run --all-files
```

To run just the Python tests:

```bash
poetry run pytest
```

[build-shield]: https://github.com/swan-solutions/knocki-homeassistant/actions/workflows/tests.yaml/badge.svg
[build]: https://github.com/swan-solutions/knocki-homeassistant/actions
[codecov-shield]: https://codecov.io/gh/swan-solutions/knocki-homeassistant/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/swan-solutions/knocki-homeassistant
[commits-shield]: https://img.shields.io/github/commit-activity/y/swan-solutions/knocki-homeassistant.svg
[commits]: https://github.com/swan-solutions/knocki-homeassistant/commits/master
[contributors]: https://github.com/swan-solutions/knocki-homeassistant/graphs/contributors
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
[license-shield]: https://img.shields.io/github/license/swan-solutions/knocki-homeassistant.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
[pre-commit]: https://pre-commit.com/
[project-stage-shield]: https://img.shields.io/badge/project%20stage-stable-green.svg
[python-versions-shield]: https://img.shields.io/pypi/pyversions/knocki
[releases-shield]: https://img.shields.io/github/release/swan-solutions/knocki-homeassistant.svg
[releases]: https://github.com/swan-solutions/knocki-homeassistant/releases
[semver]: http://semver.org/spec/v2.0.0.html
[pypi]: https://pypi.org/project/knocki/


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/swan-solutions/knocki-homeassistant",
    "name": "knocki",
    "maintainer": "Joost Lekkerkerker",
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": "joostlek@outlook.com",
    "keywords": "knocki, api, async, client",
    "author": "Joost Lekkerkerker",
    "author_email": "joostlek@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/37/b4/345df2dc7ba3ad78547db70b7ef35b7f730773be661853e9621214ec5917/knocki-0.3.5.tar.gz",
    "platform": null,
    "description": "# Python: Knocki\n\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE.md)\n\n[![Build Status][build-shield]][build]\n[![Code Coverage][codecov-shield]][codecov]\n\nAsynchronous Python client for Knocki.\n\n## About\n\nThis package is for connecting Knocki to Home Assistant.\n\n## Installation\n\n```bash\npip install knocki\n```\n\n## Changelog & Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality. The format of the log is based on\n[Keep a Changelog][keepchangelog].\n\nReleases are based on [Semantic Versioning][semver], and use the format\nof ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented\nbased on the following:\n\n- ``MAJOR``: Incompatible or major changes.\n- ``MINOR``: Backwards-compatible new features and enhancements.\n- ``PATCH``: Backwards-compatible bugfixes and package updates.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](.github/CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThis Python project is fully managed using the [Poetry][poetry] dependency manager. But also relies on the use of NodeJS for certain checks during development.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n- NodeJS 12+ (including NPM)\n\nTo install all packages, including all development requirements:\n\n```bash\nnpm install\npoetry install\n```\n\nAs this repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. You can run all checks and tests\nmanually, using the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\nTo run just the Python tests:\n\n```bash\npoetry run pytest\n```\n\n[build-shield]: https://github.com/swan-solutions/knocki-homeassistant/actions/workflows/tests.yaml/badge.svg\n[build]: https://github.com/swan-solutions/knocki-homeassistant/actions\n[codecov-shield]: https://codecov.io/gh/swan-solutions/knocki-homeassistant/branch/master/graph/badge.svg\n[codecov]: https://codecov.io/gh/swan-solutions/knocki-homeassistant\n[commits-shield]: https://img.shields.io/github/commit-activity/y/swan-solutions/knocki-homeassistant.svg\n[commits]: https://github.com/swan-solutions/knocki-homeassistant/commits/master\n[contributors]: https://github.com/swan-solutions/knocki-homeassistant/graphs/contributors\n[keepchangelog]: http://keepachangelog.com/en/1.0.0/\n[license-shield]: https://img.shields.io/github/license/swan-solutions/knocki-homeassistant.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com/\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-stable-green.svg\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/knocki\n[releases-shield]: https://img.shields.io/github/release/swan-solutions/knocki-homeassistant.svg\n[releases]: https://github.com/swan-solutions/knocki-homeassistant/releases\n[semver]: http://semver.org/spec/v2.0.0.html\n[pypi]: https://pypi.org/project/knocki/\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Asynchronous Python client for Knocki.",
    "version": "0.3.5",
    "project_urls": {
        "Bug Tracker": "https://github.com/swan-solutions/knocki-homeassistant/issues",
        "Changelog": "https://github.com/swan-solutions/knocki-homeassistant/releases",
        "Documentation": "https://github.com/swan-solutions/knocki-homeassistant",
        "Homepage": "https://github.com/swan-solutions/knocki-homeassistant",
        "Repository": "https://github.com/swan-solutions/knocki-homeassistant"
    },
    "split_keywords": [
        "knocki",
        " api",
        " async",
        " client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fb106f77baedc8637a7578ab3c5d01e986eaf67222ceca79ca039195c59209fc",
                "md5": "e7220aa64ca8198f0ae9381f91fa0052",
                "sha256": "9d7f8bf51581c2f748f397cc6ec95686dbacb656a0ea688d16472517f5d50acd"
            },
            "downloads": -1,
            "filename": "knocki-0.3.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e7220aa64ca8198f0ae9381f91fa0052",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 6969,
            "upload_time": "2024-09-20T12:29:50",
            "upload_time_iso_8601": "2024-09-20T12:29:50.719440Z",
            "url": "https://files.pythonhosted.org/packages/fb/10/6f77baedc8637a7578ab3c5d01e986eaf67222ceca79ca039195c59209fc/knocki-0.3.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "37b4345df2dc7ba3ad78547db70b7ef35b7f730773be661853e9621214ec5917",
                "md5": "590f3cb4a858deecb59a1058d31d603e",
                "sha256": "1c930d01bd5169279408324e1e00f8b347128244c412c5f00679ec772bb73519"
            },
            "downloads": -1,
            "filename": "knocki-0.3.5.tar.gz",
            "has_sig": false,
            "md5_digest": "590f3cb4a858deecb59a1058d31d603e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 6880,
            "upload_time": "2024-09-20T12:29:51",
            "upload_time_iso_8601": "2024-09-20T12:29:51.999492Z",
            "url": "https://files.pythonhosted.org/packages/37/b4/345df2dc7ba3ad78547db70b7ef35b7f730773be661853e9621214ec5917/knocki-0.3.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-20 12:29:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "swan-solutions",
    "github_project": "knocki-homeassistant",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "knocki"
}
        
Elapsed time: 0.46905s