Metadata-Version: 2.1
Name: frequenz-sdk
Version: 1.0.0rc901
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: Documentation, https://frequenz-floss.github.io/frequenz-sdk-python/
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-client-microgrid<0.6.0,>=0.5.1
Requires-Dist: frequenz-channels<2.0.0,>=1.1.0
Requires-Dist: networkx<4,>=2.8
Requires-Dist: numpy<2,>=1.26.4
Requires-Dist: typing_extensions<5,>=4.6.1
Provides-Extra: dev-flake8
Requires-Dist: flake8==7.1.1; extra == "dev-flake8"
Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
Requires-Dist: pydoclint==0.5.6; extra == "dev-flake8"
Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
Provides-Extra: dev-formatting
Requires-Dist: black==24.8.0; extra == "dev-formatting"
Requires-Dist: isort==5.13.2; extra == "dev-formatting"
Provides-Extra: dev-mkdocs
Requires-Dist: black==24.8.0; extra == "dev-mkdocs"
Requires-Dist: Markdown==3.7; extra == "dev-mkdocs"
Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
Requires-Dist: mkdocs-literate-nav==0.6.1; extra == "dev-mkdocs"
Requires-Dist: mkdocs-macros-plugin==1.0.5; extra == "dev-mkdocs"
Requires-Dist: mkdocs-material==9.5.34; extra == "dev-mkdocs"
Requires-Dist: mkdocstrings[python]==0.25.2; extra == "dev-mkdocs"
Requires-Dist: mkdocstrings-python==1.10.9; extra == "dev-mkdocs"
Requires-Dist: frequenz-repo-config[lib]==0.10.0; extra == "dev-mkdocs"
Provides-Extra: dev-mypy
Requires-Dist: mypy==1.11.2; extra == "dev-mypy"
Requires-Dist: types-Markdown==3.7.0.20240822; extra == "dev-mypy"
Requires-Dist: types-protobuf==5.27.0.20240626; extra == "dev-mypy"
Requires-Dist: types-setuptools==74.0.0.20240831; extra == "dev-mypy"
Requires-Dist: frequenz-sdk[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
Provides-Extra: dev-noxfile
Requires-Dist: nox==2024.4.15; extra == "dev-noxfile"
Requires-Dist: frequenz-repo-config[lib]==0.10.0; extra == "dev-noxfile"
Provides-Extra: dev-pylint
Requires-Dist: pylint==3.2.7; extra == "dev-pylint"
Requires-Dist: frequenz-sdk[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
Provides-Extra: dev-pytest
Requires-Dist: pytest==8.3.2; extra == "dev-pytest"
Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.10.0; extra == "dev-pytest"
Requires-Dist: pytest-mock==3.14.0; extra == "dev-pytest"
Requires-Dist: pytest-asyncio==0.24.0; extra == "dev-pytest"
Requires-Dist: time-machine==2.12.0; extra == "dev-pytest"
Requires-Dist: async-solipsism==0.7; extra == "dev-pytest"
Requires-Dist: hypothesis==6.111.2; extra == "dev-pytest"
Provides-Extra: dev
Requires-Dist: frequenz-sdk[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"

# 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.

## Supported Platforms

The following platforms are officially supported (test):

- **Python:** 3.11, 3.12
- **Operating System:** Ubuntu Linux 20.04
- **Architectures:** amd64, arm64

## 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).
