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

solara/website/pages/{api → documentation/components/lab}/use_task.py

@@ -4,10 +4,9 @@
 import solara
 import solara.autorouting
 import solara.lab
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "use_task"
 Page = NoPage
 __doc__ += apidoc(solara.lab.use_task)  # type: ignore

solara/website/pages/documentation/components/layout/__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/{api → documentation/components/layout}/app_bar.py

@@ -4,10 +4,9 @@
 """
 import solara
 import solara.lab
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "AppBar"
 
 Page = NoPage

solara/website/pages/{api → documentation/components/layout}/app_bar_title.py

@@ -4,10 +4,9 @@
 """
 import solara
 import solara.lab
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "AppBarTitle"
 
 Page = NoPage

solara/website/pages/{api → documentation/components/layout}/card.py

@@ -4,10 +4,9 @@
 """
 import solara
 import solara.lab
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "Card"
 
 Page = NoPage

solara/website/pages/{api → documentation/components/layout}/card_actions.py

@@ -4,10 +4,9 @@
 """
 import solara
 import solara.lab
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "CardActions"
 
 Page = NoPage

solara/website/pages/{api → documentation/components/layout}/griddraggable.py

@@ -8,7 +8,7 @@ import textwrap
 
 import solara
 
-from .common import ColorCard
+from ..common import ColorCard
 
 title = "GridDraggable"
 

solara/website/pages/{api → documentation/components/layout}/gridfixed.py

@@ -6,7 +6,7 @@ Lays out children in a grid with a fixed number of columns.
 
 import solara
 
-from .common import ColorCard
+from ..common import ColorCard
 
 title = "GridFixed"
 

solara/website/pages/{api → documentation/components/layout}/hbox.py

@@ -4,7 +4,7 @@ Lays out children in horizontal direction.
 """
 import solara
 
-from .common import ColorCard
+from ..common import ColorCard
 
 
 @solara.component

solara/website/pages/{api → documentation/components/layout}/vbox.py

@@ -6,7 +6,7 @@ Lays out children in a vertical direction.
 
 import solara
 
-from .common import ColorCard
+from ..common import ColorCard
 
 
 @solara.component

solara/website/pages/documentation/components/output/__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/{api → documentation/components/output}/file_download.py

@@ -2,10 +2,9 @@
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 Page = NoPage
 title = "FileDownload"
 

solara/website/pages/{api → documentation/components/output}/image.py

@@ -2,10 +2,9 @@
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 Page = NoPage
 title = "Image"
 

solara/website/pages/{api → documentation/components/output}/tooltip.py

@@ -2,10 +2,9 @@
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 Page = NoPage
 title = "Tooltip"
 

solara/website/pages/documentation/components/page/__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/status/__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/{api → documentation/components/status}/error.py

@@ -2,9 +2,9 @@
 
 Solara has 4 types of alerts:
 
- * [Success](/api/success)
- * [Info](/api/info)
- * [Warning](/api/warning)
+ * [Success](/documentation/components/status/success)
+ * [Info](/documentation/components/status/info)
+ * [Warning](/documentation/components/status/warning)
  * Error (this page)
 
 

solara/website/pages/{api → documentation/components/status}/info.py

@@ -2,10 +2,10 @@
 
 Solara has 4 types of alerts:
 
- * [Success](/api/success)
+ * [Success](/documentation/components/status/success)
  * Info (this page)
- * [Warning](/api/warning)
- * [Error](/api/error)
+ * [Warning](/documentation/components/status/warning)
+ * [Error](/documentation/components/status/error)
 
 
 

solara/website/pages/{api → documentation/components/status}/progress.py

@@ -1,10 +1,9 @@
 """# ProgressLinear
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 Page = NoPage
 
 

solara/website/pages/{api → documentation/components/status}/spinner.py

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

solara/website/pages/{api → documentation/components/status}/success.py

@@ -3,9 +3,9 @@
 Solara has 4 types of alerts:
 
  * Success (this page)
- * [Info](/api/info)
- * [Warning](/api/warning)
- * [Error](/api/error)
+ * [Info](/documentation/components/status/info)
+ * [Warning](/documentation/components/status/warning)
+ * [Error](/documentation/components/status/error)
 
 
 

solara/website/pages/{api → documentation/components/status}/warning.py

@@ -2,10 +2,10 @@
 
 Solara has 4 types of alerts:
 
