Overview#
We’ve built the EngineAI Platform SDK as a powerful Python library for developing data-driven applications. Designed with both technical and non-technical users in mind, the SDK offers ease of use, an extensive catalog of widgets, and flexible layouts.
Getting Started#
The following documentation is organized into the following sections:
- Install: Installation and setup instructions
- Your First Dashboard: A step-by-step guide to creating your first dashboard
- Core Concepts: Detailed tutorials with examples for key parts of the SDK
- Troubleshoot: Common issues and solutions
- CLI (engineai): Command-line interface reference documentation
- API Reference: Complete reference documentation for the EngineAI Platform SDK
We welcome your questions, feedback, and bug reports during this private preview period. Please share them via support@engineai.com as we continue improving the SDK.
Note
The SDK is currently in private preview and is available by invitation only. To participate, please send an email to info@engineai.com.
Here’s an example of what you can build using our SDK:
What is the purpose of the Platform SDK?#
- To build data driven applications with smaller teams & less specialized resources.
- To allow a single developer to transforms raw data to C-level insights.
- To meet the needs to use cases from quick prototyping to complex production-level applications:
Why use the Platform SDK?#
- One Language: Entirely Pythonic
- Workflow Driven: Guided development, reducing the number of decisions you need to make as a developer.
- Scalability: Designed for scalability without extra effort, with auto-scaling based on user demand.
- Cache: Faster loading times for your dashboards.
- Extendable Ecosystem:
- Collaborative environment where dashboards are created independently.
- Integration with external applications.
Future Developments - Public Preview#
As we continue to enhance the EngineAI Platform SDK, we're thrilled to share some of the upcoming features you can look forward to in the public preview:
- App Configuration Tools: Tailor your apps with custom navigation and themes.
- Sharing Features: Control how apps and dashboards are shared with other users.
- Widget Catalog Expansion: Introducing AutoWidget for optimal data visualization selections, along with more widget options.
- New Layout Designs: Discover new layout options, including collapsible rows, for a more dynamic user experience.
- CLI Enhancements: Improved command-line interactions for project initiation and configuration.
- Community Engagement: Resources and tools for getting help and support from the EngineAI developer community
We've put together a tutorial to provide you with an idea of what you can build with the Platform SDK and how you can use it in your day-to-day. To get started, check out the Getting Started section. We hope you enjoy the Private Preview of EngineAI SDK.