streamlit-a2ui 0.1.0rc1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- streamlit_a2ui-0.1.0rc1/LICENSE +202 -0
- streamlit_a2ui-0.1.0rc1/MANIFEST.in +4 -0
- streamlit_a2ui-0.1.0rc1/PKG-INFO +244 -0
- streamlit_a2ui-0.1.0rc1/README.md +216 -0
- streamlit_a2ui-0.1.0rc1/pyproject.toml +50 -0
- streamlit_a2ui-0.1.0rc1/setup.cfg +4 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui/THIRD_PARTY_LICENSES.txt +2399 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui/__init__.py +95 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui/frontend/build/index-BoRsBuqE.js +1013 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui/frontend/build/index-_hash_.css +2 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui/pyproject.toml +9 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui/renderer_capabilities.json +7 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui.egg-info/PKG-INFO +244 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui.egg-info/SOURCES.txt +18 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui.egg-info/dependency_links.txt +1 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui.egg-info/requires.txt +1 -0
- streamlit_a2ui-0.1.0rc1/streamlit_a2ui.egg-info/top_level.txt +1 -0
- streamlit_a2ui-0.1.0rc1/tests/test_component.py +32 -0
- streamlit_a2ui-0.1.0rc1/tests/test_version.py +31 -0
- streamlit_a2ui-0.1.0rc1/tests/test_wheel.py +146 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,244 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: streamlit-a2ui
|
|
3
|
+
Version: 0.1.0rc1
|
|
4
|
+
Summary: Render A2UI 1.0 agent-generated user interfaces inside Streamlit apps
|
|
5
|
+
Author-email: jose chu <jose.chu.dev@gmail.com>
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/josechudev/streamlit-a2ui
|
|
8
|
+
Project-URL: Source, https://github.com/josechudev/streamlit-a2ui
|
|
9
|
+
Project-URL: Issues, https://github.com/josechudev/streamlit-a2ui/issues
|
|
10
|
+
Project-URL: Changelog, https://github.com/josechudev/streamlit-a2ui/blob/master/CHANGELOG.md
|
|
11
|
+
Keywords: streamlit,a2ui,agent,generative-ui,component,llm
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Topic :: Software Development :: User Interfaces
|
|
22
|
+
Requires-Python: >=3.10
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
License-File: LICENSE
|
|
25
|
+
License-File: streamlit_a2ui/THIRD_PARTY_LICENSES.txt
|
|
26
|
+
Requires-Dist: streamlit>=1.59
|
|
27
|
+
Dynamic: license-file
|
|
28
|
+
|
|
29
|
+
# streamlit-a2ui
|
|
30
|
+
|
|
31
|
+

