How to Share Panel Scripts with uv#

Transform your Panel applications into portable, shareable scripts that anyone can run with a single command using uv.

This approach eliminates dependency management headaches and makes your Panel apps accessible to colleagues, collaborators, and the broader community.

What You’ll Accomplish#

By the end of this guide, you’ll have:

Created a self-contained Panel script with embedded dependencies
Configured the script for both local development and sharing
Published your script for others to run directly from GitHub

Prerequisites#

uv installed: Install from astral.sh/uv
Basic Panel knowledge: Familiarity with creating Panel applications
Git/GitHub account: For sharing your scripts publicly

Step 1: Create a Self-Contained Panel Script#

Create a new file called script.py with a complete Panel application:

import panel as pn

# Configure Panel with a modern design
pn.extension(design="material")

# Create interactive components
slider = pn.widgets.IntSlider(
    value=5,
    start=1,
    end=10,
    name="Rating"
)

def generate_stars(rating=5):
    """Convert numeric rating to star display."""
    return "⭐" * rating

# Build the application layout
app = pn.Column(
    "## ⭐ Star Rating Demo",
    "Adjust the slider to see your rating in stars:",
    slider,
    pn.bind(generate_stars, slider.param.value),
    sizing_mode="stretch_width",
    margin=(20, 40)
)

# Enable dual-mode execution
if pn.state.served:
    # Served mode: `panel serve script.py`
    app.servable(title="Star Rating App")
elif __name__ == "__main__":
    # Script mode: `python script.py`
    app.show(port=5007)

Why this structure works:

The dual-mode execution allows flexible running with either python script.py or panel serve script.py
Clear component organization makes the code maintainable
Descriptive names and comments aid understanding

Step 2: Add Dependency Metadata#

Configure your script’s Python version and dependencies using uv’s inline metadata feature:

uv add --script script.py --python ">=3.9" panel

This command automatically adds a metadata block to your script:

# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "panel",
# ]
# ///

Pro tip: Add additional dependencies as needed:

uv add --script script.py pandas matplotlib numpy

Step 3: Test Locally#

Verify your script works in an isolated environment:

# Run as a standalone application
uv run script.py

# Or serve with Panel's development server
uv run panel serve script.py --dev --show

The --dev flag enables auto-reload during development, and --show automatically opens your browser.

Step 4: Publish to GitHub#

Make your script accessible to others by publishing it:

Create a repository or use an existing one

Commit your script:

git add script.py
git commit -m "Add shareable Panel star rating app"
git push origin main

Get the raw file URL from GitHub (click “Raw” button on the file page)