Metadata-Version: 2.1
Name: chirpstack-api
Version: 3.3.2
Summary: Chirpstack Python API
Home-page: https://github.com/brocaar/chirpstack-api
Author: Orne Brocaar
Author-email: info@brocaar.com
License: MIT
Description: # chirpstack-api
        
        ChirpStack gRPC API message and service wrappers for Python.
        
        ## Install
        
        ```sh
        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.
        
        ```python
        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
        
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Communications
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
