Metadata-Version: 2.1
Name: frequenz-sdk
Version: 0.24.0
Summary: A development kit to interact with the Frequenz development platform
Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
License: MIT
Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-sdk-python/releases
Project-URL: Issues, https://github.com/frequenz-floss/frequenz-sdk-python/issues
Project-URL: Repository, https://github.com/frequenz-floss/frequenz-sdk-python
Project-URL: Support, https://github.com/frequenz-floss/frequenz-sdk-python/discussions/categories/support
Keywords: frequenz,python,lib,library,sdk,microgrid
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: <4,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: frequenz-api-microgrid <0.16.0,>=0.15.1
Requires-Dist: frequenz-channels <0.17.0,>=0.16.0
Requires-Dist: google-api-python-client <3,>=2.71
Requires-Dist: grpcio <2,>=1.54.2
Requires-Dist: grpcio-tools <2,>=1.54.2
Requires-Dist: networkx <4,>=2.8
Requires-Dist: numpy <2,>=1.24.2
Requires-Dist: protobuf <5,>=4.21.6
Requires-Dist: pydantic <2,>=1.9
Requires-Dist: tqdm <5,>=4.38.0
Requires-Dist: typing-extensions <5,>=4.4.0
Requires-Dist: watchfiles >=0.15.0
Provides-Extra: dev
Requires-Dist: frequenz-sdk[dev-docstrings,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest] ; extra == 'dev'
Provides-Extra: dev-docstrings
Requires-Dist: pydocstyle ==6.3.0 ; extra == 'dev-docstrings'
Requires-Dist: darglint ==1.8.1 ; extra == 'dev-docstrings'
Requires-Dist: tomli ==2.0.1 ; extra == 'dev-docstrings'
Provides-Extra: dev-examples
Requires-Dist: polars ==0.18.13 ; extra == 'dev-examples'
Provides-Extra: dev-formatting
Requires-Dist: black ==23.7.0 ; extra == 'dev-formatting'
Requires-Dist: isort ==5.12.0 ; extra == 'dev-formatting'
Provides-Extra: dev-mkdocs
Requires-Dist: mike ==1.1.2 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-gen-files ==0.5.0 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-literate-nav ==0.6.0 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-material ==9.1.21 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocs-section-index ==0.3.5 ; extra == 'dev-mkdocs'
Requires-Dist: mkdocstrings[python] ==0.22.0 ; extra == 'dev-mkdocs'
Requires-Dist: frequenz-repo-config[lib] ==0.4.0 ; extra == 'dev-mkdocs'
Provides-Extra: dev-mypy
Requires-Dist: mypy ==1.4.1 ; extra == 'dev-mypy'
Requires-Dist: grpc-stubs ==1.24.12 ; extra == 'dev-mypy'
Requires-Dist: types-protobuf ==4.23.0.3 ; extra == 'dev-mypy'
Requires-Dist: frequenz-sdk[dev-mkdocs,dev-noxfile,dev-pytest] ; extra == 'dev-mypy'
Provides-Extra: dev-noxfile
Requires-Dist: nox ==2023.4.22 ; extra == 'dev-noxfile'
Requires-Dist: frequenz-repo-config[lib] ==0.4.0 ; extra == 'dev-noxfile'
Provides-Extra: dev-pylint
Requires-Dist: pylint ==2.17.5 ; extra == 'dev-pylint'
Requires-Dist: frequenz-sdk[dev-mkdocs,dev-noxfile,dev-pytest] ; extra == 'dev-pylint'
Provides-Extra: dev-pytest
Requires-Dist: pytest ==7.4.0 ; extra == 'dev-pytest'
Requires-Dist: pytest-mock ==3.11.1 ; extra == 'dev-pytest'
Requires-Dist: pytest-asyncio ==0.21.1 ; extra == 'dev-pytest'
Requires-Dist: time-machine ==2.11.0 ; extra == 'dev-pytest'
Requires-Dist: async-solipsism ==0.5 ; extra == 'dev-pytest'
Requires-Dist: sybil ==5.0.3 ; extra == 'dev-pytest'
Requires-Dist: pylint ==2.17.5 ; extra == 'dev-pytest'
Requires-Dist: frequenz-sdk[dev-examples] ; extra == 'dev-pytest'

# Frequenz Python SDK

[![Build Status](https://github.com/frequenz-floss/frequenz-sdk-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-sdk-python/actions/workflows/ci.yaml)
[![PyPI Package](https://img.shields.io/pypi/v/frequenz-sdk)](https://pypi.org/project/frequenz-sdk/)
[![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-sdk-python/)

## Introduction

A development kit to interact with the Frequenz development platform.

## Quick Start

We assume you are on a system with Python available. If that is not the case,
please [download and install Python](https://www.python.org/downloads/) first.

To install the SDK, you probably want to create a new virtual environment first.
For example, if you use a `sh` compatible shell, you can do this:

```sh
python3 -m venv .venv
. .venv/bin/activate
```

Then, just install using `pip`:

```sh
python3 -m pip install frequenz-sdk
```

## Documentation

For more information, please visit the [documentation
website](https://frequenz-floss.github.io/frequenz-sdk-python/).

## Contributing

If you want to know how to build this project and contribute to it, please
check out the [Contributing Guide](CONTRIBUTING.md).
