Metadata-Version: 2.1
Name: grpc-helper-api
Version: 2.0.4
Summary: API module for grpc_helper
Home-page: https://github.com/dynod/grpc-helper-api
Author: The dynod project
Maintainer: The dynod project
License: Mozilla Public License Version 2.0
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown
Requires-Dist: grpcio
Requires-Dist: protobuf

# grpc-helper-api

<!-- NMK-BADGES-BEGIN -->
[![License: MPL](https://img.shields.io/github/license/dynod/grpc-helper-api)](https://github.com/dynod/grpc-helper-api/blob/main/LICENSE)
[![Checks](https://img.shields.io/github/actions/workflow/status/dynod/grpc-helper-api/build.yml?branch=main&label=build%20%26%20u.t.)](https://github.com/dynod/grpc-helper-api/actions?query=branch%3Amain)
[![Issues](https://img.shields.io/github/issues-search/dynod/grpc-helper?label=issues&query=is%3Aopen+is%3Aissue+label%3Aapi)](https://github.com/dynod/grpc-helper/issues?q=is%3Aopen+is%3Aissue+label%3Aapi)
[![Supported python versions](https://img.shields.io/badge/python-3.8%20--%203.11-blue)](https://www.python.org/)
[![PyPI](https://img.shields.io/pypi/v/grpc-helper-api)](https://pypi.org/project/grpc-helper-api/)
[![Code generated for GRPC framework](https://img.shields.io/badge/code%20generation-proto-blue)](https://protobuf.dev/)
<!-- NMK-BADGES-END -->

Shared API files for [GRPC helpers](https://github.com/dynod/grpc-helper)

## Common API

The [common.proto](https://github.com/dynod/grpc-helper-api/blob/main/protos/grpc_helper_api/common.proto) file provides reusable API elements for other services (error codes, return status, etc)

## Server handling API

This API defines a [server handling service](https://github.com/dynod/grpc-helper-api/blob/main/doc/server.md) that can be used to fetch services/components information, and control global server behaviors.

## Config API

This API defines a [config service](https://github.com/dynod/grpc-helper-api/blob/main/doc/config.md) that handles configuration items.

## Logger API

This API defines a [logger service](https://github.com/dynod/grpc-helper-api/blob/main/doc/logger.md) that handles loggers configuration.

## Event API

This API defines an [events service](https://github.com/dynod/grpc-helper-api/blob/main/doc/events.md) that handles a generic event system.


