solara-ui 1.45.0__py3-none-any.whl

solara/website/pages/documentation/components/status/info.py

@@ -0,0 +1,39 @@
+"""# Info
+
+Solara has 4 types of alerts:
+
+ * [Success](/documentation/components/status/success)
+ * Info (this page)
+ * [Warning](/documentation/components/status/warning)
+ * [Error](/documentation/components/status/error)
+
+
+
+"""
+
+import solara
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    icon = solara.use_reactive(True)
+    dense = solara.use_reactive(False)
+    outlined = solara.use_reactive(True)
+    text = solara.use_reactive(True)
+
+    with solara.GridFixed(4):
+        solara.Checkbox(label="Use icon", value=icon)
+        solara.Checkbox(label="Show dense", value=dense)
+        solara.Checkbox(label="Show as text", value=text)
+        solara.Checkbox(label="Show outlined", value=outlined)
+    solara.Info(
+        f"This is solara.Info(label='...', text={text.value}, dense={dense.value}, outlined={outlined.value}, icon={icon.value})",
+        text=text.value,
+        dense=dense.value,
+        outlined=outlined.value,
+        icon=icon.value,
+    )
+
+
+__doc__ += apidoc(solara.Info.f)  # type: ignore

solara/website/pages/documentation/components/status/progress.py

@@ -0,0 +1,10 @@
+"""# ProgressLinear"""
+
+import solara
+from solara.website.components import NoPage
+from solara.website.utils import apidoc
+
+Page = NoPage
+
+
+__doc__ += apidoc(solara.ProgressLinear.f)  # type: ignore

solara/website/pages/documentation/components/status/spinner.py

@@ -0,0 +1,11 @@
+"""
+# SpinnerSolara
+"""
+
+import solara
+from solara.website.components import NoPage
+from solara.website.utils import apidoc
+
+Page = NoPage
+
+__doc__ += apidoc(solara.SpinnerSolara.f)  # type: ignore

solara/website/pages/documentation/components/status/success.py

@@ -0,0 +1,40 @@
+"""# Success
+
+Solara has 4 types of alerts:
+
+ * Success (this page)
+ * [Info](/documentation/components/status/info)
+ * [Warning](/documentation/components/status/warning)
+ * [Error](/documentation/components/status/error)
+
+
+
+"""
+
+import solara
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    icon, set_icon = solara.use_state(True)
+    dense, set_dense = solara.use_state(False)
+    outlined, set_outlined = solara.use_state(True)
+    text, set_text = solara.use_state(True)
+    with solara.VBox() as main:
+        with solara.GridFixed(4):
+            solara.Checkbox(label="Use icon", value=icon, on_value=set_icon)
+            solara.Checkbox(label="Show dense", value=dense, on_value=set_dense)
+            solara.Checkbox(label="Show as text", value=text, on_value=set_text)
+            solara.Checkbox(label="Show outlined", value=outlined, on_value=set_outlined)
+        solara.Success(
+            f"This is solara.Success(label='...', text={text}, dense={dense}, outlined={outlined}, icon={icon})",
+            text=text,
+            dense=dense,
+            outlined=outlined,
+            icon=icon,
+        )
+    return main
+
+
+__doc__ += apidoc(solara.Success.f)  # type: ignore

solara/website/pages/documentation/components/status/warning.py

@@ -0,0 +1,47 @@
+"""# Warning
+
+Solara has 4 types of alerts:
+
+ * [Success](/documentation/components/status/success)
+ * [Info](/documentation/components/status/info)
+ * Warning (this page)
+ * [Error](/documentation/components/status/error)
+
+
+
+"""
+
+import solara
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    icon, set_icon = solara.use_state(True)
+    dense, set_dense = solara.use_state(False)
+    outlined, set_outlined = solara.use_state(True)
+    text, set_text = solara.use_state(True)
+    with solara.VBox() as main:
+        with solara.GridFixed(4):
+            solara.Checkbox(label="Use icon", value=icon, on_value=set_icon)
+            solara.Checkbox(label="Show dense", value=dense, on_value=set_dense)
+            solara.Checkbox(label="Show as text", value=text, on_value=set_text)
+            solara.Checkbox(label="Show outlined", value=outlined, on_value=set_outlined)
+        solara.Warning(
+            f"This is solara.Warning(label='...', text={text}, dense={dense}, outlined={outlined}, icon={icon})",
+            text=text,
+            dense=dense,
+            outlined=outlined,
+            icon=icon,
+        )
+        solara.Warning(
+            f"This is solara.Warning(label='...', text={text}, dense={dense}, outlined={outlined}, icon={icon})",
+            text=text,
+            dense=dense,
+            outlined=outlined,
+            icon=icon,
+        )
+    return main
+
+
+__doc__ += apidoc(solara.Warning.f)  # type: ignore

