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

solara/website/pages/documentation/examples/utilities/todo.py

@@ -1,195 +0,0 @@
-"""# Todo application
-
-Demonstrates the use of reactive variables in combinations with dataclasses.
-
-With solara we can get a type safe view onto a field in a dataclass, pydantic model, or
-attr object.
-
-This is using the experimental `solara.lab.Ref` class, which is not yet part of the
-official API.
-
-
-```python
-import dataclasses
-import solara
-from solara.lab import Ref
-
-@dataclasses.dataclass(frozen=True)
-class TodoItem:
-    text: str
-    done: bool
-
-todo_item = solara.reactive(TodoItem("Buy milk", False))
-
-# now text is a reactive variable that is always in sync with todo_item.text
-text = Ref(todo_item.fields.text)
-
-
-# we can now modify the reactive text variable
-# and see its value reflect in the todo_item
-text.value = "Buy skimmed milk"
-assert todo_item.value.text == "Buy skimmed milk"
-
-# Or, the other way around
-todo_item.value = TodoItem("Buy whole milk", False)
-assert text.value == "Buy whole milk"
-```
-
-Apart from dataclasses, pydantic models etc, we also supports dictionaries and lists.
-
-```python
-todo_items = solara.reactive([TodoItem("Buy milk", False), TodoItem("Buy eggs", False)])
-todo_item_eggs = Ref(todo_items.fields[1])
-todo_item_eggs.value = TodoItem("Buy eggs", True)
-assert todo_items.value[1].done == True
-
-# However, if a list becomes shorter, and the valid index is now out of range, the
-# reactive variables will act as if it is "not connected", and will not trigger
-# updates anymore. Accessing the value will raise an IndexError.
-
-todo_items.value = [TodoItem("Buy milk", False)]
-# anyone listening to todo_item_eggs will *not* be notified.
-try:
-    value = todo_item_eggs.value
-except IndexError:
-    print("this is expected")
-else:
-    raise AssertionError("Expected an IndexError")
-```
-
-"""
-import dataclasses
-from typing import Callable
-
-import reacton.ipyvuetify as v
-
-import solara
-from solara.lab.toestand import Ref
-
-
-# our model for a todo item, immutable/frozen avoids common bugs
-@dataclasses.dataclass(frozen=True)
-class TodoItem:
-    text: str
-    done: bool
-
-
-@solara.component
-def TodoEdit(todo_item: solara.Reactive[TodoItem], on_delete: Callable[[], None], on_close: Callable[[], None]):
-    """Takes a reactive todo item and allows editing it. Will not modify the original item until 'save' is clicked."""
-    copy = solara.use_reactive(todo_item.value)
-
-    def save():
-        todo_item.value = copy.value
-        on_close()
-
-    with solara.Card("Edit", margin=0):
-        solara.InputText(label="", value=Ref(copy.fields.text))
-        with solara.CardActions():
-            v.Spacer()
-            solara.Button("Save", icon_name="mdi-content-save", on_click=save, outlined=True, text=True)
-            solara.Button("Close", icon_name="mdi-window-close", on_click=on_close, outlined=True, text=True)
-            solara.Button("Delete", icon_name="mdi-delete", on_click=on_delete, outlined=True, text=True)
-
-
-@solara.component
-def TodoListItem(todo_item: solara.Reactive[TodoItem], on_delete: Callable[[TodoItem], None]):
-    """Displays a single todo item, modifications are done 'in place'.
-
-    For demonstration purposes, we allow editing the item in a dialog as well.
-    This will not modify the original item until 'save' is clicked.
-    """
-    edit, set_edit = solara.use_state(False)
-    with v.ListItem():
-        solara.Button(icon_name="mdi-delete", icon=True, on_click=lambda: on_delete(todo_item.value))
-        solara.Checkbox(value=Ref(todo_item.fields.done))  # , color="success")
-        solara.InputText(label="", value=Ref(todo_item.fields.text))
-        solara.Button(icon_name="mdi-pencil", icon=True, on_click=lambda: set_edit(True))
-        with v.Dialog(v_model=edit, persistent=True, max_width="500px", on_v_model=set_edit):
-            if edit:  # 'reset' the component state on open/close
-
-                def on_delete_in_edit():
-                    on_delete(todo_item.value)
-                    set_edit(False)
-
-                TodoEdit(todo_item, on_delete=on_delete_in_edit, on_close=lambda: set_edit(False))
-
-
-@solara.component
-def TodoNew(on_new: Callable[[TodoItem], None]):
-    """Component that managed entering new todo items"""
-    new_text, set_new_text = solara.use_state("")
-    text_field = v.TextField(v_model=new_text, on_v_model=set_new_text, label="Enter a new todo item")
-
-    def create_new_item(*ignore_args):
-        if not new_text:
-            return
-        new_item = TodoItem(text=new_text, done=False)
-        on_new(new_item)
-        # reset text
-        set_new_text("")
-
-    v.use_event(text_field, "keydown.enter", create_new_item)
-    return text_field
-
-
-initial_items = [
-    TodoItem("Learn Solara", done=True),
-    TodoItem("Write cool apps", done=False),
-    TodoItem("Relax", done=False),
-]
-
-
-# We store out reactive state, and our logic in a class for organization
-# purposes, but this is not required.
-# Note that all the above components do not refer to this class, but only
-# to do the Todo items.
-# This means all above components are reusable, and can be used in other
-# places, while the components below use 'application'/'global' state.
-# They are not suited for reuse.
-
-
-class State:
-    todos = solara.reactive(initial_items)
-
-    @staticmethod
-    def on_new(item: TodoItem):
-        State.todos.value = [item] + State.todos.value
-
-    @staticmethod
-    def on_delete(item: TodoItem):
-        new_items = list(State.todos.value)
-        new_items.remove(item)
-        State.todos.value = new_items
-
-
-@solara.component
-def TodoStatus():
-    """Status of our todo list"""
-    items = State.todos.value
-    count = len(items)
-    items_done = [item for item in items if item.done]
-    count_done = len(items_done)
-
-    if count != count_done:
-        with solara.Row():
-            percent = count_done / count * 100
-            solara.ProgressLinear(value=percent)
-        with solara.Row():
-            solara.Text(f"Remaining: {count - count_done}")
-            solara.Text(f"Completed: {count_done}")
-    else:
-        solara.Success("All done, awesome!", dense=True)
-
-
-@solara.component
-def Page():
-    with solara.Card("Todo list", style="min-width: 500px"):
-        TodoNew(on_new=State.on_new)
-        if State.todos.value:
-            TodoStatus()
-            for index, item in enumerate(State.todos.value):
-                todo_item = Ref(State.todos.fields[index])
-                TodoListItem(todo_item, on_delete=State.on_delete)
-        else:
-            solara.Info("No todo items, enter some text above, and hit enter")

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

