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.7.1

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.7.1
File Size Uploaded
agi_gui-2026.10.7.1.tar.gz 28.7 kB Details

Built distribution (wheel)

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

Total release size: 52.8 kB

Release files / agi_gui-2026.10.7.1.tar.gz

Download URL agi_gui-2026.10.7.1.tar.gz
Size 28.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d4f6030b939a580c1aa388bef267bcc82c2e4c932fce13106f4f6ddf7afbe2fe
BLAKE2b-256 checksum
How to use checksums
fa3287ad1ca0601005a6e4d6e3f35ff798bdfbdc2ce5ad821e0fb1ad98fd6d6d
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 8, 2026.

Transparency log

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

Download URL agi_gui-2026.10.7.1-py3-none-any.whl
Size 24.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3d94c2882fcdee3d7d07218488e192f80f587db32f2830bf96fe6073c417ea48
BLAKE2b-256 checksum
How to use checksums
6e7000fcd89df2f62c0544d51111b9cee4303327e48776ddcb05d33e64cc86d7
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 8, 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