openremote-client 1.0

Small client to connect to the OpenRemote Manager REST API

OpenRemote Client

A Python client to use the OpenRemote Manager REST API.

---

Getting started

1. Install package

pip install openremote_client

2. Then import the package into your project.

from openremote_client import OpenRemoteClient

3. Now initialize the OpenRemote client with some config.

or_client = OpenRemoteClient(
    openremote_host='<openremote_manager_url>',
    client_id='<openremote_client_id>',
    client_secret='<openremote_client_secret>'
)

Finally you can use the client to call the OpenRemote Manager REST API

# Get Asset by id
asset = await or_client.asset.get_by_id('<asset-id>')

# Query mulitple assets
asset = await or_client.asset.query({
    "limit": 5
})

The client handles authentication automatically.

Development guide

Installation

Prerequisites

• Python 3.10+ installed

1. Clone repository

git clone https://github.com/Spider-Frog/openremote_client.git

2. Install packages

pip install -r requirements.txt

Deploy

Read the documentation on PyPI