Skip to main content

AGI-GUI

PyPI version Python versions License: BSD 3-Clause API docs

agi-gui provides the UI dependency bundle for native Python UI pages. It depends on the headless agi-env runtime and adds reusable page helpers and UI packages.

The native UI described here is the current source implementation. Previously published PyPI packages may still use the former provider; the commands below install their published release, not this source migration. From an AGILAB source checkout, use uv sync --extra ui --extra notebook to install the native interface and notebook widget. Local validation does not publish those changes.

Quick Install

pip install agi-gui

Use agi-env for worker/headless runtimes. Use agi-gui for native Python UI pages and local UI sessions.

File Picker

agi_gui.file_picker provides a reusable native Python UI popover picker for pages that need server-side path selection without exposing arbitrary filesystem access.

from agi_web import python_ui as st
from agi_gui.file_picker import agi_file_picker

selected_path = agi_file_picker(
    "Browse dataframe",
    roots={"Project": active_app_export_dir},
    key=f"{project_name}:dataframe_picker",
    patterns=["*.csv", "*.parquet", "*.json"],
    container=st.sidebar,
)

The picker validates manual paths and dataframe selections against the configured roots, keeps widget keys namespaced, and can optionally save uploaded files when the caller provides an explicit upload_dir.

UX Widgets

agi_gui.ux_widgets provides small compatibility wrappers for the native Python UI primitives. Pages can adopt modern controls while still running on older UI runtimes.

from agi_gui.ux_widgets import compact_choice, status_container, toast

selected = compact_choice(
    st.sidebar,
    "Stages file",
    available_stages_files,
    key="index_page",
    default=available_stages_files[0],
)

with status_container(st, "Running pipeline...", state="running") as status:
    run_pipeline()
    status.update(label="Pipeline completed", state="complete")
    toast(st, "Pipeline completed", state="success")

compact_choice uses st.segmented_control or st.pills when available and falls back to selectbox for long lists or earlier UI providers.

Widget Registry

agi_gui.widget_registry provides a typed registry for reusable widgets. It gives pages and docs a single discovery point without breaking direct imports from agi_gui.file_picker or agi_gui.ux_widgets.

from agi_gui import default_widget_registry, get_widget

registry = default_widget_registry()
rows = registry.as_rows()
file_picker = get_widget("file_picker")
same_picker = get_widget("agi_file_picker")

The default registry includes file selection, compact choice, action buttons, confirmation, status, empty-state, notice, and toast widgets.

Repository

Metadata

Release files for agi-gui 2026.10.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agi-gui 2026.10.13
File Size Uploaded
agi_gui-2026.10.13.tar.gz 28.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for agi-gui 2026.10.13
File Interpreter ABI Platform
agi_gui-2026.10.13-py3-none-any.whl Python 3 none any Details

Total release size: 52.8 kB

Release files / agi_gui-2026.10.13.tar.gz

Download URL agi_gui-2026.10.13.tar.gz
Size 28.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e4decd2bdcbe2569c1e851f8b4690dc55780fda86f63bd577f622e6a02a14d62
BLAKE2b-256 checksum
How to use checksums
984de2ddb271dea8effa3d5785c4288a36fabe0bc7ca188cfd87b661bce36adb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 14, 2026.

Transparency log

Release files / agi_gui-2026.10.13-py3-none-any.whl

Download URL agi_gui-2026.10.13-py3-none-any.whl
Size 24.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dd20f48878c550ef261551fa1979744eb1a5da6e0573ba690ece0145dfdc5700
BLAKE2b-256 checksum
How to use checksums
573a34a5c5a268d73530c8e6496bc2a8428cbc9701790f48e3c132ae73768f79
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 14, 2026.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page