Metadata-Version: 2.4
Name: frequenz-client-dispatch
Version: 0.11.4
Summary: Dispatch API client for Python
Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
License: MIT
Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-client-dispatch-python/
Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-client-dispatch-python/releases
Project-URL: Issues, https://github.com/frequenz-floss/frequenz-client-dispatch-python/issues
Project-URL: Repository, https://github.com/frequenz-floss/frequenz-client-dispatch-python
Project-URL: Support, https://github.com/frequenz-floss/frequenz-client-dispatch-python/discussions/categories/support
Keywords: frequenz,python,lib,library,dispatch-client,dispatch,client,api,python
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: typing-extensions<5,>=4.13.0
Requires-Dist: frequenz-api-dispatch<2,>=1.0.0-rc3
Requires-Dist: frequenz-client-base<0.12.0,>=0.11.0
Requires-Dist: frequenz-client-common<0.4.0,>=0.3.6
Requires-Dist: frequenz-core<2.0.0,>=1.0.2
Requires-Dist: grpcio<2,>=1.72.1
Requires-Dist: python-dateutil<3.0,>=2.8.2
Provides-Extra: cli
Requires-Dist: asyncclick==8.2.2.2; extra == "cli"
Requires-Dist: prompt-toolkit==3.0.52; extra == "cli"
Requires-Dist: parsedatetime==2.6; extra == "cli"
Requires-Dist: tzlocal==5.3.1; extra == "cli"
Provides-Extra: dev-flake8
Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
Requires-Dist: pydoclint==0.7.3; extra == "dev-flake8"
Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
Provides-Extra: dev-formatting
Requires-Dist: black==25.9.0; extra == "dev-formatting"
Requires-Dist: isort==6.0.1; extra == "dev-formatting"
Provides-Extra: dev-mkdocs
Requires-Dist: black==25.9.0; extra == "dev-mkdocs"
Requires-Dist: Markdown==3.9; extra == "dev-mkdocs"
Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
Requires-Dist: frequenz-api-dispatch==1.0.0-rc3; extra == "dev-mkdocs"
Requires-Dist: mkdocs-macros-plugin==1.4.0; extra == "dev-mkdocs"
Requires-Dist: mkdocs-material==9.6.21; extra == "dev-mkdocs"
Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-mkdocs"
Provides-Extra: dev-mypy
Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
Requires-Dist: types-Markdown==3.9.0.20250906; extra == "dev-mypy"
Requires-Dist: frequenz-client-dispatch[cli,dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
Requires-Dist: types-protobuf==6.32.1.20250918; extra == "dev-mypy"
Requires-Dist: types-python-dateutil==2.9.0.20250822; extra == "dev-mypy"
Provides-Extra: dev-noxfile
Requires-Dist: nox==2025.5.1; extra == "dev-noxfile"
Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-noxfile"
Provides-Extra: dev-pylint
Requires-Dist: pylint==3.3.9; extra == "dev-pylint"
Requires-Dist: frequenz-client-dispatch[cli,dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
Requires-Dist: frequenz-api-dispatch==1.0.0-rc3; extra == "dev-pylint"
Provides-Extra: dev-pytest
Requires-Dist: pytest==8.4.2; extra == "dev-pytest"
Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.5; extra == "dev-pytest"
Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
Requires-Dist: pytest-asyncio==1.2.0; extra == "dev-pytest"
Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
Requires-Dist: time-machine==2.19.0; extra == "dev-pytest"
Requires-Dist: hypothesis==6.140.3; extra == "dev-pytest"
Requires-Dist: frequenz-client-dispatch[cli]; extra == "dev-pytest"
Provides-Extra: dev
Requires-Dist: frequenz-client-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
Dynamic: license-file

# Frequenz Dispatch Client Library

[![Build Status](https://github.com/frequenz-floss/frequenz-client-dispatch-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-client-dispatch-python/actions/workflows/ci.yaml)
[![PyPI Version](https://img.shields.io/pypi/v/frequenz-client-dispatch)](https://pypi.org/project/frequenz-client-dispatch/)
[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen)](https://frequenz-floss.github.io/frequenz-client-dispatch-python/)

## 🚀 Introduction

Welcome to the **Frequenz Dispatch Client Library**—your go-to Python client for low-level interactions with the Frequenz Dispatch API!

If you're a developer who needs direct access to the [Dispatch API](https://github.com/frequenz-floss/frequenz-dispatch-api) without the abstraction layers of the high-level client, you're in the right place. This library serves as the foundation for our more feature-rich and user-friendly [high-level client](https://github.com/frequenz-floss/frequenz-dispatch-python).

## 📦 Installation

Install the library via pip:

```bash
pip install frequenz-client-dispatch
```

## 🛠️ Usage

Here's a quick example to get you started:

```python
from frequenz.client.dispatch import DispatchApiClient
import asyncio

async def print_dispatches():
    # Initialize the client
    client = DispatchApiClient(key="your_api_key", server_url="grpc://dispatch.url.goes.here.example.com")

    # List all dispatches for a specific microgrid
    async for page in client.list(microgrid_id=1):
        for dispatch in page:
            print(dispatch)

# Run the Example
asyncio.run(print_dispatches())
```

For detailed usage and advanced features, check out the [client documentation](https://frequenz-floss.github.io/frequenz-client-dispatch-python/latest/reference/frequenz/client/dispatch/#frequenz.client.dispatch.ApiDispatchClient).

## 🌐 Supported Platforms

We officially support and test the following platforms:

- **Python:** 3.11
- **Operating System:** Ubuntu Linux 20.04
- **Architectures:** amd64, arm64

## 🤝 Contributing

We welcome contributions! If you're interested in building or improving this project, please read our [Contributing Guide](CONTRIBUTING.md) to get started.
