Skip to main content

A REST API for MQTT Client Management

Project description

MQTT-REST

MQTT-REST is a project that bridges MQTT and RESTful APIs, allowing seamless communication between IoT devices using MQTT and web services using REST.

It's useful if you want to monitor arbritary stuff from a machine in Home-assistant without writing custom integration.

Development

git clone https://github.com/rahulsrma26/mqtt-rest
cd mqtt-rest
poetry shell
poetry install
poetry run python -m mqtt_rest.run

If you dont want poetry to managing virtual environment then dont need to run poetry run or poetry shell. In that case one can directly run python -m mqtt_rest.run.

Visit /docs endpoint to access API docs via SwaggerUI.

Testing

poetry run pytest

Linting

poetry run ruff check

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mqtt_rest-0.1.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

mqtt_rest-0.1.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file mqtt_rest-0.1.0.tar.gz.

File metadata

  • Download URL: mqtt_rest-0.1.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/5.15.0-91-generic

File hashes

Hashes for mqtt_rest-0.1.0.tar.gz
Algorithm Hash digest
SHA256 314d34a2319367731f6927875600923e050dbac10a4f087fb4306a0de529d624
MD5 01aad1fa172352c8d87aac8a234ce891
BLAKE2b-256 4b82faef28b3e68c5731ee63a177d2d8d2db98ca473d6bf0a21bc26315852ad6

See more details on using hashes here.

File details

Details for the file mqtt_rest-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: mqtt_rest-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/5.15.0-91-generic

File hashes

Hashes for mqtt_rest-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0494b481a42cd0aafcb13f8f28a73af3bf5903c5fbe0585bffd3bce3995fe7e4
MD5 f0e63b97be9f277fb46fab58a6f333f3
BLAKE2b-256 cc2cf1a23c4c11cc56b1dc2735021900031106d78c1dff6d42fd534f79f92fff

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page