Skip to content

posit-dev/py-shiny

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7db7135 · Mar 20, 2025
Mar 13, 2025
May 29, 2024
Mar 13, 2025
Dec 31, 2024
Mar 12, 2025
Mar 5, 2025
Mar 20, 2025
Mar 20, 2025
Mar 13, 2025
Feb 14, 2024
Mar 21, 2024
Mar 20, 2025
Aug 29, 2023
May 11, 2023
Dec 19, 2023
Mar 13, 2025
Feb 27, 2025
Feb 27, 2025
Mar 13, 2025
Aug 28, 2024
Feb 24, 2025

Repository files navigation

Shiny for Python

PyPI Latest Release Build status Conda Latest Release Supported Python versions License

Shiny for Python is the best way to build fast, beautiful web applications in Python. You can build quickly with Shiny and create simple interactive visualizations and prototype applications in an afternoon. But unlike other frameworks targeted at data scientists, Shiny does not limit your app's growth. Shiny remains extensible enough to power large, mission-critical applications.

To learn more about Shiny see the Shiny for Python website. If you're new to the framework we recommend these resources:

Join the conversation

If you have questions about Shiny for Python, or want to help us decide what to work on next, join us on Discord.

Getting started

To get started with shiny follow the installation instructions or just install it from pip.

pip install shiny

To install the latest development version:

# First install htmltools, then shiny
pip install git+https://github.com/posit-dev/py-htmltools.git#egg=htmltools
pip install git+https://github.com/posit-dev/py-shiny.git#egg=shiny

You can create and run your first application with shiny create, the CLI will ask you which template you would like to use. You can either run the app with the Shiny extension, or call shiny run app.py --reload --launch-browser.

Development

If you are working from a fork you may not have the git tags from the original repo. Git tags are required for the install to succeed. To add tags to your own fork:

git remote add upstream https://github.com/posit-dev/py-shiny.git
git fetch --tags upstream

Then install:

pip install -e ".[dev,test,doc]"

Additionally, you can install pre-commit hooks which will automatically reformat and lint the code when you make a commit:

pre-commit install

# To disable:
# pre-commit uninstall

Tests should now pass:

make check
# To apply formatting fixes instead of erroring:
# make check-fix

Or get a full list of helpers with just:

make

Typically, when developing new features for Shiny, you'll want to try them out in an application. In a separate application directory, use can use -e to reference your local checkout of py-shiny:

# Rather than
#   pip install shiny
# run:
pip install -e ../py-shiny --config-settings editable_mode=compat

See the docs README for instructions on building the documentation locally.