@@ -1,6 +0,0 @@
-import solara
-
-
-@solara.component
-def Page():
-    return solara.Markdown("Click an example on the left")

solara/website/pages/documentation/examples/visualization/annotator.py

@@ -1,68 +0,0 @@
-"""# Image annotation with Solara
-
-This example displays how to annotate images with different drawing tools in plotly figures. Use the canvas
-below to draw shapes and visualize the canvas callback.
-
-
-Check [plotly docs](https://dash.plotly.com/annotations) for more information about image annotation.
-"""
-import json
-
-import plotly.graph_objects as go
-
-import solara
-
-title = "Plotly Image Annotator"
-shapes = solara.reactive(None)
-
-
-class CustomEncoder(json.JSONEncoder):
-    """
-    Custom JSON encoder for Plotly objects.
-
-    Plotly may return objects that the standard JSON encoder can't handle. This
-    encoder converts such objects to str, allowing serialization by json.dumps
-    """
-
-    def default(self, o):
-        if isinstance(o, object):
-            return str(o)
-        return super().default(o)
-
-
-@solara.component
-def Page():
-    def on_relayout(data):
-        if data is None:
-            return
-
-        relayout_data = data["relayout_data"]
-
-        if "shapes" in relayout_data:
-            shapes.value = relayout_data["shapes"]
-
-    fig = go.FigureWidget(
-        layout=go.Layout(
-            showlegend=False,
-            autosize=False,
-            width=600,
-            height=600,
-            dragmode="drawrect",
-            modebar={
-                "add": [
-                    "drawclosedpath",
-                    "drawcircle",
-                    "drawrect",
-                    "eraseshape",
-                ]
-            },
-        )
-    )
-
-    solara.FigurePlotly(fig, on_relayout=on_relayout)
-    if not shapes.value:
-        solara.Markdown("## Draw on the canvas")
-    else:
-        solara.Markdown("## Data returned by drawing")
-        formatted_shapes = str(json.dumps(shapes.value, indent=2, cls=CustomEncoder))
-        solara.Preformatted(formatted_shapes)