solara/website/pages/documentation/components/viz/__init__.py

@@ -0,0 +1,9 @@
+import solara
+from solara.website.components import NoPage, SubCategoryLayout
+
+Page = NoPage
+
+
+@solara.component
+def Layout(children=[]):
+    SubCategoryLayout(children=children)

solara/website/pages/documentation/components/viz/altair.py

@@ -0,0 +1,42 @@
+"""# FigureAltair"""
+
+import altair as alt
+import pandas as pd
+
+import solara
+from solara.website.utils import apidoc
+
+title = "FigureAltair"
+
+df = pd.DataFrame({"a": ["A", "B", "C", "D", "E", "F", "G", "H", "I"], "b": [28, 55, 43, 91, 81, 53, 19, 87, 52]})
+
+
+@solara.component
+def Page():
+    click_data, set_click_data = solara.use_state(None)
+    hover_data, set_hover_data = solara.use_state(None)
+
+    chart = alt.Chart(df).mark_bar().encode(x="a", y="b")
+
+    with solara.Div() as main:
+        solara.AltairChart(chart, on_click=set_click_data, on_hover=set_hover_data)
+
+        solara.Markdown(
+            f"""
+Click data:
+
+```
+{click_data}
+```
+
+Hover data:
+```
+{hover_data}
+```
+            """
+        )
+
+    return main
+
+
+__doc__ += apidoc(solara.FigureAltair.f)  # type: ignore

solara/website/pages/documentation/components/viz/echarts.py

@@ -0,0 +1,77 @@
+"""# Echarts"""
+
+import solara
+from solara.website.utils import apidoc
+
+options = {
+    "bars": {
+        "title": {"text": "ECharts Getting Started Example"},
+        "tooltip": {},
+        "legend": {"data": ["sales"]},
+        "xAxis": {"type": "category"},
+        "yAxis": {},
+        "emphasis": {"itemStyle": {"shadowBlur": 10, "shadowOffsetX": 0, "shadowColor": "rgba(0, 0, 0, 0.5)"}},
+        "series": [
+            {
+                "name": "sales",
+                "type": "bar",
+                "data": [
+                    {"name": "Shirts", "value": 5},
+                    {"name": "Cardigans", "value": 20},
+                    {"name": "Chiffons", "value": 36},
+                    {"name": "Pants", "value": 10},
+                    {"name": "Heels", "value": 10},
+                    {"name": "Socks", "value": 20},
+                ],
+                "universalTransition": True,
+            }
+        ],
+    },
+    "pie": {
+        "title": {"text": "ECharts Getting Started Example"},
+        "tooltip": {},
+        "legend": {"data": ["sales"]},
+        "series": [
+            {
+                "name": "sales",
+                "type": "pie",
+                "radius": [0, "50%"],
+                "data": [
+                    {"name": "Shirts", "value": 5},
+                    {"name": "Cardigans", "value": 20},
+                    {"name": "Chiffons", "value": 36},
+                    {"name": "Pants", "value": 10},
+                    {"name": "Heels", "value": 10},
+                    {"name": "Socks", "value": 20},
+                ],
+                "universalTransition": True,
+            }
+        ],
+    },
+}
+
+
+@solara.component
+def Page():
+    option, set_option = solara.use_state("bars")
+    click_data, set_click_data = solara.use_state(None)
+    mouseover_data, set_mouseover_data = solara.use_state(None)
+    mouseout_data, set_mouseout_data = solara.use_state(None)
+
+    with solara.VBox() as main:
+        with solara.Card("Echarts"):
+            with solara.ToggleButtonsSingle("bars", on_value=set_option):
+                solara.Button("bars")
+                solara.Button("pie")
+            solara.FigureEcharts(
+                option=options[option], on_click=set_click_data, on_mouseover=set_mouseover_data, on_mouseout=set_mouseout_data, responsive=True
+            )
+        with solara.Card("Event data"):
+            solara.Markdown(f"**Click data**: {click_data}")
+            solara.Markdown(f"**Mouseover data**: {mouseover_data}")
+            solara.Markdown(f"**Mouseout data**: {mouseout_data}")
+
+    return main
+
+
+__doc__ += apidoc(solara.FigureEcharts.f)  # type: ignore

solara/website/pages/documentation/components/viz/matplotlib.py