- * [Success](/api/success)
- * [Info](/api/info)
+ * [Success](/documentation/components/status/success)
+ * [Info](/documentation/components/status/info)
  * Warning (this page)
- * [Error](/api/error)
+ * [Error](/documentation/components/status/error)
 
 
 

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/{api → documentation/components/viz}/plotly.py

@@ -10,6 +10,7 @@ This can be significantly faster than comparing he figure data directly.
 """
 
 import plotly.express as px
+
 import solara
 
 df = px.data.iris()

solara/website/pages/{examples → documentation/examples}/__init__.py

@@ -1,52 +1,12 @@
-# import inspect
-# import urllib.parse
-
 import solara
+from solara.website.components import Gallery
 
 title = "Examples"
 
 
 @solara.component
-def Page():
-    # show a gallery of all the examples
-    router = solara.use_router()
-    route_current = router.path_routes[-2]
-
-    for route in route_current.children:
-        if route.children:
-            solara.Markdown(f"## {route.label}\n" + (route.module.__doc__ or ""))
-            with solara.ColumnsResponsive(12, 6, 6, 6, 4):
-                for child in route.children:
-                    path = route.path + "/" + child.path
-                    if child.path in [
-                        "tokenizer",
-                        "sine",
-                        "authorization",
-                        "layout_demo",
-                        "multipage",
-                        "scatter",
-                        "scrolling",
-                        "tutorial_streamlit",
-                        "login_oauth",
-                        "pokemon_search",
-                        "altair",
-                        "bqplot",
-                        "ipyleaflet",
-                        "calculator",
-                        "countdown_timer",
-                        "todo",
-                    ]:
-                        image = route.path + "/" + child.path + ".png"
-                        image_url = "https://dxhl76zpt6fap.cloudfront.net/public/examples/" + image
-                    else:
-                        image_url = "https://dxhl76zpt6fap.cloudfront.net/public/logo.svg"
-
-                    path = getattr(child.module, "redirect", path)
-                    if path:
-                        with solara.Card(child.label, style="height: 100%;"):
-                            with solara.Link(path):
-                                with solara.Column(align="center"):
-                                    solara.Image(image_url, width="120px" if image_url.endswith(".svg") else "100%")
+def Page(route_external=None):
+    Gallery(route_external)
 
 
 @solara.component

solara/website/pages/{examples → documentation/examples}/general/deploy_model.py

@@ -1,7 +1,8 @@
 """# Deploy model demo
 
-This show off a combination of [solara.lab.Menu](/api/menu) and [solara.lab.ConfirmationDialog](/api/confirmation_dialog)
-and [solara.use_thread](/api/use_thread) to demonstrate how to tune, fit and deploy a model.
+This show off a combination of [solara.lab.Menu](/documentation/components/lab/menu) and
+    [solara.lab.ConfirmationDialog](/documentation/components/lab/confirmation_dialog)
+and [solara.use_thread](/documentation/api/hooks/use_thread) to demonstrate how to tune, fit and deploy a model.
 The actually deployment is not real, but simulated by a thread that returns a boolean value on success and sleep for a while to
 similate the deployment taking time.
 
@@ -15,7 +16,6 @@ import time
 import numpy as np
 import pandas as pd
 import plotly.express as px
-
 import solara
 import solara.lab
 

solara/website/pages/{examples → documentation/examples}/general/login_oauth.py

@@ -54,7 +54,7 @@ def Page():
 
                     This is the raw user data from the auth provider.
 
-                    We use the `picture` field to display an avatar in the [AppBar](/api/appbar).
+                    We use the `picture` field to display an avatar in the [AppBar](/documentation/components/layout/app_bar).
                 """
                 )
                 sl.Preformatted(pprint.pformat(auth.user.value))

solara/website/pages/{examples → documentation/examples}/general/vue_component.py

@@ -4,7 +4,7 @@ Although many components can be made from the Python side, sometimes it is easie
 It can also be beneficial for performance, since instead of creating many widgets from the Python side we only send data to
 the frontend. If event handling is also done on the frontend, this reduces latency and makes you app feel much smoother.
 
-See [the API documentation on component_vue](/api/component_vue) for more information.
+See [the API documentation on component_vue](/documentation/api/utilities/component_vue) for more information.
 
 This example is based on [the vuetify docs](https://v2.vuetifyjs.com/en/components/sparklines/#custom-labels),
 Note that the "Go to report" button does not do anything yet.
@@ -14,7 +14,6 @@ Note that the "Go to report" button does not do anything yet.
 from typing import Callable
 
 import numpy as np
-
 import solara
 
 seed = solara.reactive(42)

solara/website/pages/{examples → documentation/examples}/libraries/altair.py

@@ -2,16 +2,15 @@
 
 [Altair](https://altair-viz.github.io/index.html) is a declarative statistical visualization library for Python.
 
-This example show how to use the [on_click handler](/api/altair) to display data for a specific day in the chart.
+This example show how to use the [on_click handler](/documentation/components/viz/altair) to display data for a specific day in the chart.
 
 Based on [an Altair example](https://altair-viz.github.io/gallery/annual_weather_heatmap.html)
 
 """
 import altair as alt
 import pandas as pd
