Metadata-Version: 2.3
Name: awtrix-light-client
Version: 1.3.0
Summary: awtrix-light HTTP client to be used with Ulanzi clock
Project-URL: Homepage, https://github.com/M0NsTeRRR/awtrix-light-client
Project-URL: Repository, https://github.com/M0NsTeRRR/awtrix-light-client
Project-URL: Issues, https://github.com/M0NsTeRRR/awtrix-light-client/issues
Project-URL: Documentation, https://m0nsterrr.github.io/awtrix-light-client/latest/
Author-email: Ludovic Ortega <ludovic.ortega@adminafk.fr>
License-File: LICENSE
License-File: LICENSE.fr
Keywords: awtrix,awtrix-light
Classifier: License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Utilities
Requires-Python: <4.0.0,>=3.9
Requires-Dist: httpx<1.0.0,>=0.22.0
Requires-Dist: pydantic-extra-types<3.0.0,>=2.8.2
Requires-Dist: pydantic-settings<3.0.0,>=2.3.4
Requires-Dist: pydantic<3.0.0,>=2.7.4
Provides-Extra: dev
Requires-Dist: mike~=2.1.3; extra == 'dev'
Requires-Dist: mkdocs-material[imaging]~=9.5.41; extra == 'dev'
Requires-Dist: mkdocstrings-python~=1.12.1; extra == 'dev'
Requires-Dist: pytest-asyncio~=0.24.0; extra == 'dev'
Requires-Dist: pytest-cov~=5.0.0; extra == 'dev'
Requires-Dist: pytest-httpx~=0.32.0; extra == 'dev'
Requires-Dist: pytest~=8.3.3; extra == 'dev'
Requires-Dist: ruff~=0.7.0; extra == 'dev'
Description-Content-Type: text/markdown

Python async HTTP client for [awtrix-light](https://github.com/Blueforcer/awtrix-light)

[![PyPI](https://img.shields.io/pypi/v/awtrix-light-client.svg)](https://pypi.python.org/pypi/awtrix-light-client)
[![PyPI versions](https://img.shields.io/pypi/pyversions/awtrix-light-client.svg)](https://pypi.python.org/pypi/awtrix-light-client)
[![Python test](https://github.com/M0NsTeRRR/awtrix-light-client/actions/workflows/test.yml/badge.svg)](https://github.com/M0NsTeRRR/awtrix-light-client/actions/workflows/test.yml)
[![Code Style](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)

# Warning
This client has been tested with awtrix-light v0.90 use with caution as official dev documentation is not fully documented and can cause crash

# Documentation
[https://M0NsTeRRR.github.io/awtrix-light-client](https://M0NsTeRRR.github.io/awtrix-light-client)

# Dev
Install [uv](https://docs.astral.sh/uv/getting-started/installation/)

Install and setup dependencies with `uv sync`

### Run unit test
```
uv run pytest --cov
```

### Run ruff
```
uv run ruff format . 
uv run ruff check .
```

## Contributing

We welcome and encourage contributions to this project! Please read the [Contributing guide](CONTRIBUTING.md). Also make sure to check the [Code of Conduct](CODE_OF_CONDUCT.md) and adhere to its guidelines

# Security

See [SECURITY.md](SECURITY.md) file for details.

# Licence

The code is under CeCILL license.

You can find all details here: https://cecill.info/licences/Licence_CeCILL_V2.1-en.html

# Credits

Copyright © Ludovic Ortega, 2023

Contributor(s):

-Ortega Ludovic - ludovic.ortega@adminafk.fr