frequenz-client-dispatch 0.11.4

Dispatch API client for Python

Frequenz Dispatch Client Library

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

📦 Installation

Install the library via pip:

pip install frequenz-client-dispatch

🛠️ Usage

Here's a quick example to get you started:

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.

🌐 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 to get started.