-from vega_datasets import data
-
 import solara
+from vega_datasets import data
 
 # title = "Altair visualization"
 source = data.seattle_weather()

solara/website/pages/{examples → documentation/examples}/libraries/ipyleaflet_advanced.py

@@ -1,7 +1,7 @@
 """
 # ipyleaflet advanced
 
-Extends the [basic ipyleaflet example](/examples/libraries/ipyleaflet) with a marker that can be dragged around, and a
+Extends the [basic ipyleaflet example](/documentation/examples/libraries/ipyleaflet) with a marker that can be dragged around, and a
 dropdown to select the map style. Two buttons allow to reset the map to the default zoom and center and to zoom
 to the marker.
 """

solara/website/pages/{examples → documentation/examples}/utilities/countdown_timer.py

@@ -1,6 +1,6 @@
 """# Countdown timer.
 
-This example shows how to use [use_thread](/api/use_thread) to create a countdown timer.
+This example shows how to use [use_thread](/documentation/api/hooks/use_thread) to create a countdown timer.
 
 The UI code demonstrates a lot of conditional rendering.
 

solara/website/pages/{examples → documentation/examples}/visualization/plotly.py

@@ -8,12 +8,11 @@ Inspired by the dash documentation.
 ## Note
 
 Solara supports plotly and plotly express. Create your figure (not a figure widget)
-and pass it to the [FigurePlotly](/api/plotly) component.
+and pass it to the [FigurePlotly](/documentation/components/viz/plotly) component.
 
 """
 import pandas as pd
 import plotly.express as px
-
 import solara
 
 title = "Scatter plot using Plotly"

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

@@ -0,0 +1,11 @@
+from pathlib import Path
+
+import solara
+
+title = "FAQ"
+HERE = Path(__file__)
+
+
+@solara.component
+def Page(route_external=None):
+    solara.Markdown(Path(HERE.parent / "content" / "99-faq.md").read_text())

solara/website/pages/{docs → documentation/getting_started}/__init__.py

@@ -1,9 +1,15 @@
 from pathlib import Path
 
+import solara
 from solara.autorouting import generate_routes_directory
 
-title = "Docs"
+title = "Getting Started"
 HERE = Path(__file__)
 # if we didn't put the content in the subdirectory, but pointed to the current file
 # we would include the current file recursively, causing an infinite loop
 routes = generate_routes_directory(HERE.parent / "content")
+
+
+@solara.component
+def Page(route_external=None):
+    solara.Markdown(Path(HERE.parent / "content" / "00-introduction.md").read_text())

solara/website/pages/{docs/content/03-quickstart.md → documentation/getting_started/content/00-quickstart.md}

@@ -7,12 +7,12 @@ This 1-minute quickstart will get you to:
    * Run your script using Solara server.
    * (Optional) Reuse your code in the Jupyter notebook.
 
-If you are an existing ipywidget user and do not want to learn the component based method, you might want to skip the quickstart and directly go to the [IPywidgets user tutorial](/docs/tutorial/ipywidgets).
+If you are an existing ipywidget user and do not want to learn the component based method, you might want to skip the quickstart and directly go to the [IPywidgets user tutorial](/documentation/getting_started/tutorials/ipywidgets).
 
 ## Installation
 
 
-Run `pip install solara`, or follow the [Installation instructions](/docs/installing) for more detailed instructions.
+Run `pip install solara`, or follow the [Installation instructions](/documentation/getting_started/installing) for more detailed instructions.
 
 
 ## First script