@@ -0,0 +1,30 @@
+"""# Matplotlib"""
+
+import numpy as np
+from matplotlib.figure import Figure
+
+import solara
+from solara.website.utils import apidoc
+
+x = np.linspace(0, 2, 100)
+
+
+@solara.component
+def Page():
+    freq, set_freq = solara.use_state(2.0)
+    phase, set_phase = solara.use_state(0.1)
+    y = np.sin(x * freq + phase)
+
+    fig = Figure()
+    ax = fig.subplots()
+    ax.plot(x, y)
+    ax.set_ylim(-1.2, 1.2)
+
+    with solara.VBox() as main:
+        solara.FloatSlider("Frequency", value=freq, on_value=set_freq, min=0, max=10)
+        solara.FloatSlider("Phase", value=phase, on_value=set_phase, min=0, max=np.pi, step=0.1)
+        solara.FigureMatplotlib(fig, dependencies=[freq, phase])
+    return main
+
+
+__doc__ += apidoc(solara.FigureMatplotlib.f)  # type: ignore

solara/website/pages/documentation/components/viz/plotly.py

@@ -0,0 +1,63 @@
+"""Renders a plotly figure object and support for events.
+
+You can use a regular plotly figure, for instance using plotly.express.
+
+Supported events are include in the example below.
+
+For performance, a dependency list can be provided. Any change to the dependency list will cause the Figure data to be updated.
+This can be significantly faster than comparing he figure data directly.
+
+"""
+
+import plotly.express as px
+
+import solara
+
+df = px.data.iris()
+
+
+@solara.component
+def Page():
+    with solara.VBox() as main:
+        selection_data, set_selection_data = solara.use_state(None)
+        click_data, set_click_data = solara.use_state(None)
+        hover_data, set_hover_data = solara.use_state(None)
+        unhover_data, set_unhover_data = solara.use_state(None)
+        deselect_data, set_deselect_data = solara.use_state(None)
+        fig = px.scatter(df, x="sepal_width", y="sepal_length", color="species")
+        solara.FigurePlotly(
+            fig, on_selection=set_selection_data, on_click=set_click_data, on_hover=set_hover_data, on_unhover=set_unhover_data, on_deselect=set_deselect_data
+        )
+
+        solara.Markdown(
+            f"""
+# Events data
+## selection
+```
+{selection_data}
+```
+
+## click
+```
+{click_data}
+```
+
+## hover
+```
+{hover_data}
+```
+
+## unhover
+```
+{unhover_data}
+```
+
+## deselect
+```
+{deselect_data}
+```
+
+
+"""
+        )
+    return main

solara/website/pages/documentation/components/viz/plotly_express.py

@@ -0,0 +1,41 @@
+"""
+
+Wraps plotly express function and adds cross filtering support.
+
+Instead of `plotly.express' you can use `solara.express` instead.
+
+```python
+# import plotly.express as px
+import solara.express as px
+
+df = px.data.iris()
+px.histogram(df, "species")
+px.scatter(df, x="sepal_width", y="sepal_length", color="species")
+```
+
+
+Click the lasso icon in the top scatter plot to select points, which should then be filtered out in the other
+plots.
+
+
+"""
+
+import plotly.express as px
+
+import solara
+import solara.express as spx
+
+df = px.data.iris()
+
+
+@solara.component
+def Page():
+    solara.provide_cross_filter()
+    fig = px.histogram(df, "species")
+    fig.update_layout(dragmode="select", selectdirection="h")
+
+    with solara.VBox() as main:
+        spx.scatter(df, x="sepal_width", y="sepal_length", color="species")
+        spx.scatter_3d(df, x="sepal_width", y="sepal_length", z="petal_width")
+        spx.CrossFilteredFigurePlotly(fig)
+    return main

solara/website/pages/documentation/examples/__init__.py

@@ -0,0 +1,54 @@
+import solara
+from solara.website.components import Gallery, MarkdownWithMetadata
+
+title = "Examples"
+
+pycafe_projects = [
+    "chatbot",
+    "tokenizer",
+]
+
+
+@solara.component
+def Page(route_external=None):
+    Gallery(route_external)
+
+
+@solara.component
+def Layout(children):
+    # TODO: this is using a private API, what is the best way to do this?
+    # we want to 'eat' the whole route for the current level, and the level below
+    # for example the utilities directory. But if an example does routing, we don't want
+    # to take on that route.
+    router = solara.use_router()
+    route_current = router.path_routes[-1]
+    # route_current, all_routes = solara.use_route()
+
+    if route_current is None:
+        return solara.Error("Page not found")
+    module = route_current.module
+    assert module is not None
+    github_url = solara.util.github_url(module.__file__)
+
+    if route_current.path == "fullscreen":
+        with solara.Padding(4, children=children):
+            pass
+    else:
+        with solara.Column(align="center", style={"max-width": "100%"}):
+            doc = module.__doc__
+            if doc:
+                with solara.Column():
+                    MarkdownWithMetadata(doc)
+            with solara.Column(style={"max-width": "min(100%, 1024px)", "width": "100%"}):
+                if route_current.path != "/":
+                    solara.Button("View source code on GitHub", icon_name="mdi-github-circle", href=github_url, class_="ma-2", target="_blank", text=True)
+                if route_current.path in pycafe_projects:
+                    pycafe_url = f"https://py.cafe/solara/{route_current.path}"
+                    solara.Button(
+                        "Run this example on PyCafe", icon_name="mdi-coffee-to-go-outline", href=pycafe_url, class_="ma-2", target="_blank", text=True
+                    )
+                if not hasattr(module, "Page"):
+                    solara.Error(f"No Page component found in {module}")
+                else:
+                    with solara.Div(children=children):
+                        pass