solara/website/pages/documentation/examples/visualization/linked_views.py

@@ -1,84 +0,0 @@
-"""# Linked views
-
-This example shows how to create linked views. The clicked row information is passed up to the parent component using an event,
-and then passed down to both child components.
-
-"""
-
-import dataclasses
-from typing import Callable, cast
-
-import plotly.express as px
-
-import solara
-
-df = px.data.iris()
-columns = list(df.columns)
-
-
-@dataclasses.dataclass
-class ClickPoint:
-    row_index: int
-    x_column: str
-    y_column: str
-
-
-def find_row_index(fig, click_data):
-    # goes from trace index and point index to row index in a dataframe
-    # requires passing df.index as to custom_data
-    trace_index = click_data["points"]["trace_indexes"][0]
-    point_index = click_data["points"]["point_indexes"][0]
-    trace = fig.data[trace_index]
-    return trace.customdata[point_index][0]
-
-
-@solara.component
-def ClickScatter(df, x, y, color, click_row, on_click: Callable[[ClickPoint], None]):
-    x, set_x = solara.use_state(x)
-    y, set_y = solara.use_state(y)
-    fig = px.scatter(df, x, y, color=color, custom_data=[df.index])
-
-    def on_click_trace(click_data):
-        # sanity checks
-        assert click_data["event_type"] == "plotly_click"
-        row_index = find_row_index(fig, click_data)
-        on_click(ClickPoint(row_index, x, y))
-
-    if click_row:
-        click_x = df[x].values[click_row]
-        click_y = df[y].values[click_row]
-        fig.add_trace(px.scatter(x=[click_x], y=[click_y], text=["⭐️"]).data[0])
-    # make the figure a bit smaller
-    fig.update_layout(width=400)
-    with solara.VBox() as main:
-        solara.FigurePlotly(fig, on_click=on_click_trace)
-        solara.Select(label="X-axis", value=x, values=columns, on_value=set_x)
-        solara.Select(label="Y-axis", value=y, values=columns, on_value=set_y)
-    return main
-
-
-@solara.component
-def Page():
-    click_point, set_click_point = solara.use_state(cast(ClickPoint, None))
-    if click_point:
-        clicked_row = click_point.row_index
-    else:
-        clicked_row = None
-
-    with solara.VBox() as main:
-        with solara.HBox():
-            ClickScatter(df, "sepal_length", "sepal_width", "species", clicked_row, on_click=set_click_point)
-            ClickScatter(df, "petal_length", "petal_width", "species", clicked_row, on_click=set_click_point)
-        if click_point is not None:
-            clicked_row = click_point.row_index
-            solara.Success(f"Clicked on row {clicked_row}. Which is highlighted in the both plots.")
-            solara.Markdown(
-                f"""
-            ```python
-            row_data = {df.iloc[clicked_row].to_dict()}
-            ```"""
-            )
-        else:
-            solara.Info("Click to select a point")
-
-    return main

