DOCSEARCHbyAlgolia
Submit Docs

Pyplan Documentation

website·Indexed 33 days ago

https://docs.pyplan.com

A platform for building data analytics and planning applications using a mix of no-code, low-code, and AI-driven workflows. Pyplan features a hierarchical influence diagram for code organization, a task manager for scheduled activities, and a Model Context Protocol (MCP) for AI client connectivity. The platform includes tools for manual data input, interface design with customizable components, and enterprise security management including SSO and role-based access control.

Tokens
70.7K
Snippets
106
Records
591
Agent score
53%

What's inside Pyplan

  1. Overview of the Pyplan Index component

    The Index component in Pyplan allows users to filter or select one or multiple values from a predefined list of index values (such as dates, categories, or labels). It is primarily used to drive dynamic filtering in dashboards or interfaces by linking the component to nodes or data views to update content dynamically.

  2. Overview of the HTML Visualization component

    The HTML Visualization component is a data-bound tool that transforms the output of a Pyplan node into a custom HTML view rendered inside an iframe. Unlike static components, it reacts to changes in the Pyplan node and interface filters. It is ideal for bespoke KPI dashboards, styled summary cards, and mixed chart-and-table panels where full control over markup, CSS, and JavaScript is required.

  3. Overview of Pyplan Interfaces

    An interface in Pyplan is a dashboard or screen used to visualize results, filter data, input information, and trigger actions. Technically, an interface is linked to a specific application version, consists of components arranged on a grid, and interacts with data via nodes in the influence diagram.

  4. Overview of Pyplan Application Structure

    A Pyplan application is an analytical or planning solution consisting of two primary components:

    1. Code Side: Business logic organized as an influence diagram of nodes. This includes node definitions (Python code) and their resulting outputs.
    2. Interface Side: User-facing dashboards and pages containing components such as tables, charts, indicators, filters, forms, buttons, and menus.

    Applications also include associated files, resources, versions, and scenarios for comparison and cycle management.

  7. Overview of Pyplan platform

    Pyplan is a no-code/low-code platform designed for building and sharing Planning and Analytics applications. It allows users to connect to data sources (files, databases, APIs), transform and model data using nodes arranged in an influence diagram, and build interactive interfaces such as dashboards, forms, and charts. The platform supports what-if and scenario analysis, as well as the orchestration of processes and scheduled jobs. While each node contains Python code or configured behavior, non-coding users can interact with the platform via AI agents, wizards, and forms.

  8. Overview of the Pyplan platform

    Pyplan is a no-code / low-code platform designed for building and sharing Planning and Analytics applications.

  9. Overview of Pyplan MCP Architecture

    Pyplan uses the Model Context Protocol (MCP) to allow AI clients to connect to Pyplan instances. It employs a two-level architecture for tool execution:

    1. MCP Tools: A fixed set of core tools available to the client immediately upon connection.
    2. Skills and Domain Tools: Domain-specific documentation and tool schemas that are loaded on demand using get_skill. These tools are not direct MCP tools and must be executed via the call_tool MCP tool.

    Standard workflow: Register server $\rightarrow$ Authenticate (OAuth 2.1) $\rightarrow$ List applications $\rightarrow$ Open application (obtaining an instance_id) $\rightarrow$ Load skills $\rightarrow$ Execute domain tools via call_tool using the instance_id.

  10. Overview of Pyplan platform

    Pyplan is a no-code / low-code platform used for building and sharing Planning and Analytics applications. It allows teams to create data-driven applications, planning models, and interactive dashboards without requiring deep programming expertise.

  11. Overview of Pyplan Interface Options

    Pyplan provides four ways to handle custom presentation, depending on whether you need a full page or a component within a standard grid:

    • Component interface: A grid of draggable components (tables, charts, etc.). Best for standard dashboards.
    • HTML Menu component: A single HTML block inside a component interface. Best for custom cards or banners.
    • HTML Visualization component: A single component inside a component interface where a Python render() method generates HTML. Best for data-driven visualizations that react to node changes.
    • HTML interface: A full-screen, self-contained web page with its own logic. Best for fully custom layouts or tailored tools that exceed standard component capabilities.

  12. Overview of the Test Applications tool

    The Test Applications tool allows users to run automation tests for multiple applications simultaneously without opening each application individually. It acts as a central registry to launch tests in the background, review logs, and track performance across different applications and versions. Note that this tool executes existing tests built within the applications; it does not create new tests.