Skip to main content

Python SDK for reading and writing signals to Clarify.

Project description

Clarify logo


PyPI package Version number Downloads Downloads Actions Status License Code style: black

from pyclarify import Client

data = {
    "times": ["2022-10-10T00:00:00"],
    "series": {
        "temperature": [19],
        "pressure": [1025]

client = Client("credentials.json")

PyClarify helps users of Clarify to easily read, write and manipulate data in Clarify.

  • Data scientists can easily filter data, convert it to pandas with our built in methods, and write results back.
  • System integrators can set up pipelines for automatic streaming of data, and update labels on the fly.

Useful tutorials and documentation


In order to start using the Python SDK, you need

Where to get it

The source code is currently hosted on GitHub at:

Binary installers for the latest released version are available at the Python Package Index (PyPI).

# PyPI install
pip install pyclarify


  • requests - The most used (and trusted) HTTP library.
  • Pydantic - Allowing for strict typing and data validation.
  • Typing Extensions - Brings the typing use of new type system features on older Python versions, allowing us to support python 3.7+.

Interact with Clarify

PyClarify provides a fast and easy way to interact with Clarify. The Client class takes as an argument the path of your credentials in string format, which should always be the first step when starting to interact with PyClarify.

For information about the Clarify Developer documentation click here.


We recommend using Google Colab to quickly learn how to interact with Clarify using Python. We have created an interactive introduction tutorial where you will learn all the basics to get you started.

Open In Colab

Access you data with the ClarifyClient

from pyclarify import Client

client = Client("clarify-credentials.json")

Create new Signals

from pyclarify import Signal

signal = Signal(
    name = "Home temperature",
    description = "Temperature in the bedroom",
    labels = {"data-source": ["Raspberry Pi"], "location": ["Home"]}

response = client.save_signals(

Populate your signals using DataFrames

from pyclarify import DataFrame

data = DataFrame(
    series={"INPUT_ID_1": [1, None], "INPUT_ID_2": [None, 5]},
    times = ["2021-11-01T21:50:06Z",  "2021-11-02T21:50:06Z"],

response = client.insert(data)

Query your stored signals

response = client.select_signals(

Publish them as Items

from pyclarify import Item

client = Client("./clarify-credentials.json")

item = Item(
    name = "Home temperature",
    description = "Temperature in the bedroom",
    labels = {"data-source": ["Raspberry Pi"], "location": ["Home"]},
response = client.publish_signals(

Use filters to get a specific selection

from pyclarify.query import Filter, Regex

only_raspberries = Filter(
        "labels.unit-type": Regex(value="Raspberry")

response = client.select_items(

Get the data and include relationships

response = client.data_frame(

Look at our reference!


Wondering about upcoming or previous changes to the SDK? Take a look at the CHANGELOG.


Want to contribute? Check out CONTRIBUTING.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyclarify-0.5.0.tar.gz (39.5 kB view hashes)

Uploaded source

Built Distribution

pyclarify-0.5.0-py3-none-any.whl (55.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page