Skip to main content

A web development framework for Python.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shiny-1.4.0.tar.gz (4.8 MB view details)

Uploaded Source

Built Distribution

shiny-1.4.0-py3-none-any.whl (3.9 MB view details)

Uploaded Python 3

File details

Details for the file shiny-1.4.0.tar.gz.

File metadata

  • Download URL: shiny-1.4.0.tar.gz
  • Upload date:
  • Size: 4.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for shiny-1.4.0.tar.gz
Algorithm Hash digest
SHA256 05c709c2a074b9e9f5a82065460815ff40bc686286bacfcab5195a69f3ae759b
MD5 95de70162826d9896f7f41c04d3c5095
BLAKE2b-256 6bdc1f1da052f0af709ee73dc07ef12f4c5395eff861e430143ae115fabdc3bb

See more details on using hashes here.

File details

Details for the file shiny-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: shiny-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for shiny-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c7748d0cd32696477613b9c00664320ea1604b9d9770a2ec2e8ea7ea5e0b44b4
MD5 ae06a40a44331a046b4a0b7c57ccd738
BLAKE2b-256 f5e8ae54ce930d965211c77b28a8c3792f78a80ad1bd012bbb05000176dd246c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page