-
-
Notifications
You must be signed in to change notification settings - Fork 531
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2d57353
commit 2f8ceee
Showing
7 changed files
with
364 additions
and
268 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| # Serve Panel Apps | ||
|
|
||
| In this section you will learn the basics of serving Panel apps: | ||
|
|
||
| - serve your app with a command like `panel serve app.py` or `panel serve app2.ipynb`. | ||
| - serve with *auto reload* by adding the flag `--autoreload`. | ||
| - stop your server with `CTRL+C`. | ||
|
|
||
| ## Serve an app from a `.py` file | ||
|
|
||
| The simplest Panel `.py` file could look like this: | ||
|
|
||
| ```python | ||
| import panel as pn | ||
|
|
||
| pn.extension() | ||
|
|
||
| pn.panel("Hello World").servable() | ||
| ``` | ||
|
|
||
| Copy the code above into a file named `app.py`. | ||
|
|
||
| Save the file. | ||
|
|
||
| :::{admonition} Note | ||
| The lines in the app.py file refer to | ||
|
|
||
| - `panel`: The Panel python package. Its a convention to import it as `pn`. | ||
| - `pn.extension()`: Loads javascript dependencies and configures Panel. | ||
| - `pn.panel(...)`: Creates a *displayable* Panel component. | ||
| - `.servable()`: Displays the component in a *server app*. | ||
| ::: | ||
|
|
||
| Run the live server with | ||
|
|
||
| ```python | ||
| panel serve app.py --autoreload | ||
| ``` | ||
|
|
||
| It will look like | ||
|
|
||
| ```bash | ||
| $ panel serve app.py --autoreload | ||
| 2024-01-17 15:49:11,443 Starting Bokeh server version 3.3.2 (running on Tornado 6.3.3) | ||
| 2024-01-17 15:49:11,444 User authentication hooks NOT provided (default user enabled) | ||
| 2024-01-17 15:49:11,450 Bokeh app running at: http://localhost:5006/app | ||
| 2024-01-17 15:49:11,450 Starting Bokeh server with process id: 47256 | ||
| ``` | ||
|
|
||
| :::{admonition} Note | ||
| The command `panel serve app.py --autoreload` refers to: | ||
|
|
||
| - `panel`: the panel executable. | ||
| - `serve`: the command you want panel to run | ||
| - `app.py`: the file `app.py` you want to serve | ||
| - `--autoreload`: make the server restart after code changes. Use this for development only. | ||
| ::: | ||
|
|
||
| In the output, there's a line with something like: | ||
|
|
||
| ```bash | ||
| Bokeh app running at: http://localhost:5006/app | ||
| ``` | ||
|
|
||
| That line shows the URL where your app is being served, in your local machine. | ||
|
|
||
| You will also notice that `Bokeh server` is mentioned. Its because the Panel server is an extension of the Bokeh server. | ||
|
|
||
| Open your browser at [http://localhost:5006/app](http://localhost:5006/app). | ||
|
|
||
| The application will look like. | ||
|
|
||
| . | ||
|
|
||
| Now stop the server by pressing `CTRL+C` one or more times in the terminal. | ||
|
|
||
| ## Serve an app from a notebook file | ||
|
|
||
| The simplest Panel notebook file could look like: | ||
|
|
||
| . | ||
|
|
||
| Copy the 2 code cells below into a clean notebook named `app2.ipynb`. | ||
|
|
||
| ```python | ||
| import panel as pn | ||
|
|
||
| pn.extension() | ||
| ``` | ||
|
|
||
| ```python | ||
| pn.panel("Hello Notebook World").servable() | ||
| ``` | ||
|
|
||
| :::{admonition} Note | ||
| The lines in the `app2.ipynb` file refer to | ||
|
|
||
| - `panel`: The Panel python package. Its a convention to import it as `pn`. | ||
| - `pn.extension()`: **Loads the [`pyviz_comms`](https://github.com/holoviz/pyviz_comms) notebook extension**, loads javascript dependencies and configures Panel. | ||
| - `pn.panel(...)`: Creates a *displayable* Panel component. **The component can be displayed directly in the notebook**. | ||
| - `.servable()`: Displays the component in a *server app*. | ||
| ::: | ||
|
|
||
| Run the cells in the notebook and save it if you have not already done it. | ||
|
|
||
| Run the Panel server with | ||
|
|
||
| ```bash | ||
| panel serve app2.ipynb --autoreload | ||
| ``` | ||
|
|
||
| It will look like | ||
|
|
||
| ```bash | ||
| $ panel serve app2.ipynb --autoreload | ||
| 2024-01-17 21:05:32,338 Starting Bokeh server version 3.3.3 (running on Tornado 6.4) | ||
| 2024-01-17 21:05:32,339 User authentication hooks NOT provided (default user enabled) | ||
| 2024-01-17 21:05:32,342 Bokeh app running at: http://localhost:5006/app2 | ||
| 2024-01-17 21:05:32,342 Starting Bokeh server with process id: 42008 | ||
| ``` | ||
|
|
||
| :::{admonition} Note | ||
| The command `panel serve app2.ipynb --autoreload` refers to: | ||
|
|
||
| - `panel`: the panel executable. | ||
| - `serve`: the command you want panel to run | ||
| - `app.py`: the file `app2.ipynb` you want to serve | ||
| - `--autoreload`: make the server restart after code changes. Use this for development only. | ||
| ::: | ||
|
|
||
| In the output, there's a line with something like: | ||
|
|
||
| ```bash | ||
| Bokeh app running at: http://localhost:5006/app2 | ||
| ``` | ||
|
|
||
| That line shows the URL where your app is being served, in your local machine. | ||
|
|
||
| Open your browser at [http://localhost:5006/app2](http://localhost:5006/app2). | ||
|
|
||
| The application will look like. | ||
|
|
||
| . | ||
|
|
||
| Now stop the server by pressing `CTRL+C` one or more times in the terminal. | ||
|
|
||
| ## Recap | ||
|
|
||
| You can | ||
|
|
||
| - serve your app with a command like `panel serve app.py` or `panel serve app2.ipynb`. | ||
| - serve with *auto reload* by adding the flag `--autoreload`. | ||
| - stop your server with `CTRL+C`. | ||
|
|
||
| ## Resources | ||
|
|
||
| ### Tutorials | ||
|
|
||
| - [Serve Panel Apps (Intermediate)](../intermediate/panel_serve.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.