solara/website/pages/{docs/content/00-introduction.md → documentation/getting_started/content/01-introduction.md}

@@ -5,7 +5,7 @@
 
 Solara is an Open Source library that lets you use and build data-focused web apps (data apps) using reusable UI components. Your app will work in the Jupyter notebook and production-grade web frameworks (FastAPI, Starlette, Flask, ...).
 
-Solara uses proven technologies and mature standards. Grow from a one-off experiment in the Jupyter notebook to a dynamic data portal in production.  Built on top of [Reacton](/docs/understanding/reacton) to keep your code complexity under control and [IPywidgets](/docs/understanding/ipywidgets) to access a rich set of UI libraries without having to write Javascript or CSS.
+Solara uses proven technologies and mature standards. Grow from a one-off experiment in the Jupyter notebook to a dynamic data portal in production.  Built on top of [Reacton](/documentation/advanced/understanding/reacton) to keep your code complexity under control and [IPywidgets](/documentation/advanced/understanding/ipywidgets) to access a rich set of UI libraries without having to write Javascript or CSS.
 
 We care about developer experience. Solara will give your hot code reloading and type hints for faster development.
 
@@ -17,19 +17,19 @@ Many frameworks only solve a specific set of problems. Once you step outside of
 
 On the other extreme, you might be working with a library with no clear patterns that let you do anything. You may only be weeks away from a total code complexity nightmare, which slowly kills your project.
 
-At the same time, starting a new framework from scratch would be unwise. We prefer to build on top of solid, battle-tested libraries, such as [IPywidgets](/docs/understanding/ipywidgets).
+At the same time, starting a new framework from scratch would be unwise. We prefer to build on top of solid, battle-tested libraries, such as [IPywidgets](/documentation/advanced/understanding/ipywidgets).
 
 ## Why use Solara?
 
 Instead of inventing a new API with an unknown track record, we take a different approach. We look at the JavaScript world. React is a technology that has proven itself for many years. It has shown to be a good all-around model for building complex UIs.
 
-[Reacton](/docs/understanding/reacton) is the equivalent of ReactJS for Python (and IPywidgets). It allows us to use the same reusable components and hooks as in the ReactJS ecosystem. Using Reacton, we build web/data applications without suffering from complex code bases.
+[Reacton](/documentation/advanced/understanding/reacton) is the equivalent of ReactJS for Python (and IPywidgets). It allows us to use the same reusable components and hooks as in the ReactJS ecosystem. Using Reacton, we build web/data applications without suffering from complex code bases.
 
 Looking again at the JavaScript world, we see software such as NextJS is putting a framework around ReactJS. NextJS is more opinionated than ReactJS and adds more "batteries" such as routing.
 
 Solara plays a similar role as NextJS. It builds on top of Reacton but handles things like routing for you.
 
-But Solara is also different and is even more opinionated than NextJS. The reason for this is its focus on the data-heavy Python ecosystem. For this reason, it comes with many components and hooks that make building beautiful data apps easier (see our [API](/api)).
+But Solara is also different and is even more opinionated than NextJS. The reason for this is its focus on the data-heavy Python ecosystem. For this reason, it comes with many components and hooks that make building beautiful data apps easier (see our [Documentation](/documentation)).
 
 Solara is a clear, systematic, Python-based web framework using industry-trusted technology. Smooth developer experience and enforced code modularity will allow you to build a data app at any scale while maintaining simple code.
 
@@ -37,7 +37,7 @@ Solara is a clear, systematic, Python-based web framework using industry-trusted
 
 For your understanding, it might be good just to run an example.
 
-Follow the [installation instructions](/docs/installing) or do the TLDR:
+Follow the [installation instructions](/documentation/getting_started/installing) or do the TLDR:
 
     $ pip install solara
 
@@ -78,18 +78,18 @@ The browser should open http://127.0.0.1:8765
 Solara is actually two things.
 
 ### Solara server
-[Solara server](/docs/understanding/solara-server) renders ipywidgets in the browser in a very efficient manner and takes care of many other things
-such as [routing](/docs/understanding/routing) and [Static Site Generation](/docs/reference/static-site-generation).
+[Solara server](/documentation/advanced/understanding/solara-server) renders ipywidgets in the browser in a very efficient manner and takes care of many other things
+such as [routing](/documentation/advanced/understanding/routing) and [Static Site Generation](/documentation/getting_started/reference/static-site-generation).
 
 ### Solara UI
 
