telemetryharborsdk 1.0.0

DEPRECATED: Please use 'harborscalesdk' instead.

Harbor Scale Python SDK

The Easiest Way to Visualize Python Data 🚀

Stop managing InfluxDB and Grafana containers.

The Harbor Scale SDK lets you send telemetry from any Python application (Raspberry Pi, Servers, Desktop scripts) to a fully managed Grafana dashboard in 1 line of code.

• ⚡ Instant Visualization: Data appears on your hosted Grafana dashboard in milliseconds.
• 💾 Infinite Storage: We handle the time-series database for you.
• 🔌 Zero Config: No Docker, no ports, no firewall rules. Just pip install.

👉 Get your Free API Key at harborscale.com

---

Installation

pip install harborscalesdk

---

30-Second Quickstart

1. Get a Key: Sign up at harborscale.com (Free Tier includes 3M data points).
2. Run this script:

from harborscalesdk import HarborClient, GeneralReading

# 1. Initialize (Replace with your actual ID and Key)
client = HarborClient(
    endpoint="https://harborscale.com/api/v2/ingest/YOUR_HARBOR_ID",
    api_key="sk_live_..."
)

# 2. Send Data (No database schema required)
client.send(GeneralReading(
    ship_id="raspberry-pi-4",    # Your Device Name
    cargo_id="temperature",      # Your Metric Name
    value=42.5
))

print("Data sent! Check your Grafana dashboard.")

---

Advanced Usage

Sending Batches (Faster)

If you have high-frequency data, use send_batch to upload multiple readings in one HTTP request.

batch = [
    GeneralReading(ship_id="sensor-1", cargo_id="temp", value=22.5),
    GeneralReading(ship_id="sensor-1", cargo_id="humidity", value=60.1),
    GeneralReading(ship_id="sensor-1", cargo_id="voltage", value=3.3),
]

client.send_batch(batch)

Logging GPS Data

Harbor Scale automatically groups GPS data for map visualizations. Send latitude and longitude as separate metrics with the same timestamp.

# The SDK handles the timestamps automatically if you don't provide one
client.send_batch([
    GeneralReading(ship_id="truck-01", cargo_id="latitude", value=41.123),
    GeneralReading(ship_id="truck-01", cargo_id="longitude", value=29.456)
])

Pro Tip: In Grafana, use the "Geomap" panel to visualize this instantly.

---

Features

• ✅ Pydantic Validation: Never send bad data again.
• ✅ Auto-Retry: Built-in exponential backoff for flaky networks (perfect for IoT/Edge).
• ✅ Async Ready: Designed for high-throughput logging.
• ✅ Type Hinting: Full support for modern Python IDEs.

---

Need Help?

• 📚 Documentation: docs.harborscale.com
• 💬 Support: [e-mail]
• 🐛 Issues: GitHub Issues