Skip to main content

EngineAI's Platform SDK

Project description

Engine AI Platform SDK

PyPI version Python versions License: MIT

A powerful Python library for building data-driven applications and interactive dashboards. The Engine AI Platform SDK empowers developers to transform raw data into compelling visualizations and insights with minimal effort.

🚀 Features

  • Extensive Widget Library: Charts, tables, maps, tiles, and more
  • Flexible Layouts: Grid systems, cards, tabs, and collapsible sections
  • Data Connectors: Built-in support for DuckDB, Snowflake, and HTTP APIs
  • Interactive Components: Buttons, selectors, search, and navigation
  • Time Series Support: Advanced time-based visualizations with playback
  • Geographic Visualizations: Maps with country-level data and styling
  • Command Line Interface: Streamlined workflow for dashboard management

📋 Requirements

  • Python 3.10 or higher

🛠️ Installation

Install the SDK from PyPI:

pip install engineai.sdk

Or use uv for faster installation:

uv add engineai.sdk

🎯 Quick Start

1. Create or select a workspace: Set up your organizational container (authentication will be handled automatically)

engineai workspace create my-workspace "My Workspace"

2. Create an application: Set up a container for your dashboards

engineai app create my-workspace my-app "My App"

3. Create a dashboard: Set up a dashboard

engineai dashboard create my-workspace my-app first-dashboard "My First Dashboard"

4. Build Your Dashboard

Create a python file dashboard.py to customize your dashboard:

"""My first dashboard using Engine AI SDK."""

import pandas as pd

from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import pie

data = pd.DataFrame(
    {
        "region": [
            "North America",
            "Europe",
            "Asia Pacific",
            "Latin America",
            "Africa",
        ],
        "sales": [45000, 32000, 28000, 15000, 8000],
    }
)

pie_widget = pie.Pie(
    data=data,
    title="Sales by Region - Q4 2024",
    series=pie.Series(
        category_column="region",  # This column defines the pie slices
        data_column="sales",  # This column defines the slice sizes
    ),
)

if __name__ == "__main__":
    Dashboard(
        workspace_slug="my-workspace",
        app_slug="my-app",
        slug="first-dashboard",
        content=pie_widget,
    )

2. Publish Your Dashboard

Deploy your dashboard to the Engine AI platform:

python dashboard.py

Congratulations! 🎉 You've successfully created your first interactive dashboard with the Engine AI SDK. This minimal example demonstrates how easy it is to get started with data visualization using the Engine AI platform.

📖 Documentation

📄 License

This project is licensed under the MIT License.

🤝 Support


Built by the Engine AI team

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

engineai_sdk-0.136.6.tar.gz (195.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

engineai_sdk-0.136.6-py3-none-any.whl (436.9 kB view details)

Uploaded Python 3

File details

Details for the file engineai_sdk-0.136.6.tar.gz.

File metadata

  • Download URL: engineai_sdk-0.136.6.tar.gz
  • Upload date:
  • Size: 195.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for engineai_sdk-0.136.6.tar.gz
Algorithm Hash digest
SHA256 e53e63b76a7223b19ff5b6efbd658ec5a1210a8b3be9e79abe9c66b46d864acb
MD5 48e2fba45e3570a3239e3461c8377699
BLAKE2b-256 e4f5c2945db680897f44a1021c3a0f33e21651b69b41609b1effcc333af38f9f

See more details on using hashes here.

Provenance

The following attestation bundles were made for engineai_sdk-0.136.6.tar.gz:

Publisher: release-production.yaml on engineai-dev/platform-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file engineai_sdk-0.136.6-py3-none-any.whl.

File metadata

  • Download URL: engineai_sdk-0.136.6-py3-none-any.whl
  • Upload date:
  • Size: 436.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for engineai_sdk-0.136.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8b062220b338c065da4effe8af2af92cbcd262b1678f0bd4eec783298523fd2a
MD5 7b293072ed805419ba9bf432646f5196
BLAKE2b-256 7815dbc66a74a1fe6f4fa1d6eae784883f69ff33a0fbcd015b8d7ed04d52665b

See more details on using hashes here.

Provenance

The following attestation bundles were made for engineai_sdk-0.136.6-py3-none-any.whl:

Publisher: release-production.yaml on engineai-dev/platform-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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