-The UI part is built on top of [Reacton](/docs/understanding/reacton), which uses the existing IPyWidgets stack. It gives a consistent set
+The UI part is built on top of [Reacton](/documentation/advanced/understanding/reacton), which uses the existing IPyWidgets stack. It gives a consistent set
 of modern UI components with the Material Design look, as well as a set of routines to make application development of data heavy web apps
 easier.
 
 
 ### Overview
-If you use Jupyter, then you probably use the Jupyter notebook, Lab, or [Voila](/docs/understanding/voila) to get your widgets into the browser. You may not care about [Solara server](/docs/understanding/solara-server) and can focus on just the UI part.
+If you use Jupyter, then you probably use the Jupyter notebook, Lab, or [Voila](/documentation/advanced/understanding/voila) to get your widgets into the browser. You may not care about [Solara server](/documentation/advanced/understanding/solara-server) and can focus on just the UI part.
 
 If you don't use Jupyter, don't know what it is, or are an ML Ops, Dev Ops, or Sys Admin, you are probably more interested in the Solara server.
 
@@ -99,19 +99,19 @@ If you don't use Jupyter, don't know what it is, or are an ML Ops, Dev Ops, or S
 
 We recommend going through the documentation linearly following the arrows on the bottom, meaning you will go through:
 
- * [Installing](/docs/installing)
- * [Quick start](/docs/quickstart)
- * [Tutorials](/docs/tutorial)
+ * [Installing](/documentation/getting_started/installing)
+ * [Quick start](/documentation/getting_started)
+ * [Tutorials](/documentation/getting_started/tutorials)
 
-If you want to know more about specific parts, you can go through the [How-to section](/docs/howto) to learn more. Feel free to skip chapters, and go back to topics when you need to.
+If you want to know more about specific parts, you can go through the [How-to section](/documentation/advanced/howto) to learn more. Feel free to skip chapters, and go back to topics when you need to.
 
 
-If you want to know what components or hooks are available, or want to know more about a specific component, check out the [API](/api) which includes live code examples. Other reference documentation can be found at the [reference section](/docs/reference)
+If you want to know what components or hooks are available, or want to know more about a specific component, check out the [Documentation](/documentation) which includes live code examples. Other reference documentation can be found at the [reference section](/documentation/getting_started/reference)
 
-If you feel like you miss some basic understanding and want to give a bit deeper into the what and why feel free to explore the [Understanding section](/docs/understanding).
+If you feel like you miss some basic understanding and want to give a bit deeper into the what and why feel free to explore the [Understanding section](/documentation/advanced/understanding).
 
 
-[Our examples](/examples) may help you see how particular problems can be solved using Solara, or as inspiration. If you want to contribute an example, contact us on GitHub or directly open a [Pull Request](https://github.com/widgetti/solara/).
+[Our examples](/documentation/examples) may help you see how particular problems can be solved using Solara, or as inspiration. If you want to contribute an example, contact us on GitHub or directly open a [Pull Request](https://github.com/widgetti/solara/).
 
 
 ## Where can I hire an expert?

solara/website/pages/{docs → documentation/getting_started}/content/02-installing.md

@@ -44,7 +44,7 @@ solara @ https://github.com/widgetti/solara/package/archive/master.tar.gz
 
 ```
 
-If you want to do development on Solara, read the [development documentation](/docs/development).
+If you want to do development on Solara, read the [development documentation](/documentation/advanced/development/setup).
 
 ## Air-gapped installation / Firewalled network
 

solara/website/pages/documentation/getting_started/content/04-tutorials/00-overview.md

@@ -0,0 +1,9 @@
+# Tutorials
+
+Instead of having one tutorial, we have tutorials for different audiences.
+
+  * [Jupyter Dashboard](/documentation/getting_started/tutorials/jupyter-dashboard-part1): Learn to create a dashboard in the Jupyter notebook.
+  * [Data science](/documentation/getting_started/tutorials/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](/documentation/getting_started/tutorials/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](/documentation/getting_started/tutorials/ipywidgets): If you are already using [ipywidgets](/documentation/advanced/understanding/ipywidgets) you will learn how to use the [Solara server](/documentation/advanced/understanding/solara-server) to render your regular ipywidget applications.
+  * [Streamlit](/documentation/getting_started/tutorials/streamlit): If you are an existing Streamlit user, this might appeal more to you.