# htd_client
This library contains a client to communicate with the HTD MC/MCA66 gateway. Future support
for the Lync system is planned.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Installation
Use pip to install this package
```bash
pip install htd_client
```
## Usage
Here's a basic example.
```python
import HtdClient from htd_client
client = HtdClient("192.168.1.2")
(friendly_name, model_info) = client.get_model_info()
client.volume_up()
client.volume_down()
```
## Contributing
[Poetry](https://python-poetry.org/docs/#installation) is used to manage dependencies, run tests, and publish.
Run unit tests
```bash
$ poetry run pytest
```
Generate documentation
```bash
$ poetry run sphinx-build -b html docs docs/_build
```
## License
This project is licensed under the MIT License - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/hikirsch/python-htd",
"name": "htd-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Adam Kirschner",
"author_email": "accounts@adamskirschner.com",
"download_url": "https://files.pythonhosted.org/packages/c7/45/aa22357d48a9f3848ec7488d239fa19aa98876f48df7d10cea6fd07fbb58/htd_client-0.0.3.tar.gz",
"platform": null,
"description": "# htd_client\n\nThis library contains a client to communicate with the HTD MC/MCA66 gateway. Future support\nfor the Lync system is planned.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nUse pip to install this package\n\n```bash\npip install htd_client\n```\n\n## Usage\n\nHere's a basic example.\n\n```python\n\nimport HtdClient from htd_client\n\nclient = HtdClient(\"192.168.1.2\")\n(friendly_name, model_info) = client.get_model_info()\nclient.volume_up()\nclient.volume_down()\n\n```\n\n## Contributing\n\n[Poetry](https://python-poetry.org/docs/#installation) is used to manage dependencies, run tests, and publish.\n\nRun unit tests\n\n```bash\n$ poetry run pytest\n```\n\nGenerate documentation\n\n```bash\n$ poetry run sphinx-build -b html docs docs/_build \n```\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A client supporting Home Theater Direct's gateway device.",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/hikirsch/python-htd",
"Issues": "https://github.com/hikirsch/python-htd/issues",
"Repository": "https://github.com/hikirsch/python-htd"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "63ab0f570e45bc75ef7e8b8ec73dd5097879c480a5ea430ed896f002d866a753",
"md5": "3a6d6be7049c47e2dca1269a302d6134",
"sha256": "5a5ed339928d27f51e088fb66d64beada3e7fe7973bb77d8e854b1a26898c235"
},
"downloads": -1,
"filename": "htd_client-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a6d6be7049c47e2dca1269a302d6134",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 9697,
"upload_time": "2024-08-03T16:25:49",
"upload_time_iso_8601": "2024-08-03T16:25:49.457179Z",
"url": "https://files.pythonhosted.org/packages/63/ab/0f570e45bc75ef7e8b8ec73dd5097879c480a5ea430ed896f002d866a753/htd_client-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c745aa22357d48a9f3848ec7488d239fa19aa98876f48df7d10cea6fd07fbb58",
"md5": "f7fb9d0b2841ce50e2e1e2d26c7ca173",
"sha256": "e741d8a33879740e1e110f0557f0900e553420f450bf696fadb0dd41a2237da5"
},
"downloads": -1,
"filename": "htd_client-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "f7fb9d0b2841ce50e2e1e2d26c7ca173",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 8628,
"upload_time": "2024-08-03T16:25:50",
"upload_time_iso_8601": "2024-08-03T16:25:50.748774Z",
"url": "https://files.pythonhosted.org/packages/c7/45/aa22357d48a9f3848ec7488d239fa19aa98876f48df7d10cea6fd07fbb58/htd_client-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-03 16:25:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hikirsch",
"github_project": "python-htd",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "htd-client"
}