frequenz-client-dispatch


Namefrequenz-client-dispatch JSON
Version 0.8.1 PyPI version JSON
download
home_pageNone
SummaryDispatch API client for Python
upload_time2024-11-19 14:10:40
maintainerNone
docs_urlNone
authorNone
requires_python<4,>=3.11
licenseMIT
keywords frequenz python lib library dispatch-client dispatch client api python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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 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

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

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "frequenz-client-dispatch",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4,>=3.11",
    "maintainer_email": null,
    "keywords": "frequenz, python, lib, library, dispatch-client, dispatch, client, api, python",
    "author": null,
    "author_email": "Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>",
    "download_url": "https://files.pythonhosted.org/packages/5e/da/15dd547fbdc1a3dba4d2606b5ac1d3843a79a8f99270e936c313f3b2a898/frequenz-client-dispatch-0.8.1.tar.gz",
    "platform": null,
    "description": "# Frequenz Dispatch Client Library\n\n[![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)\n[![PyPI Version](https://img.shields.io/pypi/v/frequenz-client-dispatch)](https://pypi.org/project/frequenz-client-dispatch/)\n[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen)](https://frequenz-floss.github.io/frequenz-client-dispatch-python/)\n\n## \ud83d\ude80 Introduction\n\nWelcome to the **Frequenz Dispatch Client Library**\u2014your go-to Python client for low-level interactions with the Frequenz Dispatch API!\n\nIf 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).\n\n## \ud83d\udce6 Installation\n\nInstall the library via pip:\n\n```bash\npip install frequenz-client-dispatch\n```\n\n## \ud83d\udee0\ufe0f Usage\n\nHere's a quick example to get you started:\n\n```python\nfrom frequenz.client.dispatch import Client\nimport asyncio\n\nasync def print_dispatches():\n    # Initialize the client\n    client = Client(key=\"your_api_key\", server_url=\"grpc://fz-0004.frequenz.io\")\n\n    # List all dispatches for a specific microgrid\n    async for page in client.list(microgrid_id=1):\n        for dispatch in page:\n            print(dispatch)\n\n# Run the Example\nasyncio.run(print_dispatches())\n```\n\nFor 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).\n\n## \ud83c\udf10 Supported Platforms\n\nWe officially support and test the following platforms:\n\n- **Python:** 3.11\n- **Operating System:** Ubuntu Linux 20.04\n- **Architectures:** amd64, arm64\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions! If you're interested in building or improving this project, please read our [Contributing Guide](CONTRIBUTING.md) to get started.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Dispatch API client for Python",
    "version": "0.8.1",
    "project_urls": {
        "Changelog": "https://github.com/frequenz-floss/frequenz-client-dispatch-python/releases",
        "Documentation": "https://frequenz-floss.github.io/frequenz-client-dispatch-python/",
        "Issues": "https://github.com/frequenz-floss/frequenz-client-dispatch-python/issues",
        "Repository": "https://github.com/frequenz-floss/frequenz-client-dispatch-python",
        "Support": "https://github.com/frequenz-floss/frequenz-client-dispatch-python/discussions/categories/support"
    },
    "split_keywords": [
        "frequenz",
        " python",
        " lib",
        " library",
        " dispatch-client",
        " dispatch",
        " client",
        " api",
        " python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5b13e62d584f8459fcfedb4e207d879f55f6d37710a25b510cee8267e6929990",
                "md5": "3c00d303329a7c3fcad4df56a7cc5b96",
                "sha256": "5163ec8205f406f7c9a9a7fe2d428b96d72aa111f009b8f0a3581382f4bb330c"
            },
            "downloads": -1,
            "filename": "frequenz_client_dispatch-0.8.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3c00d303329a7c3fcad4df56a7cc5b96",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.11",
            "size": 29914,
            "upload_time": "2024-11-19T14:10:37",
            "upload_time_iso_8601": "2024-11-19T14:10:37.866076Z",
            "url": "https://files.pythonhosted.org/packages/5b/13/e62d584f8459fcfedb4e207d879f55f6d37710a25b510cee8267e6929990/frequenz_client_dispatch-0.8.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5eda15dd547fbdc1a3dba4d2606b5ac1d3843a79a8f99270e936c313f3b2a898",
                "md5": "966d565fecf85599bdc60a2210dba72b",
                "sha256": "220014aad385b65e7d0d0a5c0159aa1b2474a5e8d0f5557061a3469e3c9f88ba"
            },
            "downloads": -1,
            "filename": "frequenz-client-dispatch-0.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "966d565fecf85599bdc60a2210dba72b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.11",
            "size": 27007,
            "upload_time": "2024-11-19T14:10:40",
            "upload_time_iso_8601": "2024-11-19T14:10:40.032747Z",
            "url": "https://files.pythonhosted.org/packages/5e/da/15dd547fbdc1a3dba4d2606b5ac1d3843a79a8f99270e936c313f3b2a898/frequenz-client-dispatch-0.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-19 14:10:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "frequenz-floss",
    "github_project": "frequenz-client-dispatch-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "frequenz-client-dispatch"
}
None
Elapsed time: 0.82605s