Metadata-Version: 2.1
Name: frequenz-api-dispatch
Version: 0.12.0
Summary: Frequenz gRPC API to propagate dispatches to microgrids
Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
License: MIT
Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-api-dispatch/releases
Project-URL: Issues, https://github.com/frequenz-floss/frequenz-api-dispatch/issues
Project-URL: Repository, https://github.com/frequenz-floss/frequenz-api-dispatch
Project-URL: Support, https://github.com/frequenz-floss/frequenz-api-dispatch/discussions/categories/support
Keywords: frequenz,python,api,grpc,protobuf,rpc,dispatch,cloud,microgrid
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: <4,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: frequenz-api-common <0.4.0,>=0.3.1
Requires-Dist: googleapis-common-protos <2,>=1.56.2
Requires-Dist: grpcio <2,>=1.51.1
Provides-Extra: dev
Requires-Dist: frequenz-api-dispatch[dev-docstrings,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest] ; extra == 'dev'
Provides-Extra: dev-docstrings
Requires-Dist: pydocstyle ==6.3.0 ; extra == 'dev-docstrings'
Requires-Dist: darglint ==1.8.1 ; extra == 'dev-docstrings'
Requires-Dist: tomli ==2.0.1 ; extra == 'dev-docstrings'
Provides-Extra: dev-formatting
Requires-Dist: black ==23.9.1 ; extra == 'dev-formatting'
Requires-Dist: isort ==5.12.0 ; extra == 'dev-formatting'
Provides-Extra: dev-mkdocs
Requires-Dist: mike ==1.1.2 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-gen-files ==0.5.0 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-literate-nav ==0.6.1 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-material ==9.3.2 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-section-index ==0.3.5 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocstrings[python] ==0.23.0 ; extra == 'dev-mkdocs'
Requires-Dist: frequenz-repo-config[api] ==0.5.2 ; extra == 'dev-mkdocs'
Provides-Extra: dev-mypy
Requires-Dist: mypy ==1.5.1 ; extra == 'dev-mypy'
Requires-Dist: frequenz-api-dispatch[dev-mkdocs,dev-noxfile,dev-pytest] ; extra == 'dev-mypy'
Provides-Extra: dev-noxfile
Requires-Dist: nox ==2023.4.22 ; extra == 'dev-noxfile'
Requires-Dist: frequenz-repo-config[api] ==0.5.2 ; extra == 'dev-noxfile'
Provides-Extra: dev-pylint
Requires-Dist: pylint ==2.17.6 ; extra == 'dev-pylint'
Requires-Dist: frequenz-api-dispatch[dev-mkdocs,dev-noxfile,dev-pytest] ; extra == 'dev-pylint'
Provides-Extra: dev-pytest
Requires-Dist: pytest ==7.4.2 ; extra == 'dev-pytest'
Requires-Dist: frequenz-repo-config[extra-lint-examples] ==0.5.2 ; extra == 'dev-pytest'

# Frequenz Dispatch API

[![Build Status](https://github.com/frequenz-floss/frequenz-api-dispatch/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-api-dispatch/actions/workflows/ci.yaml)
[![PyPI Package](https://img.shields.io/pypi/v/frequenz-api-dispatch)](https://pypi.org/project/frequenz-api-dispatch/)
[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-api-dispatch/)

## Introduction

Frequenz gRPC API to propagate dispatches to microgrids.

Dispatches might include, for example:

* Hard shutdown of a location or an individual microgrid component
* Charging or discharging a battery
* Activation or deactivation of balancing power
* Activation or deactivation of a power plant

Microgrid controllers are expected to regularly query this API to keep up to
date with what resources the cloud wishes them to deploy.

## Contributing

If you want to know how to build this project and contribute to it, please
check out the [Contributing Guide](CONTRIBUTING.md).
