diff --git a/README.md b/README.md index ac2d0ccc..08865cc8 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,54 @@ # 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 Package](https://img.shields.io/pypi/v/frequenz-client-dispatch)](https://pypi.org/project/frequenz-client-dispatch/) -[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-client-dispatch-python/) +[![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 +## 🚀 Introduction -Dispatch API client for Python +Welcome to the **Frequenz Dispatch Client Library**—your go-to Python client for low-level interactions with the Frequenz Dispatch API! -## Supported Platforms +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). -The following platforms are officially supported (tested): +## 📦 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 Client +import asyncio + +async def print_dispatches(): + # Initialize the client + client = Client(key="your_api_key", server_url="grpc://fz-0004.frequenz.io") + + # 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.Client). + +## 🌐 Supported Platforms + +We officially support and test the following platforms: - **Python:** 3.11 - **Operating System:** Ubuntu Linux 20.04 - **Architectures:** amd64, arm64 -## Contributing +## 🤝 Contributing -If you want to know how to build this project and contribute to it, please -check out the [Contributing Guide](CONTRIBUTING.md). +We welcome contributions! If you're interested in building or improving this project, please read our [Contributing Guide](CONTRIBUTING.md) to get started. diff --git a/src/frequenz/client/dispatch/_client.py b/src/frequenz/client/dispatch/_client.py index 1fbd69ef..e2db9499 100644 --- a/src/frequenz/client/dispatch/_client.py +++ b/src/frequenz/client/dispatch/_client.py @@ -249,9 +249,6 @@ async def create( # pylint: disable=too-many-positional-arguments ) -> Dispatch: """Create a dispatch. - Will try to return the created dispatch, identifying it by - the same fields as the request. - Args: microgrid_id: The microgrid_id to create the dispatch for. type: User defined string to identify the dispatch type.