{"id":21974255,"url":"https://github.com/frequenz-floss/frequenz-client-dispatch-python","last_synced_at":"2025-04-28T14:41:19.831Z","repository":{"id":220317315,"uuid":"750833415","full_name":"frequenz-floss/frequenz-client-dispatch-python","owner":"frequenz-floss","description":"Dispatch API client for Python","archived":false,"fork":false,"pushed_at":"2024-11-28T12:38:27.000Z","size":1895,"stargazers_count":0,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"v0.x.x","last_synced_at":"2024-11-28T13:28:53.106Z","etag":null,"topics":["api","client","dispatch","frequenz","lib","library","python"],"latest_commit_sha":null,"homepage":"https://frequenz-floss.github.io/frequenz-client-dispatch-python/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/frequenz-floss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-31T12:13:34.000Z","updated_at":"2024-11-28T12:29:24.000Z","dependencies_parsed_at":"2024-05-01T16:59:50.961Z","dependency_job_id":"12103695-0828-4319-bda0-a88ea716bd5b","html_url":"https://github.com/frequenz-floss/frequenz-client-dispatch-python","commit_stats":null,"previous_names":["frequenz-floss/frequenz-client-dispatch-python"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frequenz-floss%2Ffrequenz-client-dispatch-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frequenz-floss%2Ffrequenz-client-dispatch-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frequenz-floss%2Ffrequenz-client-dispatch-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frequenz-floss%2Ffrequenz-client-dispatch-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frequenz-floss","download_url":"https://codeload.github.com/frequenz-floss/frequenz-client-dispatch-python/tar.gz/refs/heads/v0.x.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227158115,"owners_count":17739620,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","client","dispatch","frequenz","lib","library","python"],"created_at":"2024-11-29T15:40:18.834Z","updated_at":"2024-11-29T15:40:19.549Z","avatar_url":"https://github.com/frequenz-floss.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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## 🚀 Introduction\n\nWelcome to the **Frequenz Dispatch Client Library**—your 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## 📦 Installation\n\nInstall the library via pip:\n\n```bash\npip install frequenz-client-dispatch\n```\n\n## 🛠️ 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## 🌐 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## 🤝 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrequenz-floss%2Ffrequenz-client-dispatch-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrequenz-floss%2Ffrequenz-client-dispatch-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrequenz-floss%2Ffrequenz-client-dispatch-python/lists"}