https://github.com/m0nsterrr/awtrix-light-client

awtrix-light async HTTP client to be used with Ulanzi clock
https://github.com/m0nsterrr/awtrix-light-client

awtrix awtrix-light

Last synced: about 2 months ago
JSON representation

awtrix-light async HTTP client to be used with Ulanzi clock

• Host: GitHub
• URL: https://github.com/m0nsterrr/awtrix-light-client
• Owner: M0NsTeRRR
• License: other
• Created: 2023-11-03T01:00:45.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-28T10:24:14.000Z (7 months ago)
• Last Synced: 2024-05-29T02:03:53.680Z (7 months ago)
• Topics: awtrix, awtrix-light
• Language: Python
• Homepage: https://m0nsterrr.github.io/awtrix-light-client/
• Size: 2.55 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
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 - [email protected]