|
|
32
|
+
|
|
33
|
+
Render [A2UI](https://a2ui.org) surfaces inside Streamlit apps.
|
|
34
|
+
|
|
35
|
+

|
|
36
|
+
|
|
37
|
+
A2UI is a protocol in which an agent describes a user interface as JSON messages and a renderer draws it with a trusted catalog of components. `streamlit-a2ui` wraps the official web renderer (`@a2ui/react` and `@a2ui/web_core`) in a Streamlit Components v2 component. You pass it the agent's messages; it draws the surface, and it returns the user's actions so you can send them back to the agent.
|
|
38
|
+
|
|
39
|
+
It is for Python developers who already have an agent that speaks A2UI, or want one, and want to show its UI in a Streamlit app without writing frontend code.
|
|
40
|
+
|
|
41
|
+
## Status
|
|
42
|
+
|
|
43
|
+
Pre-1.0. `0.1.0rc1` is the first release candidate: try it and report problems, but expect the API and the supported versions to change before 1.0.
|
|
44
|
+
|
|
45
|
+
- A2UI **1.0** only, with the official basic catalog. 0.9.x and 0.8 are not supported.
|
|
46
|
+
- Streamlit >= 1.59 (Components v2). CI runs the floor (1.59) and the latest release; developed on 1.67.
|
|
47
|
+
- Python >= 3.10.
|
|
48
|
+
- Pinned to `@a2ui/react` and `@a2ui/web_core` 0.15.0. These upstream renderer packages are themselves pre-1.0 (see Security below for the overrides they need).
|
|
49
|
+
|
|
50
|
+
## Install
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
pip install --pre streamlit-a2ui
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
`0.1.0rc1` is a pre-release, so pip installs it only with `--pre` or an exact version (`pip install streamlit-a2ui==0.1.0rc1`); with uv, use `uv pip install --prerelease=allow streamlit-a2ui` or the exact version. Until `0.1.0` is out, a plain `pip install streamlit-a2ui` finds nothing to install. The wheel contains the built frontend, so no Node is needed.
|
|
57
|
+
|
|
58
|
+
Then run the example: download [`examples/basic_app.py`](https://github.com/josechudev/streamlit-a2ui/blob/master/examples/basic_app.py) and run `streamlit run basic_app.py`.
|
|
59
|
+
|
|
60
|
+
### From source
|
|
61
|
+
|
|
62
|
+
You need [uv](https://docs.astral.sh/uv/), Node 24 and npm.
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
git clone https://github.com/josechudev/streamlit-a2ui.git
|
|
66
|
+
cd streamlit-a2ui/streamlit_a2ui/frontend
|
|
67
|
+
npm install
|
|
68
|
+
npm run build
|
|
69
|
+
cd ../..
|
|
70
|
+
uv venv
|
|
71
|
+
uv pip install -e .
|
|
72
|
+
.venv/bin/streamlit run examples/basic_app.py
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
`npm run build` writes the frontend bundle into `streamlit_a2ui/frontend/build/` and generates `streamlit_a2ui/renderer_capabilities.json` and `streamlit_a2ui/THIRD_PARTY_LICENSES.txt`. Build it before installing, and again after changing the frontend. To build a wheel, run `uv build` after `npm run build`.
|
|
76
|
+
|
|
77
|
+
## Quickstart
|
|
78
|
+
|
|
79
|
+
Keep the agent's messages in an append-only list in `st.session_state`, pass the whole list on every run, and forward whatever comes back to your agent. This is a shortened [`examples/basic_app.py`](https://github.com/josechudev/streamlit-a2ui/blob/master/examples/basic_app.py), with a scripted function in place of a real agent:
|
|
80
|
+
|
|
81
|
+
```python
|
|
82
|
+
import streamlit as st
|
|
83
|
+
|
|
84
|
+
from streamlit_a2ui import a2ui_surface
|
|
85
|
+
|
|
86
|
+
CATALOG = "https://a2ui.org/specification/v1_0/catalogs/basic/catalog.json"
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
def initial_messages():
|
|
90
|
+
return [
|
|
91
|
+
{
|
|
92
|
+
"version": "1.0",
|
|
93
|
+
"createSurface": {"surfaceId": "contact", "catalogId": CATALOG},
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"version": "1.0",
|
|
97
|
+
"updateComponents": {
|
|
98
|
+
"surfaceId": "contact",
|
|
99
|
+
"components": [
|
|
100
|
+
{
|
|
101
|
+
"id": "root",
|
|
102
|
+
"component": "Column",
|
|
103
|
+
"children": ["name_field", "send", "reply"],
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"id": "name_field",
|
|
107
|
+
"component": "TextField",
|
|
108
|
+
"label": "Name",
|
|
109
|
+
"value": {"@path": "/name"},
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"id": "send",
|
|
113
|
+
"component": "Button",
|
|
114
|
+
"child": "send_label",
|
|
115
|
+
"variant": "primary",
|
|
116
|
+
"action": {
|
|
117
|
+
"event": {
|
|
118
|
+
"name": "send_message",
|
|
119
|
+
"context": {"name": {"@path": "/name"}},
|
|
120
|
+
}
|
|
121
|
+
},
|
|
122
|
+
},
|
|
123
|
+
{"id": "send_label", "component": "Text", "text": "Send"},
|
|
124
|
+
{
|
|
125
|
+
"id": "reply",
|
|
126
|
+
"component": "Text",
|
|
127
|
+
"text": "The agent's reply will appear here.",
|
|
128
|
+
},
|
|
129
|
+
],
|
|
130
|
+
},
|
|
131
|
+
},
|
|
132
|
+
]
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
def scripted_agent(event):
|
|
136
|
+
name = event["action"]["context"].get("name") or "there"
|
|
137
|
+
return [
|
|
138
|
+
{
|
|
139
|
+
"version": "1.0",
|
|
140
|
+
"updateComponents": {
|
|
141
|
+
"surfaceId": "contact",
|
|
142
|
+
"components": [
|
|
143
|
+
{"id": "reply", "component": "Text", "text": f"Thanks, {name}!"},
|
|
144
|
+
],
|
|
145
|
+
},
|
|
146
|
+
}
|
|
147
|
+
]
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
log = st.session_state.setdefault("a2ui_log", initial_messages())
|
|
151
|
+
event = a2ui_surface(log, key="contact")
|
|
152
|
+
if event is not None:
|
|
153
|
+
st.session_state["last_event"] = event
|
|
154
|
+
log.extend(scripted_agent(event))
|
|
155
|
+
st.rerun()
|
|
156
|
+
|
|
157
|
+
st.json(st.session_state.get("last_event", {}))
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
When the user presses **Send**, `a2ui_surface` returns, once:
|
|
161
|
+
|
|
162
|
+
```json
|
|
163
|
+
{"version": "1.0",
|
|
164
|
+
"action": {"name": "send_message", "surfaceId": "contact", "sourceComponentId": "send",
|
|
165
|
+
"timestamp": "2026-11-17T06:41:12.836Z", "context": {"name": "Ada"}}}
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
The reply is appended to the log and the surface updates in place: text the user has typed but not sent is kept.
|
|
169
|
+
|
|
170
|
+
Take message shapes from the A2UI 1.0 specification. The installed `@a2ui/web_core` package has the schemas and examples under `node_modules/@a2ui/web_core/src/v1_0/schemas/`.
|
|
171
|
+
|
|
172
|
+
## Streaming
|
|
173
|
+
|
|
174
|
+
A keyed component can be called only once per script run, so a surface cannot be repainted in the middle of a run. To show an agent's messages as they arrive, put the component in a fragment that reruns on a timer and moves whatever the stream has produced into the log:
|
|
175
|
+
|
|
176
|
+
```python
|
|
177
|
+
@st.fragment(run_every=0.5)
|
|
178
|
+
def surface():
|
|
179
|
+
log = st.session_state["a2ui_log"]
|
|
180
|
+
log.extend(drain_new_messages()) # whatever your agent's stream produced
|
|
181
|
+
event = a2ui_surface(log, key="stream")
|
|
182
|
+
if event is not None:
|
|
183
|
+
handle(event) # only this fragment reran: handle the event here
|
|
184
|
+
st.rerun(scope="fragment")
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
surface()
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
An action fired from a component inside a fragment reruns only that fragment, and the returned message is visible only there. Handle it inside the fragment, and use `st.rerun(scope="app")` when the rest of the page must change. [`examples/streaming_app.py`](https://github.com/josechudev/streamlit-a2ui/blob/master/examples/streaming_app.py) streams a dashboard over a few seconds, accepts an action during and after the stream, and switches the timer off when the stream ends.
|
|
191
|
+
|
|
192
|
+
Do not change the key to force a repaint: a new key mounts a new component and loses its state.
|
|
193
|
+
|
|
194
|
+
## Using it with a real agent
|
|
195
|
+
|
|
196
|
+
The package draws what an agent sends and returns what the user does; connecting the agent is your app's code. Pass `renderer_capabilities()` to the agent (with Google's [`a2ui-agent-sdk`](https://pypi.org/project/a2ui-agent-sdk/), under the `a2uiRendererCapabilities` key), run the agent's stream in a background thread or task that only appends complete A2UI messages to the log list, and draw the log with `a2ui_surface` inside `@st.fragment(run_every=...)` as above. Never call `st.*` from that thread. Send each message `a2ui_surface` returns back to the agent. This was checked with a minimal Google ADK agent built on `a2ui-agent-sdk` 0.12.0: an action round trip and a streamed response worked unchanged.
|
|
197
|
+
|
|
198
|
+
## API
|
|
199
|
+
|
|
200
|
+
### `a2ui_surface(messages, *, key) -> dict | None`
|
|
201
|
+
|
|
202
|
+
Renders the A2UI 1.0 messages in `messages` and returns at most one renderer-to-agent message per rerun.
|
|
203
|
+
|
|
204
|
+
- `messages`: the full, append-only list of agent-to-renderer messages. Pass the whole list on every run; the browser processes only the entries it has not seen. If the list gets shorter, or an entry it has already processed changes, the browser discards its state and replays the list from the start.
|
|
205
|
+
- `key`: a stable key. The surface keeps its state for as long as the key stays mounted.
|
|
206
|
+
- Returns the message produced since the last rerun, such as an `action` or a `callAgentFunction`, exactly as the A2UI 1.0 wire format defines it; otherwise `None`. Python does not inspect or validate messages.
|
|
207
|
+
|
|
208
|
+
### `renderer_capabilities() -> dict`
|
|
209
|
+
|
|
210
|
+
Returns the renderer's A2UI capabilities, to pass to your agent (for example in A2A metadata). It is generated from `@a2ui/web_core` when the frontend is built:
|
|
211
|
+
|
|
212
|
+
```python
|
|
213
|
+
{
|
|
214
|
+
"1.0": {
|
|
215
|
+
"supportedCatalogIds": [
|
|
216
|
+
"https://a2ui.org/specification/v1_0/catalogs/basic/catalog.json"
|
|
217
|
+
]
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
## Limitations
|
|
223
|
+
|
|
224
|
+
- A2UI 1.0 and the basic catalog only. No custom or inline catalogs.
|
|
225
|
+
- One renderer-to-agent message per rerun. A second message produced before the app reruns replaces the first: in testing, a double or triple click on a button returned only one action to Python. Do not rely on every click of a rapid burst reaching your agent.
|
|
226
|
+
- Errors stay in the browser. A message the renderer rejects, or an exception while one surface renders, shows a plain-text notice inside the component and a `console.warn`, and the other surfaces stay rendered; nothing is returned to Python, so your agent cannot see validation errors yet.
|
|
227
|
+
- The full log is sent to the browser on every rerun.
|
|
228
|
+
- Text typed into a surface but not sent is lost if the component remounts or the log is replaced.
|
|
229
|
+
- Streaming repaints at the fragment's interval, not per message.
|
|
230
|
+
- `callAgentFunction` times out after 30 seconds in `@a2ui/web_core`, so the agent's response must be appended to the log within that time.
|
|
231
|
+
- `@a2ui/web_core` adds a page-wide stylesheet (`color-scheme` and `--a2ui-*` defaults). It caused no visible change to Streamlit's widgets in testing.
|
|
232
|
+
- Only one build of the frontend can run on a page. After rebuilding it, reload the page.
|
|
233
|
+
|
|
234
|
+
## Security
|
|
235
|
+
|
|
236
|
+
The component runs in your app's page with no iframe. Read [docs/security.md](https://github.com/josechudev/streamlit-a2ui/blob/master/docs/security.md) for the security model, the dependency overrides and the known residual risks.
|
|
237
|
+
|
|
238
|
+
## Development
|
|
239
|
+
|
|
240
|
+
See [CONTRIBUTING.md](https://github.com/josechudev/streamlit-a2ui/blob/master/CONTRIBUTING.md) for how to build, test and release; the full command list is in [CLAUDE.md](https://github.com/josechudev/streamlit-a2ui/blob/master/CLAUDE.md), and [docs/testing-playbook.md](https://github.com/josechudev/streamlit-a2ui/blob/master/docs/testing-playbook.md) has the manual checks. On every pull request CI runs the build, the unit tests, pytest, ruff and one Playwright browser test on Python 3.10 with Streamlit 1.59 and on Python 3.13 with the latest Streamlit, then builds the wheel and sdist once and runs the browser test against the installed wheel. The architecture is summarised in [docs/architecture.md](https://github.com/josechudev/streamlit-a2ui/blob/master/docs/architecture.md), design decisions are in [docs/adr/](https://github.com/josechudev/streamlit-a2ui/tree/master/docs/adr), and changes are in [CHANGELOG.md](https://github.com/josechudev/streamlit-a2ui/blob/master/CHANGELOG.md).
|
|
241
|
+
|
|
242
|
+
## License
|
|
243
|
+
|
|
244
|
+
Apache-2.0. See [LICENSE](https://github.com/josechudev/streamlit-a2ui/blob/master/LICENSE). The wheel bundles third-party JavaScript; their licenses are in `streamlit_a2ui/THIRD_PARTY_LICENSES.txt`, generated by `npm run build` and also listed as a license file in the package metadata.
|