README.md

hyper-python-sdk

Python SDK for interacting with the Hyper.systems platform.

Check here for usage and other documentation.

Pypi.org:

Installing

Install the latest version globally using pip:

pip install -U hyper-systems

Adding as a dependency to your project

Add to requirements.txt for pip:

echo "hyper-systems==1.4.0" >> requirements.txt

Consider using venv, if you want to have an isolated environment for your project with pip.

Alternatively, install with poetry:

poetry add "hyper-systems==1.4.0"

Installing the latest development version of the package globally

$ pip install -U git+https://github.com/hyper-systems/hyper-python-sdk.git@master

Using this repo for development

This repo uses poetry (please check the docs) for development and building. It is currentlu set up to create a .venv directory in the root of this project on install.

Installing the environment:

$ poetry install

Shell usage

After installing you can use the environment created with poetry, for example to:

• update the environment:

$ poetry update

• execute scripts:

$ poetry run tests/test_devices.py

VSCode

You can also use the environment in VSCode by opening one of the python files in this repo and selecting the poetry python interpreter in the bottom left corner (('.venv': poetry)). You then reload the VSCode window (or open and close VSCode) and VSCode should be now using the .venv environment created by poetry.