meow-sdk 0.7.0

Python SDK for the Meow Meow Scratch® API

Build your own APIs and send data from your Raspberry Pi, Arduino, or any Python project.

Docs · Getting Started · API Reference · CLI Reference

Install

pip install meow-sdk

30-second quickstart

from meow_sdk import Meow

# 1. Connect with your API key
api = Meow(api_key="YOUR_PLATFORM_TOKEN")

# 2. Check capacity, then send data
print(api.limits())
api.send("weather-station", "readings", {
    "temperature": 22.5,
    "humidity": 65,
})

# 3. Read it back
data = api.records("weather-station", "readings")
print(data["results"])

Get your API key at meowmeowscratch.com under Account > Platform Tokens.

Read public data (no key needed)

Anyone can read public endpoints using a username:

api = Meow(username="jake")

data = api.get("weather-station", "readings")
print(data)

Your public API lives at: https://meowmeowscratch.com/api/v1/<username>/<app>/<endpoint>/

Raspberry Pi

Read a sensor and send data every 10 seconds:

import time
import adafruit_dht
import board
from meow_sdk import Meow

sensor = adafruit_dht.DHT22(board.D4)
# Use an app API key on a deployed device so it can access only this app.
api = Meow(api_key="YOUR_APP_API_KEY")

while True:
    try:
        api.send("my-pi", "sensors", {
            "temperature": sensor.temperature,
            "humidity": sensor.humidity,
        })
        print(f"{sensor.temperature}°C, {sensor.humidity}%")
    except Exception as e:
        print(f"Sensor error: {e}")

    time.sleep(10)

See the Raspberry Pi guide for more examples (buttons, LEDs, camera, systemd).

Control panels

Build real-time dashboards with interactive widgets:

api = Meow(api_key="YOUR_PLATFORM_TOKEN")

# Create a dashboard
api.create_dashboard("My Room", "my-room")

# Add a light switch
api.create_dashboard_widget(
    "my-room", "home", "settings",
    "lights.on", "toggle", "Bedroom Lights"
)

# Toggle it from your Pi
state = api.dashboard_state("my-room")
widget_uuid = state["widgets"][0]["uuid"]
api.set_dashboard_widget_value("my-room", widget_uuid, True)

Widget types: toggle, slider, color, number, text, select, display.

CLI

The SDK includes a full CLI. Configure it once:

export MEOW_PLATFORM_API_KEY=YOUR_PLATFORM_TOKEN
export MEOW_APP_API_KEY=YOUR_APP_API_KEY
export MEOW_USERNAME=jake

Then use it:

# Send data
meow send weather-station readings temperature=22.5 humidity=65

# Read data
meow get weather-station readings

# List your apps
meow apps

# Export as CSV
meow csv weather-station readings

# Manage dashboards
meow dashboards
meow dashboard-data my-room
meow widget-set my-room WIDGET_UUID true

See the CLI reference for all 55 commands.

Error handling

from meow_sdk import Meow, AuthError, NotFoundError, MeowError

api = Meow(api_key="YOUR_PLATFORM_TOKEN")

try:
    api.send("my-app", "readings", {"value": 42})
except AuthError:
    print("Bad API key")
except NotFoundError:
    print("App or endpoint doesn't exist")
except MeowError as e:
    print(f"API error {e.status_code}: {e}")

What you can do

Links

• Full documentation
• API reference
• CLI reference
• Raspberry Pi guide
• GitHub
• PyPI

License

MIT