Skip to main content

Install jmq_chirpstack in Python

Integration package with the ChirpStack API using Python.
This client allows easy connection to the ChirpStack REST API to retrieve information about tenants, gateways, applications, devices, device profiles, users, and more.


🚀 Installation

You can install the package locally using pip:

pip install jmq_chirpstack

Or directly from the repository:

pip install git+https://github.com/juaquicar/jmq_chirpstack.git

🧰 Requirements

  • Python >= 3.6
  • Access to the ChirpStack API with a valid API Key
  • Version: v4.11.1 Testeada

📦 Usage

from jmq_chirpstack import JMQChirpstackAPI

api = JMQChirpstackAPI(
    base_url="http://127.0.0.1:8090/api",
    api_key="YOUR_API_KEY"
)

tenants = api.get_tenants()
print("Tenants:", tenants)

🧪 Available Features

  • get_tenants()
  • get_gateways(tenant_id)
  • get_gateway(gateway_id)
  • get_applications(tenant_id)
  • get_application(application_id)
  • get_devices(application_id)
  • get_device(dev_eui)
  • get_device_profiles(tenant_id)
  • get_device_profile(device_profile_id)
  • get_users()
  • get_multicast_groups(application_id)

📜 License

This project is licensed under the MIT License – see the LICENSE file for details.


👤 Author

Juanma Quijada
📧 quijada.jm@gmail.com
🔗 GitHub


🌐 Useful Resources


Metadata

Release files for jmq-chirpstack 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jmq-chirpstack 0.1.0
File Size Uploaded
jmq_chirpstack-0.1.0.tar.gz 4.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for jmq-chirpstack 0.1.0
File Interpreter ABI Platform
jmq_chirpstack-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 9.0 kB

Release files / jmq_chirpstack-0.1.0.tar.gz

Download URL jmq_chirpstack-0.1.0.tar.gz
Size 4.6 kB
Tags Source
SHA-256 checksum
How to use checksums
8f3560b8586ed5b99adfe8d0ef14fd461cf9dddde3a409b5ba31c964a7909e06
BLAKE2b-256 checksum
How to use checksums
ddee2a95e3751a153452dea6368c674bf2a81edac6001923c6d62d6f5fbd1f47
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release files / jmq_chirpstack-0.1.0-py3-none-any.whl

Download URL jmq_chirpstack-0.1.0-py3-none-any.whl
Size 4.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6a021bb4160268de23f4cc43d31d54b7fa78c76f6c491b1805293eb22c15316b
BLAKE2b-256 checksum
How to use checksums
f3a322b4a2fa0119ea8f7ed76af2de297536d1e07480d693e98b52ff23465a9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page