py-shiny copilot-instructions.md

Repository guidance for GitHub Copilot, an AI coding assistant, when working on Shiny for Python, a Python framework for building interactive web applications.

In plain words
What is it for?
Use it when generating or changing Shiny for Python code and when navigating the repository's APIs and folders.
Why use it?
It gives Copilot the project structure, design principles, and documentation links needed to make suggestions that fit the codebase.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/posit-dev/py-shiny/copilot-instructions
Clone the repo
git clone --depth 1 https://github.com/posit-dev/py-shiny

Made for: GitHub Copilot.

Per session 5,124 This file is loaded in full into every session.
When invoked 5,124 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.05124 $0.05124
Opus 5 $0.02562 $0.02562
Sonnet 5 $0.01025 $0.01025
Haiku 4.5 $0.00512 $0.00512

Measured 2d ago against content hash 97aac7b7c444, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

py-shiny copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 764 lines

How it starts

The opening of the file, as written. The whole thing — 764 lines — stays where its author put it; the contents beside it link to each section on GitHub.

GitHub Copilot Instructions for py-shiny

This document provides GitHub Copilot with comprehensive context about the Shiny for Python repository to help generate high-quality, context-aware code and suggestions.

1. Project Overview

Shiny for Python is a framework for building fast, beautiful web applications in Python. It enables data scientists and developers to create interactive visualizations and applications quickly while remaining extensible enough to power large, mission-critical applications.

Key Principles

  • Reactive Programming: Automatic dependency tracking and efficient updates
  • Extensibility: Build simple prototypes or complex production applications
  • Performance: Optimized for speed and efficiency
  • Developer Experience: Intuitive APIs with both Express (simple) and Core (powerful) modes

Documentation

2. Repository Structure

py-shiny/
├── shiny/                  # Core library code
│   ├── express/           # Express API (decorator-based, simpler syntax)
│   ├── ui/                # UI components and page layouts
│   ├── render/            # Rendering functions (@render.plot, @render.table, etc.)
│   ├── reactive/          # Reactive programming primitives (@reactive.calc, @reactive.effect)
│   ├── session/           # Session management
│   ├── experimental/      # Experimental features
│   ├── api-examples/      # API documentation examples
│   └── templates/         # Project templates
├── tests/                 # Test suite
│   ├── pytest/           # Unit tests
│   └── playwright/       # End-to-end integration tests
├── examples/              # Example applications
├── docs/                  # Documentation source (Quartodoc + Quarto)
├── js/                    # JavaScript/TypeScript code
└── scripts/               # Development and build scripts

Read the full file on GitHub · 764 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 764 lines · 5,124 tokens per session scan A 97aac7b7c444

Subscribe to this mod's changes

py-shiny copilot-instructions.md is an instructions file published in the GitHub repository posit-dev/py-shiny (1,750 stars, last pushed today), licensed MIT. It adds 5,124 tokens to every session, about $0.0256 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens