tapyr-template

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 45 Open GitHub ↗

Tapyr template for Shiny for Python applications

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Tapyr - Shiny for Python Application Template<a href="https://appsilon.github.io/tapyr-template/"><img src="www/images/tapyr.png" align="right" alt="Tapyr logo" style="height: 140px;"></a>

> Create and deploy enterprise-ready Shiny for Python dashboards with ease.

## Introduction

Tapyr is designed for data scientists and developers seeking a seamless transition from development to deployment, this template uses `uv` for dependency management and `pytest`/`playwright` for comprehensive app validation/testing/quality assurance.
Ideal for projects aiming for high-quality code and efficient deployment on Posit Connect.

> [!IMPORTANT]
> When we created `tapyr`, it used `poetry` for dependency management.
> Please check our docs for [a quick `poetry` and `uv` comparison](https://appsilon.github.io/tapyr-docs/contents/tapyr_features/02_uv.html#direct-uv-and-poetry-comparison).

## Docs

For comprehensive documentation, please visit our [documentation](https://appsilon.github.io/tapyr-docs/).

## Getting Started

Check out our get started with `tapyr` [blog post](https://www.appsilon.com/post/introducing-tapyr).

### Using Devcontainer

To ensure a consistent development experience across all environments, we recommend using the [devcontainer](https://code.visualstudio.com/docs/remote/containers) configuration with Visual Studio Code or DevPod for container-based development.
If you prefer a local setup, follow the instructions below.

1. **Start the Devcontainer**: Open the project in VS Code and select "Reopen in Container" when prompted, or use the Command Palette (`Ctrl+Shift+P`) and choose "Dev Containers: Reopen in Container". Alternatively, use [DevPod](https://devpod.sh/) following their instructions.
2. **Activate the virtual environment**:
   ```sh
   source .venv/bin/activate
   ```
3. **Run the application**:
   ```sh
   shiny run app.py --reload
   ```
4. **Execute tests**:
   ```sh
   pytest
   ```

*Note*: The Devcontainer might limit some `playwright` features, such as `codegen`. For full functionality, consider a local setup.

### Setting Up Locally with `uv`

For developers preferring a local setup without Devcontainer:

1. **Install `uv`**: [Follow the installation guide](https://docs.astral.sh/uv/getting-started/installation/).
2. **Clone the repository** and navigate to it.
3. **Install dependencies**:
   ```sh
   uv sync
   uv run playwright install --with-deps
   ```
4. **Run the application**:
   ```sh
   uv run shiny run app.py --reload
   ```

*Attention*: Follow any additional steps prompted by `playwright install`.

More information on `uv` can be found in the [official documentation](https://docs.astral.sh/uv/).

### Setting Up Locally with `pip`

Although not recommended, you can set up the project using `pip`:

1. **Clone the repository** and navigate to it.
2. **Create a virtual environment**:
   ```sh
   python -m venv .venv
   source .venv/bin/activate
   ```
3. **Install package with dependencies**:
   ```sh
   pip install -e ."[dev]"
   playwright install --with-deps
   ```
4. **Run the application**:
   ```sh
   shiny run app.py --reload
   ```

### Deployment on Posit Connect

Deploy your application to Posit Connect by:
0. **Activate the virtual environment**:
   ```sh
   source .venv/bin/activate
   ```
1. **Exporting your API Key**:
   ```sh
   export CONNECT_API_KEY="your_api_key_here"
   ```
2. **Configuring Posit Connect**:
   ```sh
   rsconnect add \
   --api-key $CONNECT_API_KEY \
   --server <MY_CONNECT_URL> \
   --name <SERVER_NAME>
   ```
3. **Deploying**:
   ```sh
   rsconnect deploy shiny -t "Tapyr App" .
   ```

Replace placeholders with your server URL, server name, and API key. Verify the deployment on Posit Connect for successful upload.

---

Developed with :heart: at [Appsilon](https://appsilon.com).
Get in touch: <opensource@appsilon.com>.

Explore the [Rhinoverse](https://rhinoverse.dev) - a family of R packages built around [Rhino](https://appsilon.github.io/rhino/)!

Appsilon is a
[**Posit (formerly RStudio) Full Service Certified Partner**](https://www.rstudio.com/certified-partners/).

tapyr-template

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README