solara 1.29.1__py2.py3-none-any.whl → 1.30.1__py2.py3-none-any.whl

solara/website/pages/api/__init__.py

@@ -1,292 +0,0 @@
-"""
-# Overview
-Click on one of the items on the left.
-"""
-
-import solara
-from solara.alias import rv
-
-from .. import List
-from .. import SimpleListItem as ListItem
-
-_title = "API"
-
-
-# @solara.component
-# def Page():
-#     return solara.Markdown(__doc__)
-
-items = [
-    {
-        "name": "Input",
-        "icon": "mdi-chevron-left-box",
-        "pages": ["button", "checkbox", "input", "select", "slider", "switch", "togglebuttons", "file_browser", "file_drop"],
-    },
-    {
-        "name": "Output",
-        "icon": "mdi-chevron-right-box",
-        "pages": ["markdown", "markdown_editor", "html", "image", "sql_code", "file_download", "tooltip"],
-    },
-    {
-        "name": "Status",
-        "icon": "mdi-information",
-        "pages": ["success", "info", "warning", "error", "spinner", "progress"],
-    },
-    {
-        "name": "Viz",
-        "icon": "mdi-chart-histogram",
-        "pages": ["altair", "echarts", "matplotlib", "plotly", "plotly_express"],
-    },
-    {
-        "name": "Layout",
-        "icon": "mdi-page-layout-sidebar-left",
-        "pages": [
-            "app_layout",
-            "app_bar",
-            "app_bar_title",
-            "card",
-            "card_actions",
-            "columns",
-            "columns_responsive",
-            "column",
-            "row",
-            "griddraggable",
-            "gridfixed",
-            "sidebar",
-            "hbox",
-            "vbox",
-        ],
-    },
-    {
-        "name": "Data",
-        "icon": "mdi-database",
-        "pages": ["dataframe", "pivot_table"],
-    },
-    {
-        "name": "Page",
-        "icon": "mdi-file-code",
-        "pages": ["head", "title"],
-    },
-    {
-        "name": "Hooks",
-        "icon": "mdi-hook",
-        "pages": [
-            "use_cross_filter",
-            "use_thread",
-            "use_exception",
-            "use_effect",
-            "use_memo",
-            "use_previous",
-            "use_reactive",
-            "use_state",
-            "use_state_or_update",
-            "use_trait_observe",
-        ],
-    },
-    {
-        "name": "Types",
-        "icon": "mdi-fingerprint",
-        "pages": ["route"],
-    },
-    {
-        "name": "Routing",
-        "icon": "mdi-router",
-        "pages": ["use_route", "use_router", "resolve_path", "generate_routes", "generate_routes_directory", "link"],
-    },
-    {
-        "name": "Utils",
-        "icon": "mdi-hammer-wrench",
-        "pages": [
-            "display",
-            "get_kernel_id",
-            "get_session_id",
-            "memoize",
-            "reactive",
-            "widget",
-            "component_vue",
-        ],
-    },
-    {
-        "name": "Advanced",
-        "icon": "mdi-head-cog-outline",
-        "pages": ["style", "meta"],
-    },
-    {
-        "name": "Cross filter",
-        "icon": "mdi-filter-variant-remove",
-        "pages": ["cross_filter_dataframe", "cross_filter_report", "cross_filter_slider", "cross_filter_select"],
-    },
-    {
-        "name": "Enterprise",
-        "icon": "mdi-office-building",
-        "pages": ["avatar", "avatar_menu"],
-    },
-    {
-        "name": "Lab (experimental)",
-        "icon": "mdi-flask-outline",
-        "pages": [
-            "computed",
-            "chat",
-            "confirmation_dialog",
-            "cookies_headers",
-            "menu",
-            "input_date",
-            "on_kernel_start",
-            "tab",
-            "tabs",
-            "task",
-            "theming",
-            "use_task",
-            "use_dark_effective",
-        ],
-    },
-]
-
-
-@solara.component
-def Page():
-    # show a gallery of all the api pages
-    router = solara.use_router()
-    route_current = router.path_routes[-2]
-
-    routes = {r.path: r for r in route_current.children}
-
-    for item in items:
-        solara.Markdown(f"## {item['name']}")
-        with solara.ColumnsResponsive(12, 6, 6, 4, 4):
-            for page in item["pages"]:
-                if page not in routes:
-                    continue
-                route = routes[page]
-                path = route.path
-                image_url = None
-                if page in [
-                    "button",
-                    "checkbox",
-                    "confirmation_dialog",
-                    "echarts",
-                    "file_browser",
-                    "file_download",
-                    "matplotlib",
-                    "select",
-                    "switch",
-                    "tooltip",
-                ]:
-                    image_url = "https://dxhl76zpt6fap.cloudfront.net/public/api/" + page + ".gif"
-                elif page in ["card", "dataframe", "pivot_table", "slider"]:
-                    image_url = "https://dxhl76zpt6fap.cloudfront.net/public/api/" + page + ".png"
-                else:
-                    image_url = "https://dxhl76zpt6fap.cloudfront.net/public/logo.svg"
-
-                path = getattr(route.module, "redirect", path)
-                if path:
-                    with rv.Card(
-                        elevation=2,
-                        dark=False,
-                        height="100%",
-                        style_="display: flex; flex-direction: column; justify-content: space-between;",
-                    ):
-                        rv.CardTitle(children=[route.label])
-                        with rv.CardText():
-                            with solara.Link(path):
-                                with solara.Column(align="center"):
-                                    solara.Image(image_url, width="120px")
-                        doc = route.module.__doc__ or ""
-                        if doc:
-                            lines = doc.split("\n")
-                            lines = [line.strip() for line in lines if line.strip()]
-                            first = lines[1]
-
-                            rv.CardText(
-                                children=[solara.Markdown(first)],
-                            )
-
-
-@solara.component
-def NoPage():
-    raise RuntimeError("This page should not be rendered")
-
-
-@solara.component
-def Sidebar(children=[], level=0):
-    # note that we don't use children here, but we used route.module instead to ge the module
-    # this is fine because all api/*.py files use the standard Page component, and do not add
-    # a new Layout component
-    route_current, all_routes = solara.use_route()
-    if route_current is None:
-        return solara.Error("Page not found")
-
-    # keeps track of which routes we includes
-    routes = {r.path: r for r in all_routes.copy()}
-
-    def add(path):
-        route = routes[path]
-        with solara.Link(route):
-            ListItem(route.label, class_="active" if route_current is not None and path == route_current.path else None)
-        del routes[path]
-
-    # with solara.HBox(grow=True) as main:
-    with rv.Col(tag="aside", md=4, lg=3, class_="sidebar bg-grey d-none d-md-block") as main:
-        with solara.Head():
-            name = route_current.label if route_current.label is not None else "No name"
-            if name == "API":
-                solara.Title("Solara » API overview")
-            else:
-                solara.Title("Solara » API » " + name)
-        with List():
-            add("/")
-
-            for item in items:
-                with ListItem(item["name"], icon_name=item["icon"]):
-                    with List():
-                        for component in item["pages"]:
-                            add(component)
-
-        if routes:
-            print(f"Routes not used: {list(routes.keys())}")  # noqa
-
-    return main
-
-
-@solara.component
-def Layout(children=[]):
-    route_current, all_routes = solara.use_route()
-    if route_current is None:
-        return solara.Error("Page not found")
-
-    if route_current.path == "/":
-        return Page()
-    else:
-        with solara.HBox(grow=True) as main:
-            with solara.Padding(4):
-                if route_current.module:
-                    # we ignore children, and make the element again
-                    WithCode(route_current.module)
-        return main
-
-
-@solara.component
-def WithCode(module):
-    # e = solara.use_exception_handler()
-    # if e is not None:
-    #     return solara.Error("oops")
-    component = getattr(module, "Page", None)
-    with rv.Sheet() as main:
-        # It renders code better
-        solara.Markdown(
-            module.__doc__ or "# no docs yet",
-            unsafe_solara_execute=True,
-        )
-        if component and component != NoPage:
-            with solara.Card("Example", margin=0, classes=["mt-8"]):
-                component()
-                github_url = solara.util.github_url(module.__file__)
-                solara.Button(
-                    label="View source",
-                    icon_name="mdi-github-circle",
-                    attributes={"href": github_url, "target": "_blank"},
-                    text=True,
-                    outlined=True,
-                    class_="mt-8",
-                )
-    return main

solara/website/pages/api/default_layout.py

@@ -1,16 +0,0 @@
-"""# DefaultLayout
-
-"""
-
-import solara
-from solara.website.utils import apidoc
-
-title = "DefaultLayout"
-
-
-@solara.component
-def Page():
-    return solara.Warning("This component does not render well as a child component. If you want to see it, you should follow the multipage guide above 🙂")
-
-
-__doc__ += apidoc(solara.DefaultLayout.f)  # type: ignore

solara/website/pages/api/file_drop.py

@@ -1,36 +0,0 @@
-"""
-# FileDrop
-"""
-import textwrap
-
-import solara
-from solara.components.file_drop import FileInfo
-from solara.website.utils import apidoc
-
-
-@solara.component
-def Page():
-    content, set_content = solara.use_state(b"")
-    filename, set_filename = solara.use_state("")
-    size, set_size = solara.use_state(0)
-
-    def on_file(file: FileInfo):
-        set_filename(file["name"])
-        set_size(file["size"])
-        f = file["file_obj"]
-        set_content(f.read(100))
-
-    with solara.Div() as main:
-        solara.FileDrop(
-            label="Drag and drop a file here to read the first 100 bytes",
-            on_file=on_file,
-            lazy=True,  # We will only read the first 100 bytes
-        )
-        if content:
-            solara.Info(f"File {filename} has total length: {size}\n, first 100 bytes:")
-            solara.Preformatted("\n".join(textwrap.wrap(repr(content))))
-
-    return main
-
-
-__doc__ += apidoc(solara.FileDrop.f)  # type: ignore

solara/website/pages/docs/content/04-tutorial/00-overview.md

@@ -1,9 +0,0 @@
-# Tutorials
-
-Instead of having one tutorial, we have tutorials for different audiences.
-
-  * [Jupyter Dashboard](/docs/tutorial/jupyter-dashboard-part1): Learn to create a dashboard in the Jupyter notebook.
-  * [Data science](/docs/tutorial/data-science): In this tutorial, we will introduce Solara from the perspective of a data scientist or when you are thinking of using Solara for a data science app.
-  * [Web app](/docs/tutorial/web-app): You are not a data scientist, but you are interested in using Solara to create a web app using Pure Python.
-  * [IPywidgets user](/docs/tutorial/ipywidgets): If you are already using [ipywidgets](/docs/understanding/ipywidgets) you will learn how to use the [Solara server](/docs/understanding/solara-server) to render your regular ipywidget applications.
-  * [Streamlit](/docs/tutorial/streamlit): If you are an existing Streamlit user, this might appeal more to you.

solara/website/pages/docs/content/07-fundamentals/00-overview.md

@@ -1,7 +0,0 @@
-# Fundamentals
-
-If you want to dive deeper into Solara, this section is for you. We will cover the following topics:
-
-  * [Components](/docs/fundamentals/components)
-  * Hooks (soon)
-  * [State management](/docs/fundamentals/state-management)

solara/website/pages/docs/content/15-reference/00-overview.md

@@ -1,6 +0,0 @@
-# Reference documentation
-
-Our reference documentation informs you about how certain parts in Solara work.
-
-The [API docs](/api) are considered part of the reference documentation, but because of the
-large content has its own page.

solara/website/pages/docs/content/20-understanding/00-introduction.md

@@ -1,4 +0,0 @@
-# Introduction
-
-Solara builds on existing technologies. If you are new to Solara or some of the underlying technologies, you may feel lost at times.
-These 'understanding' guides are meant to help you understand topics at a deeper level and how they connect to Solara.

solara/website/pages/docs/content/20-understanding/17-rules-of-hooks.md

@@ -1,3 +0,0 @@
-# Rules of hooks
-
-For now, we refer to the [ReactJS documentation](https://reactjs.org/docs/hooks-rules.html).

solara/website/pages/docs/content/30-deploying/00-overview.md

@@ -1,3 +0,0 @@
-# Deploying a solara app
-
-A Solara app can be [self hosted](/docs/deploying/self-hosted) or [cloud hosted](/docs/deploying/cloud-hosted).

solara/website/pages/docs/content/lab/00-what-is-lab.md

@@ -1,3 +0,0 @@
-# What is Solara lab?
-
-Solara lab is a subpackage in solara containing Components, hooks and parts of Solara that are slightly experimental.