Skip to content

Commit f45430d

Browse files
committed
Enhance readme, add links, reformat
Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent cf54baa commit f45430d

File tree

1 file changed

+36
-9
lines changed

1 file changed

+36
-9
lines changed

README.md

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,49 @@
11
# Frequenz Dispatch Client Library
22

33
[![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)
4-
[![PyPI Package](https://img.shields.io/pypi/v/frequenz-client-dispatch)](https://pypi.org/project/frequenz-client-dispatch/)
5-
[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-client-dispatch-python/)
4+
[![PyPI Version](https://img.shields.io/pypi/v/frequenz-client-dispatch)](https://pypi.org/project/frequenz-client-dispatch/)
5+
[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen)](https://frequenz-floss.github.io/frequenz-client-dispatch-python/)
66

7-
## Introduction
7+
## 🚀 Introduction
88

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

11-
## Supported Platforms
11+
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).
1212

13-
The following platforms are officially supported (tested):
13+
## 📦 Installation
14+
15+
Install the library via pip:
16+
17+
```bash
18+
pip install frequenz-client-dispatch
19+
```
20+
21+
## 🛠️ Usage
22+
23+
Here's a quick example to get you started:
24+
25+
```python
26+
from frequenz.client.dispatch import Client
27+
28+
# Initialize the client
29+
client = Client(key="your_api_key", server_url="grpc://fz-0004.frequenz.io")
30+
31+
# List all dispatches for a specific microgrid
32+
async for page in client.list(microgrid_id=1):
33+
for dispatch in page:
34+
print(dispatch)
35+
```
36+
37+
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).
38+
39+
## 🌐 Supported Platforms
40+
41+
We officially support and test the following platforms:
1442

1543
- **Python:** 3.11
1644
- **Operating System:** Ubuntu Linux 20.04
1745
- **Architectures:** amd64, arm64
1846

19-
## Contributing
47+
## 🤝 Contributing
2048

21-
If you want to know how to build this project and contribute to it, please
22-
check out the [Contributing Guide](CONTRIBUTING.md).
49+
We welcome contributions! If you're interested in building or improving this project, please read our [Contributing Guide](CONTRIBUTING.md) to get started.

0 commit comments

Comments
 (0)