Metadata-Version: 2.1
Name: htd-client
Version: 0.0.14
Summary: A client supporting Home Theater Direct's gateway device.
Home-page: https://github.com/hikirsch/python-htd
License: MIT
Author: Adam Kirschner
Author-email: accounts@adamskirschner.com
Requires-Python: >=3.13,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Dist: pyserial-asyncio (>=0.6,<0.7)
Project-URL: Issues, https://github.com/hikirsch/python-htd/issues
Project-URL: Repository, https://github.com/hikirsch/python-htd
Description-Content-Type: text/markdown

# 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 base_client

client = HtdClient("192.168.1.2")
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.

