Skip to main content

chirpstack-api

ChirpStack gRPC API message and service wrappers for Python.

Install

pip install chirpstack-api

Usage

All messages, services, constants, etc. are auto-generated from the ChirpStack protobuf definitions. The result is that this package structure matches that of the protobuf definitions.

The protobuf definitions can be found here: https://github.com/brocaar/chirpstack-api/tree/master/protobuf

The following example presents how the library can be used.

Example

This example shows how to log in to ChirpStack via the gRPC API and then create a gRPC metadata list containing the JWT. This metadata could then be passed to any future requests that require authorization.

import grpc
import os
import sys
from chirpstack_api.as_pb.external import api

if __name__ == '__main__':
  # Create the client for the "internal" service    
  channel = grpc.insecure_channel('localhost:8080')
  stub = api.InternalServiceStub(channel)

  # Create and build the login request message
  loginRequest = api.LoginRequest()
  loginRequest.password = 'admin'
  loginRequest.username = 'admin'

  # Send the login request
  token = stub.Login(loginRequest)

  # Build the metadata list, settting the authorization from the JWT
  # obtained from loggin in.
  metadata= [('authorization', token.jwt)]

  # This metadata can now be passed for requests to APIs that require
  # authorization

Metadata

Release files for chirpstack-api 3.7.4

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

Source distribution (sdist)

Source distribution for chirpstack-api 3.7.4
File Size Uploaded
chirpstack-api-3.7.4.tar.gz 127.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for chirpstack-api 3.7.4
File Interpreter ABI Platform
chirpstack_api-3.7.4-py3-none-any.whl Python 3 none any Details

Total release size: 273.7 kB

Release files / chirpstack-api-3.7.4.tar.gz

Download URL chirpstack-api-3.7.4.tar.gz
Size 127.4 kB
Tags Source
SHA-256 checksum
How to use checksums
c0a7eed36f659f823d40088d7713bdbcc565df0c1aa48b156ef8c20aec31577b
BLAKE2b-256 checksum
How to use checksums
def4f81af91c1b3d7bc7548ad68b5f3dcfd195442f54aeb490e650cda4bd96c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

Release files / chirpstack_api-3.7.4-py3-none-any.whl

Download URL chirpstack_api-3.7.4-py3-none-any.whl
Size 146.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c94ed20e99586a861d39398c624b0f2c53eb478d974de1e650617bcbd6bc2313
BLAKE2b-256 checksum
How to use checksums
1cf1623ede212eb7d5c282f5c8aa75247e418876b908c60a0aeffb95de165389
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

Release history Release notifications | RSS feed

4.19.0

1 release file

4.18.0

1 release file

4.17.0

1 release file

4.16.2

1 release file

4.16.1

1 release file

4.16.0

1 release file

4.15.0

1 release file

4.14.1

1 release file

4.14.0

1 release file

4.13.0

1 release file

4.12.1

1 release file

4.12.0

1 release file

4.11.1

1 release file

4.11.0

1 release file

4.10.2

1 release file

4.10.1

1 release file

4.9.0

1 release file

4.8.1

1 release file

4.8.0

1 release file

4.7.0

1 release file

4.6.0

1 release file

4.5.1

1 release file

4.5.0

1 release file

4.4.0

1 release file

4.3.1

1 release file

4.3.0

1 release file

4.2.0

1 release file

4.1.1

1 release file

4.1.0

1 release file

4.0.3

1 release file

4.0.2

1 release file

4.0.0

1 release file

3.12.4

1 release file

3.11.1

1 release file

3.11.0

1 release file

3.10.1

1 release file

3.10.0

1 release file

3.9.11

1 release file

3.9.10

1 release file

3.9.9

1 release file

3.9.8

1 release file

3.9.7

1 release file

3.9.6

1 release file

3.9.5

1 release file

3.9.4

2 release files

3.9.3

2 release files

3.9.2

2 release files

3.9.1

2 release files

3.9.0

2 release files

3.8.1

2 release files

3.8.0

2 release files

3.7.8

2 release files

3.7.7

2 release files

3.7.6

2 release files

This release

3.7.4 This release

2 release files

3.7.3

2 release files

3.7.2

2 release files

3.7.1

2 release files

3.7.0

2 release files

3.6.12

2 release files

3.6.11

2 release files

3.6.10

2 release files

3.6.9

2 release files

3.6.8

2 release files

3.6.7

2 release files

3.6.6

2 release files

3.6.5

2 release files

3.6.4

2 release files

3.6.3

2 release files

3.6.2

2 release files

3.6.1

2 release files

3.6.0

1 release file

3.5.2

1 release file

3.5.1

1 release file

3.5.0

1 release file

3.4.2

1 release file

3.4.1

1 release file

3.3.2

2 release files

3.3.1

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.8

2 release files

3.1.7

2 release files

3.1.6

2 release files

3.1.5

2 release files

3.1.4

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