solara/website/pages/documentation/examples/visualization/plotly.py

@@ -1,43 +0,0 @@
-"""# Scatter plot using Plotly
-
-This example shows how to use Plotly to create a scatter plot and a slider to do some filtering.
-
-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](/documentation/components/viz/plotly) component.
-
-"""
-import pandas as pd
-import plotly.express as px
-import solara
-
-title = "Scatter plot using Plotly"
-
-try:
-    df = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/gapminderDataFiveYear.csv")
-except Exception:
-    df = None
-
-if df is not None:
-    year_min = df["year"].min()
-    year_max = df["year"].max()
-    years = df["year"].unique().tolist()
-
-
-@solara.component
-def Page():
-    with solara.Div() as main:
-        index = solara.ui_slider(value=0, min=0, max=len(years) - 1, tick_labels=years, key="year slider index")
-        selected_year = years[index]
-
-        filtered_df = df[df.year == selected_year].copy()
-
-        fig = px.scatter(filtered_df, x="gdpPercap", y="lifeExp", size="pop", color="continent", hover_name="country", log_x=True, size_max=55)
-        fig.update_layout(transition_duration=1500)
-
-        solara.FigurePlotly(fig, dependencies=[selected_year])
-    return main

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

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

solara/website/pages/documentation/faq/content/99-faq.md

@@ -1,76 +0,0 @@
----
-title: FAQ about Solara
-description: Answers to some common questions about using Solara, and building your app using the framework
----
-# FAQ
-
-## I am not interested in the server, I'm happy with Jupyter/Voila, what's in it for me?
-
-That means you simply do not use or install the server component, just use the Reacton components and run it with Voila.
-
-## Is the Solara server better than Voilà?
-
-No, they are different, and there are situations where I would recommend Voila instead of Solara.
-
-If your app is compute-heavy, and a lot of the compute is happening in pure Python, the GIL (Global Interpreter Lock) can become a bottleneck with Solara, and Voila might give you better performance per client.
-
-If you have a lot of users with short sessions, Solara spares you from having to start up a kernel for each request. Since Solara can use multiple workers in the near future, you can still scale up using multiple processes. Voila will have one process per user, while Solara can share a process with many users.
-
-
-## Can Solara run a normal Python script?
-
-Yes, this is the preferred way of using Solara. You edit a Python script, save it, Solara will detect the file change and reload the page in your browser (no interaction is needed).
-
-```bash
-$ solara myapp.py
-Solara server is starting at http://localhost:8766
-... file change detected ...
-(server refreshes, your page will reload)
-
-```
-
-## Can Solara run from a Python package/module?
-
-Over time, when your application becomes larger, you probably want to structure your application into a Python package. Instead of a filename, you pass in the package name on the command line
-
-```bash
-$ solara mystartup.killerapp --dev
-....
-```
-
-## Can Solara run Jupyter notebook?
-
-Yes, Solara will execute each cell, and after that will look for a variable or component called `Page`, like with a normal script. All other output, Markdown or other types of cells will be ignored.
-
-
-
-## Can I use Solara in my existing FastAPI/Starlette/Flask server?
-
-Yes, take a look at the `solara.server.starlette`  and `solara.server.fastapi` and `solara.server.flask` module. The usage will change over time, so read the source and be ready to change this in the future. We do plan to provide a stable API for this in the future.
-
-
-## How to fix: inotify watch limit reached?
-
-Add the line
-
-    fs.inotify.max_user_watches=524288
-
-To your /etc/sysctl.conf file, and run `sudo sysctl -p.`
-
-Or if you are using visual studio code, please read: https://code.visualstudio.com/docs/setup/linux#_visual-studio-code-is-unable-to-watch-for-file-changes-in-this-large-workspace-error-enospc
-
-
-## How can I recognize if I run in Solara, Voila or Jupyter Notebook/Lab
-
-Voila and Solara set the following environment variables (based on the CGI spec):
-
-   * SERVER_SOFTWARE
-      * Solara: e.g. 'solara/1.2.3'
-      * Voila: e.g. 'voila/1.2.3'
-   * SERVER_PORT (e.g. '8765')
-   * SERVER_NAME (e.g. 'killerapp.com')
-   * SCRIPT_NAME (only Voila, e.g. 'voila/render/notebook.ipynb')
-   * PATH_TRANSLATED (only Solara e.g. '/mnt/someapp/app.py')
-
-Jupyter Notebook/Lab/Server do not set these variables. With this information,
-it should be possible to recognize in which environment you are running in.

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

