Metadata-Version: 2.4
Name: frequenz-api-dispatch
Version: 1.1.0
Summary: Frequenz gRPC API to propagate dispatches to microgrids
Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
License-Expression: MIT
Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-api-dispatch/
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: 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<1.0,>=0.8.2
Requires-Dist: googleapis-common-protos<2,>=1.75.1
Requires-Dist: protobuf<9,>=7.36.1
Requires-Dist: grpcio<2,>=1.83.1
Provides-Extra: dev-flake8
Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
Requires-Dist: flake8-datetimez==26.8.1; extra == "dev-flake8"
Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
Requires-Dist: flake8-pyproject==1.2.4; extra == "dev-flake8"
Requires-Dist: pydoclint==0.9.1; extra == "dev-flake8"
Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
Provides-Extra: dev-formatting
Requires-Dist: black==26.5.1; extra == "dev-formatting"
Requires-Dist: isort==9.0.1; extra == "dev-formatting"
Provides-Extra: dev-mkdocs
Requires-Dist: black==26.5.1; extra == "dev-mkdocs"
Requires-Dist: Markdown==3.10.3; extra == "dev-mkdocs"
Requires-Dist: mike==2.2.0; extra == "dev-mkdocs"
Requires-Dist: mkdocs-gen-files==0.6.1; extra == "dev-mkdocs"
Requires-Dist: mkdocs-literate-nav==0.6.3; extra == "dev-mkdocs"
Requires-Dist: mkdocs-macros-plugin==1.5.0; extra == "dev-mkdocs"
Requires-Dist: mkdocs-material==9.7.7; extra == "dev-mkdocs"
Requires-Dist: mkdocstrings[python]==1.0.6; extra == "dev-mkdocs"
Requires-Dist: mkdocstrings-python==2.0.7; extra == "dev-mkdocs"
Requires-Dist: frequenz-repo-config[api]==0.19.0; extra == "dev-mkdocs"
Provides-Extra: dev-mypy
Requires-Dist: mypy==2.3.1; extra == "dev-mypy"
Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
Requires-Dist: types-Markdown==3.10.2.20260712; extra == "dev-mypy"
Requires-Dist: frequenz-api-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
Provides-Extra: dev-noxfile
Requires-Dist: nox==2026.8.17; extra == "dev-noxfile"
Requires-Dist: frequenz-repo-config[api]==0.19.0; extra == "dev-noxfile"
Provides-Extra: dev-pylint
Requires-Dist: pylint==4.0.8; extra == "dev-pylint"
Requires-Dist: frequenz-api-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
Provides-Extra: dev-pytest
Requires-Dist: pytest==9.1.1; extra == "dev-pytest"
Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.19.0; extra == "dev-pytest"
Provides-Extra: dev
Requires-Dist: frequenz-api-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
Dynamic: license-file

# 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.

Also checkout the [high-level overview](https://github.com/frequenz-floss/frequenz-sdk-python/wiki/APIs-stack-and-repositories-structure) of the various api repositories and how they work together

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).
