Skip to content

frequenz-floss/frequenz-sdk-python

Repository files navigation

Frequenz Python SDK

Build Status PyPI Package Docs

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 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:

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

Then, just install using pip:

python3 -m pip install frequenz-sdk

Documentation

For more information, please visit the documentation website.

Contributing

If you want to know how to build this project and contribute to it, please check out the Contributing Guide.