pitop 0.20.3

pi-top Python SDK

pi-top Python SDK (Preview)

A simple, modular interface for interacting with a pi-top and its related accessories and components.

Supports all pi-top devices:

Supports pi-top Maker Architecture (PMA):

Supports all pi-top peripherals:

Status: Active Development

This SDK is currently in active development. Please be patient while we work towards v1.0.0!

Backwards Compatibility

When this library reaches v1.0.0, we will aim to maintain backwards-compatibility thereafter. Until then, every effort will be made to ensure stable support, but it cannot be guaranteed. Breaking changes will be clearly documented.

About

This SDK aims to provide an easy-to-use framework for managing a pi-top. It includes a Python 3 package (pitop), with several modules for interfacing with a range of pi-top devices and peripherals It also contains CLI utilities, to interact with your pi-top using the terminal.

The SDK is included out-of-the-box with pi-topOS.

Ensure that you keep your system up-to-date to enjoy the latest features and bug fixes.

This library is installed as a Python 3 module called pitop. It includes several submodules that allow you to easily interact with most of the hardware inside a pi-top.

You can easily connect different components of the system using the modules available in the library:

from time import sleep
from pitop import UltrasonicSensor
from pitop import Pitop

pitop = Pitop()
utrasonic = UltrasonicSensor("D1")

while True:
    pitop.miniscreen.display_text(utrasonic.distance)
    sleep(0.1)

Check out the API Recipes chapter of the documentation for ideas on how to get started.

This repository also contains a ‘pi-top’ command-line interface (CLI) for some SDK functionality:

$ pi-top oled write "Hey! I'm a $(pt devices hub)"

A ‘pt’ alias is also provided for quicker typing:

$ pt oled write "Hey! I'm a $(pt devices hub)"

Check out the CLI chapter of the documentation for ideas on how to get started.

Installation

The pi-top Python SDK is installed out of the box with pi-topOS, which is available from pi-top.com. To install on Raspberry Pi OS or other operating systems, see the Getting Started chapter.

Documentation

Comprehensive documentation is available here.

Development

To make changes to the SDK you’ll want to install it from source with the documentation and test dependencies:

git clone https://github.com/pi-top/pi-top-Python-SDK.git
cd pi-top-Python-SDK
pip3 install -e ".[doc,test]"

Changes you make to the source will be reflected in your Python environment.

You may want to repeat this process for the pi-top-Python-Common-Library if it’s not installed already or you need to make changes there too.

Once the SDK is installed you can run the automated test suite with:

python3 -m pytest

And you can build the docs locally by running:

PYTHONPATH=. sphinx-build -W -v -bhtml docs/ build/html

To view the generated docs open the build/html/index.html file in your browser.

Most of the SDK requires pi-top hardware to work but it should be possible to run the tests and build documentation in any environment with Python3.

Contributing

Please refer to the Contributing document in this repository for information on contributing to the project.

See the contributors page on GitHub for more info on contributors.