solara/website/pages/documentation/examples/ai/__init__.py

@@ -0,0 +1,11 @@
+"""Large Language Models and Generative AI examples."""
+
+import solara
+
+title = "AI"
+redirect = None
+
+
+@solara.component
+def Page():
+    return solara.Markdown("Click an example on the left")

solara/website/pages/documentation/examples/ai/chatbot.py

@@ -0,0 +1,113 @@
+"""
+# Chatbot
+
+A way to create a chatbot using OpenAI's GPT-4 API, utilizing their new API, and the streaming feature.
+"""
+
+import os
+from typing import List, cast
+
+from openai import AsyncOpenAI
+from openai.types.chat import ChatCompletionMessageParam
+from typing_extensions import TypedDict
+
+import solara
+import solara.lab
+
+
+class MessageDict(TypedDict):
+    role: str  # "user" or "assistant"
+    content: str
+
+
+messages: solara.Reactive[List[MessageDict]] = solara.reactive([])
+
+try:
+    import pycafe
+
+    OPENAI_API_KEY = pycafe.get_secret(
+        "OPENAI_API_KEY",
+        """We need an OpenAI API key to generate text.
+
+Go to [OpenAI](https://platform.openai.com/account/api-keys) to get one.
+
+Or read [this](https://www.rebelmouse.com/openai-account-set-up) article for
+more information.
+
+Or read more [about secrets on PyCafe](/docs/secrets)
+
+""",
+    )
+except ModuleNotFoundError:
+    OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
+
+openai = AsyncOpenAI(api_key=OPENAI_API_KEY) if OPENAI_API_KEY else None
+
+
+def no_api_key_message():
+    messages.value = [
+        {
+            "role": "assistant",
+            "content": "No OpenAI API key found. Please set your OpenAI API key in the environment variable `OPENAI_API_KEY`.",
+        },
+    ]
+
+
+@solara.lab.task
+async def promt_ai(message: str):
+    if openai is None:
+        no_api_key_message()
+        return
+
+    messages.value = [
+        *messages.value,
+        {"role": "user", "content": message},
+    ]
+    # The part below can be replaced with a call to your own
+    response = await openai.chat.completions.create(
+        model="gpt-4-1106-preview",
+        # our MessageDict is compatible with the OpenAI types
+        messages=cast(List[ChatCompletionMessageParam], messages.value),
+        stream=True,
+    )
+    # start with an empty reply message, so we render and empty message in the chat
+    # while the AI is thinking
+    messages.value = [*messages.value, {"role": "assistant", "content": ""}]
+    # and update it with the response
+    async for chunk in response:
+        if chunk.choices[0].finish_reason == "stop":  # type: ignore
+            return
+        # replace the last message element with the appended content
+        delta = chunk.choices[0].delta.content
+        assert delta is not None
+        updated_message: MessageDict = {
+            "role": "assistant",
+            "content": messages.value[-1]["content"] + delta,
+        }
+        # replace the last message element with the appended content
+        # which will update the UI
+        messages.value = [*messages.value[:-1], updated_message]
+
+
+@solara.component
+def Page():
+    with solara.Column(
+        style={"width": "100%", "height": "50vh"},
+    ):
+        with solara.lab.ChatBox():
+            for item in messages.value:
+                with solara.lab.ChatMessage(
+                    user=item["role"] == "user",
+                    avatar=False,
+                    name="ChatGPT" if item["role"] == "assistant" else "User",
+                    color="rgba(0,0,0, 0.06)" if item["role"] == "assistant" else "#ff991f",
+                    avatar_background_color="primary" if item["role"] == "assistant" else None,
+                    border_radius="20px",
+                ):
+                    solara.Markdown(item["content"])
+        if promt_ai.pending:
+            solara.Text("I'm thinking...", style={"font-size": "1rem", "padding-left": "20px"})
+            solara.ProgressLinear()
+        # if we don't call .key(..) with a unique key, the ChatInput component will be re-created
+        # and we'll lose what we typed.
+        solara.lab.ChatInput(send_callback=promt_ai, disabled_send=promt_ai.pending, autofocus=True).key("input")