@@ -1,9 +0,0 @@
-from pathlib import Path
-
-from solara.autorouting import generate_routes_directory
-from solara.website.components.markdown import MarkdownWithMetadata
-
-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", MarkdownWithMetadata)

solara/website/pages/documentation/getting_started/content/00-quickstart.md

@@ -1,89 +0,0 @@
----
-title: Solara Quickstart
-description: Get started with building web- and data-apps in pure python with Solara.
----
-
-# Quickstart
-
-This 1-minute quickstart will get you to:
-
-   * Install Solara.
-   * Write your first Solara script.
-   * 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](/documentation/getting_started/tutorials/ipywidgets).
-
-## Installation
-
-
-Run `pip install solara`, or follow the [Installation instructions](/documentation/getting_started/installing) for more detailed instructions.
-
-
-## First script
-
-Put the following Python snippet in a file (we suggest `sol.py`), or put it in a Jupyter notebook cell:
-
-```solara
-import solara
-
-# Declare reactive variables at the top level. Components using these variables
-# will be re-executed when their values change.
-sentence = solara.reactive("Solara makes our team more productive.")
-word_limit = solara.reactive(10)
-
-
-@solara.component
-def Page():
-    # Calculate word_count within the component to ensure re-execution when reactive variables change.
-    word_count = len(sentence.value.split())
-
-    solara.SliderInt("Word limit", value=word_limit, min=2, max=20)
-    solara.InputText(label="Your sentence", value=sentence, continuous_update=True)
-
-    # Display messages based on the current word count and word limit.
-    if word_count >= int(word_limit.value):
-        solara.Error(f"With {word_count} words, you passed the word limit of {word_limit.value}.")
-    elif word_count >= int(0.8 * word_limit.value):
-        solara.Warning(f"With {word_count} words, you are close to the word limit of {word_limit.value}.")
-    else:
-        solara.Success("Great short writing!")
-
-
-# The following line is required only when running the code in a Jupyter notebook:
-Page()
-```
-
-Yes, the above example is running live on the Solara documentation web server. If you change the slider the output updates.
-
-## Run the script using Solara server
-
-Run from the command line in the same directory where you put your file (`sol.py`):
-
-```bash
-$ solara run sol.py
-Solara server is starting at http://localhost:8765
-```
-
-If you open the URL in your browser ([http://localhost:8765](http://localhost:8765)), you should see the same graph in your browser, now running on your computer.
-
-## Reuse your code in the Jupyter notebook.
-
-From Jupyter Notebook (classic) or Jupyter Lab, navigate to the same directory as `sol.py`. Enter the following code in a notebook cell:
-
-```python
-from sol import Page
-display(Page())
-```
-
-You should see the following output:
-
-<img src="https://dxhl76zpt6fap.cloudfront.net/public/quickstart-notebook.webp" alt="Markdown Monster icon" style="border: 1px solid #ccc;" />
-
-In case you forgot how to start a notebook server:
-
-    $ jupyter notebook
-
-Or the more modern Jupyter lab:
-
-    $ jupyter lab