{"id":13952118,"url":"https://github.com/Appsilon/tapyr-template","last_synced_at":"2025-07-20T15:31:30.810Z","repository":{"id":237241603,"uuid":"770412542","full_name":"Appsilon/tapyr-template","owner":"Appsilon","description":"Tapyr template for Shiny for Python applications","archived":false,"fork":false,"pushed_at":"2024-10-29T12:28:24.000Z","size":564,"stargazers_count":41,"open_issues_count":1,"forks_count":1,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-10-29T14:52:30.913Z","etag":null,"topics":["python","shiny"],"latest_commit_sha":null,"homepage":"https://connect.appsilon.com/tapyr-docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Appsilon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-11T14:05:33.000Z","updated_at":"2024-10-29T12:28:25.000Z","dependencies_parsed_at":"2024-05-20T03:43:37.159Z","dependency_job_id":"b2c73f16-7e33-407c-bb16-97e993d5fab4","html_url":"https://github.com/Appsilon/tapyr-template","commit_stats":null,"previous_names":["appsilon/tapyr-template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Appsilon%2Ftapyr-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Appsilon%2Ftapyr-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Appsilon%2Ftapyr-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Appsilon%2Ftapyr-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Appsilon","download_url":"https://codeload.github.com/Appsilon/tapyr-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226809055,"owners_count":17685498,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","shiny"],"created_at":"2024-08-08T07:00:53.327Z","updated_at":"2024-11-27T19:30:46.166Z","avatar_url":"https://github.com/Appsilon.png","language":"Python","funding_links":[],"categories":["Shiny for Python"],"sub_categories":["Python - Frameworks"],"readme":"# Tapyr - Shiny for Python Application Template\u003ca href=\"https://appsilon.github.io/tapyr-template/\"\u003e\u003cimg src=\"www/images/tapyr.png\" align=\"right\" alt=\"Tapyr logo\" style=\"height: 140px;\"\u003e\u003c/a\u003e\n\n\u003e Create and deploy enterprise-ready Shiny for Python dashboards with ease.\n\n## Introduction\n\nTapyr 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.\nIdeal for projects aiming for high-quality code and efficient deployment on Posit Connect.\n\n\u003e [!IMPORTANT]\n\u003e When we created `tapyr`, it used `poetry` for dependency management.\n\u003e 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).\n\n## Events\n### Upcoming\nWould you like to learn about Tapyr? Join our events!\n* [**Open Source Spotlight: Tapyr - Shiny for Python Framework**](https://go.appsilon.com/tapyr-webinar-may2024?utm_source=community\u0026utm_medium=github\u0026utm_campaign=shinygathering)\u003cbr\u003e\n2024-05-28 at 18:00 (UTC+1)\u003cbr\u003e\nShiny Gathering led by [Piotr Pasza Storożenko](https://www.linkedin.com/in/piotr-pasza-storo%C5%BCenko/)\n\n## Docs\n\nFor comprehensive documentation, please visit our [documentation](https://appsilon.github.io/tapyr-docs/).\n\n## Getting Started\n\nCheck out our get started with `tapyr` [blog post](https://www.appsilon.com/post/introducing-tapyr).\n\n### Using Devcontainer\n\nTo 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.\nIf you prefer a local setup, follow the instructions below.\n\n1. **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.\n2. **Activate the virtual environment**:\n   ```sh\n   source .venv/bin/activate\n   ```\n3. **Run the application**:\n   ```sh\n   shiny run app.py --reload\n   ```\n4. **Execute tests**:\n   ```sh\n   pytest\n   ```\n\n*Note*: The Devcontainer might limit some `playwright` features, such as `codegen`. For full functionality, consider a local setup.\n\n### Setting Up Locally with `uv`\n\nFor developers preferring a local setup without Devcontainer:\n\n1. **Install `uv`**: [Follow the installation guide](https://docs.astral.sh/uv/getting-started/installation/).\n2. **Clone the repository** and navigate to it.\n3. **Install dependencies**:\n   ```sh\n   uv sync\n   uv run playwright install --with-deps\n   ```\n4. **Run the application**:\n   ```sh\n   uv run shiny run app.py --reload\n   ```\n\n*Attention*: Follow any additional steps prompted by `playwright install`.\n\nMore information on `uv` can be found in the [official documentation](https://docs.astral.sh/uv/).\n\n### Setting Up Locally with `pip`\n\nAlthough not recommended, you can set up the project using `pip`:\n\n1. **Clone the repository** and navigate to it.\n2. **Create a virtual environment**:\n   ```sh\n   python -m venv .venv\n   source .venv/bin/activate\n   ```\n3. **Install package with dependencies**:\n   ```sh\n   pip install -e .\"[dev]\"\n   playwright install --with-deps\n   ```\n4. **Run the application**:\n   ```sh\n   shiny run app.py --reload\n   ```\n\n### Deployment on Posit Connect\n\nDeploy your application to Posit Connect by:\n0. **Activate the virtual environment**:\n   ```sh\n   source .venv/bin/activate\n   ```\n1. **Exporting your API Key**:\n   ```sh\n   export CONNECT_API_KEY=\"your_api_key_here\"\n   ```\n2. **Configuring Posit Connect**:\n   ```sh\n   rsconnect add \\\n   --api-key $CONNECT_API_KEY \\\n   --server \u003cMY_CONNECT_URL\u003e \\\n   --name \u003cSERVER_NAME\u003e\n   ```\n3. **Deploying**:\n   ```sh\n   rsconnect deploy shiny -t \"Tapyr App\" .\n   ```\n\nReplace placeholders with your server URL, server name, and API key. Verify the deployment on Posit Connect for successful upload.\n\n## :star2: Stay Updated\nDon't miss out on important updates and exclusive content about Tapyr and Shiny for Python → [Subscribe to our newsletter](https://go.appsilon.com/shiny-weekly?utm_source=community\u0026utm_medium=github\u0026utm_content=tapyr).\n\nHave questions or want to contribute? Engage with Appsilon's developers and the data science community on our [Shiny 4 All](https://go.appsilon.com/shiny4allcommunity).\n\n\n---\n\nDeveloped with :heart: at [Appsilon](https://appsilon.com).\nGet in touch: \u003copensource@appsilon.com\u003e.\n\nWant to stay up to date with Tapyr and other packages? Join 4,2k explorers and get the [📧 Shiny Weekly Newsletter](https://go.appsilon.com/shiny-weekly?utm_source=community\u0026utm_medium=github\u0026utm_content=tapyr) into your mailbox and check our [Slack community](https://go.appsilon.com/shiny4allcommunity).\n\nExplore the [Rhinoverse](https://rhinoverse.dev) - a family of R packages built around [Rhino](https://appsilon.github.io/rhino/)!\n\nAppsilon is a\n[**Posit (formerly RStudio) Full Service Certified Partner**](https://www.rstudio.com/certified-partners/).\n\n\u003ca href=\"https://appsilon.com/careers/\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/Appsilon/website-cdn/gh-pages/WeAreHiring1.png\" alt=\"We are hiring!\"\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAppsilon%2Ftapyr-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAppsilon%2Ftapyr-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAppsilon%2Ftapyr-template/lists"}