text stringlengths 4 160k | id stringlengths 18 123 | metadata dict |
|---|---|---|
#!/usr/bin/env python3
# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0... | streamlit/.claude/hooks/pre_bash_redirect.py/0 | {
"file_path": "streamlit/.claude/hooks/pre_bash_redirect.py",
"repo_id": "streamlit",
"token_count": 1195
} |
{
"hooks": {
"PreToolUse": [
{
"matcher": "Bash",
"hooks": [
{
"type": "command",
"command": "$CLAUDE_PROJECT_DIR/.claude/hooks/pre_bash_redirect.py",
"timeout": 10
}
]
}
]
}
}
| streamlit/.claude/settings.json/0 | {
"file_path": "streamlit/.claude/settings.json",
"repo_id": "streamlit",
"token_count": 178
} |
# Python Docstrings - Fix
## Overview
Add or correct Numpydoc-style docstrings for public modules, classes, functions, and methods without changing code behavior.
Refer to the Docstrings guidance in `.cursor/rules/python.mdc`.
## Success Criteria
- All public APIs have clear, accurate Numpydoc docstrings.
- Module... | streamlit/.cursor/commands/py-docstring-fix.md/0 | {
"file_path": "streamlit/.cursor/commands/py-docstring-fix.md",
"repo_id": "streamlit",
"token_count": 883
} |
# Parameterize Tests
## Overview
Convert repetitive `pytest` tests into parameterized tests using `pytest.mark.parametrize` to reduce duplication and improve maintainability, without changing behavior or reducing test coverage.
## Success Criteria
- Coverage is maintained or increased.
- All tests pass via `pytest`... | streamlit/.cursor/commands/py-parameterize-test.md/0 | {
"file_path": "streamlit/.cursor/commands/py-parameterize-test.md",
"repo_id": "streamlit",
"token_count": 493
} |
---
description:
globs: e2e_playwright/**/*.py
alwaysApply: false
---
# Streamlit E2E Tests
We use playwright with pytest to e2e test Streamlit library. E2E tests verify the complete Streamlit system (frontend, backend, communication, state, visual appearance) from a user's perspective (black-box). They complement Py... | streamlit/.cursor/rules/e2e_playwright.mdc/0 | {
"file_path": "streamlit/.cursor/rules/e2e_playwright.mdc",
"repo_id": "streamlit",
"token_count": 1471
} |
---
description: List of all available make commands
globs:
alwaysApply: false
---
# Available `make` commands
List of all `make` commands that are available for execution from the repository root folder:
help Show all available make commands.
all Install all dependencies, ... | streamlit/.cursor/rules/make_commands.mdc/0 | {
"file_path": "streamlit/.cursor/rules/make_commands.mdc",
"repo_id": "streamlit",
"token_count": 1161
} |
---
description: Implementation guide for new features
globs:
alwaysApply: false
---
# New Feature - Implementation Guide
- Most features need to be implemented in the backend in `lib/streamlit/`, the frontend `frontend/` and will need changes to our protobuf definitions in `proto/`.
- New features should be covered ... | streamlit/.cursor/rules/new_feature.mdc/0 | {
"file_path": "streamlit/.cursor/rules/new_feature.mdc",
"repo_id": "streamlit",
"token_count": 534
} |
---
description:
globs:
alwaysApply: true
---
# Streamlit Repo Overview
Streamlit is an open-source (Apache 2.0) Python library for creating interactive web applications and dashboards with focus on data apps and internal tools.
## Tech Stack
- **Backend (Server):** Python, Tornado server, pytest
- **Frontend (Web ... | streamlit/.cursor/rules/overview.mdc/0 | {
"file_path": "streamlit/.cursor/rules/overview.mdc",
"repo_id": "streamlit",
"token_count": 1097
} |
---
description:
globs: **/*.proto
alwaysApply: false
---
# Protobuf
Protobuf messages are used for communication between the Streamlit backend and frontend via WebSocket connections.
**Note**: Messages are "released" once shipped in any Streamlit version.
## Protobuf Compatibility
Always keep protobuf messages ba... | streamlit/.cursor/rules/protobuf.mdc/0 | {
"file_path": "streamlit/.cursor/rules/protobuf.mdc",
"repo_id": "streamlit",
"token_count": 461
} |
---
description:
globs: **/*.py
alwaysApply: false
---
# Python Development Guide
- Supported Python versions: 3.10 - 3.14
- Docstrings: Numpy style
- Linter: Ruff 0.x (`.ruff.toml`)
- Formatter: Ruff 0.x (`.ruff.toml`)
- Type Checker: mypy 1.x (`mypy.ini`)
- Testing: pytest 8.x (`lib/pytest.ini`)
## Key Principles
... | streamlit/.cursor/rules/python.mdc/0 | {
"file_path": "streamlit/.cursor/rules/python.mdc",
"repo_id": "streamlit",
"token_count": 885
} |
---
description:
globs: lib/streamlit/**/*.py
alwaysApply: false
---
# Streamlit Lib Python Guide
Tips and guidelines specific to the development of the Streamlit Python library,
not applicable to scripts and e2e tests.
## Logging
If something needs to be logged, please use our logger - that returns a default
Pytho... | streamlit/.cursor/rules/python_lib.mdc/0 | {
"file_path": "streamlit/.cursor/rules/python_lib.mdc",
"repo_id": "streamlit",
"token_count": 314
} |
---
description:
globs: lib/tests/**/*.py
alwaysApply: false
---
# Python Unit Test Guide
We use the unit tests to cover internal behavior that can work without the web / backend counterpart.
We aim for high unit test coverage (90% or higher) of our Python code in `lib/streamlit`.
## Key Principles
- Prefer pytest ... | streamlit/.cursor/rules/python_tests.mdc/0 | {
"file_path": "streamlit/.cursor/rules/python_tests.mdc",
"repo_id": "streamlit",
"token_count": 313
} |
---
description:
globs: **/*.ts, **/*.tsx
alwaysApply: false
---
# TypeScript Development Guide
- TypeScript: v5
- Linter: eslint v9
- Formatter: prettier v3
- Framework: React v18
- Styling: @emotion/styled v11
- Build tool: vite v7
- Testing: vitest v3 & react testing library v16
- Package manager: yarn v4 with wor... | streamlit/.cursor/rules/typescript.mdc/0 | {
"file_path": "streamlit/.cursor/rules/typescript.mdc",
"repo_id": "streamlit",
"token_count": 3579
} |
{
"setup-worktree": [
"cd \"$(git rev-parse --show-toplevel)\"; [ -d .venv ] || uv venv; VIRTUAL_ENV=.venv PATH=\".venv/bin:.venv/Scripts:$PATH\" make all-dev frontend"
]
}
| streamlit/.cursor/worktrees.json/0 | {
"file_path": "streamlit/.cursor/worktrees.json",
"repo_id": "streamlit",
"token_count": 87
} |
# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by... | streamlit/.devcontainer/Dockerfile/0 | {
"file_path": "streamlit/.devcontainer/Dockerfile",
"repo_id": "streamlit",
"token_count": 374
} |
{
"name": "streamlit-dev",
"build": {
"dockerfile": "Dockerfile"
},
"forwardPorts": [3000],
"portsAttributes": {
"3000": {
"label": "Dev Server",
"onAutoForward": "notify"
}
},
"customizations": {
"vscode": {
"extensions": [
"dbaeumer.vscode-eslint",
"esbe... | streamlit/.devcontainer/devcontainer.json/0 | {
"file_path": "streamlit/.devcontainer/devcontainer.json",
"repo_id": "streamlit",
"token_count": 2229
} |
# https://editorconfig.org/
root = true
[*]
indent_style = space
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true
end_of_line = lf
charset = utf-8
max_line_length = 79
[*.py]
indent_size = 4
max_line_length = 88
# The JSON files contain newlines inconsistently
[*.json]
insert_final_newlin... | streamlit/.editorconfig/0 | {
"file_path": "streamlit/.editorconfig",
"repo_id": "streamlit",
"token_count": 188
} |
v24
| streamlit/.nvmrc/0 | {
"file_path": "streamlit/.nvmrc",
"repo_id": "streamlit",
"token_count": 3
} |
# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by... | streamlit/.pre-commit-config.yaml/0 | {
"file_path": "streamlit/.pre-commit-config.yaml",
"repo_id": "streamlit",
"token_count": 4405
} |
# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by... | streamlit/.ruff.toml/0 | {
"file_path": "streamlit/.ruff.toml",
"repo_id": "streamlit",
"token_count": 1969
} |
{
"recommendations": [
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"ms-python.mypy-type-checker",
"ms-python.python",
"ms-python.debugpy",
"ms-python.vscode-pylance",
"charliermarsh.ruff",
"EditorConfig.EditorConfig",
"vitest.explorer",
"tamasfe.even-better-toml",
"... | streamlit/.vscode/extensions.json/0 | {
"file_path": "streamlit/.vscode/extensions.json",
"repo_id": "streamlit",
"token_count": 172
} |
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Debug Streamlit App",
"type": "debugpy",
"requ... | streamlit/.vscode/launch.json/0 | {
"file_path": "streamlit/.vscode/launch.json",
"repo_id": "streamlit",
"token_count": 254
} |
@./AGENTS.md
| streamlit/CLAUDE.md/0 | {
"file_path": "streamlit/CLAUDE.md",
"repo_id": "streamlit",
"token_count": 7
} |
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex ch... | streamlit/CODE_OF_CONDUCT.md/0 | {
"file_path": "streamlit/CODE_OF_CONDUCT.md",
"repo_id": "streamlit",
"token_count": 694
} |
Thanks for your interest in helping improve Streamlit! 🎉
**If you are looking for Streamlit's documentation, go here instead: <https://docs.streamlit.io>**
This wiki is for people who want to contribute code to Streamlit. There are also other ways to contribute, such as [reporting bugs](https://github.com/streamlit/... | streamlit/CONTRIBUTING.md/0 | {
"file_path": "streamlit/CONTRIBUTING.md",
"repo_id": "streamlit",
"token_count": 4042
} |
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
... | streamlit/LICENSE/0 | {
"file_path": "streamlit/LICENSE",
"repo_id": "streamlit",
"token_count": 3168
} |
# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by... | streamlit/Makefile/0 | {
"file_path": "streamlit/Makefile",
"repo_id": "streamlit",
"token_count": 5754
} |
<br>
<img src="https://user-images.githubusercontent.com/7164864/217935870-c0bc60a3-6fc0-4047-b011-7b4c59488c91.png" alt="Streamlit logo" style="margin-top:50px"></img>
# Welcome to Streamlit 👋
**A faster way to build and share data apps.**
## What is Streamlit?
Streamlit lets you transform Python scripts into in... | streamlit/README.md/0 | {
"file_path": "streamlit/README.md",
"repo_id": "streamlit",
"token_count": 2248
} |
# Security Policy
## Supported Versions
| Version | Supported |
| --------- | --------- |
| >= 1.11.1 | ✅ |
</br>
Please refer to the Snowflake [HackerOne program](https://hackerone.com/snowflake?type=team) for our security policies and for reporting any security vulnerabilities.
| streamlit/SECURITY.md/0 | {
"file_path": "streamlit/SECURITY.md",
"repo_id": "streamlit",
"token_count": 90
} |
---
last_updated: 2025-11-05
---
# Agent Knowledge Base Index
Central registry of resources available to AI agents working on Streamlit.
## Available Resources
### [Processes](processes/)
Development workflows and procedures:
- [pr-creation/](processes/pr-creation/) - Complete PR creation workflow with guidance o... | streamlit/agent-knowledge/INDEX.md/0 | {
"file_path": "streamlit/agent-knowledge/INDEX.md",
"repo_id": "streamlit",
"token_count": 250
} |
# Agent Knowledge Base
This directory contains documentation and guides designed for AI agents working on the Streamlit codebase.
## Purpose
Tool-agnostic knowledge base for AI-assisted development. Works with any AI tool (Cursor, Cline, Aider, etc.) and any task type (commands, pipelines, ad-hoc prompts).
## Quick... | streamlit/agent-knowledge/README.md/0 | {
"file_path": "streamlit/agent-knowledge/README.md",
"repo_id": "streamlit",
"token_count": 703
} |
---
status: stable
last_updated: 2025-11-19
---
# PR Creation Process
Reference materials for creating pull requests in the Streamlit repository.
## The PR Template
**Location**: `.github/pull_request_template.md` (canonical source)
## Available Guides
- [writing-principles.md](./writing-principles.md) - General ... | streamlit/agent-knowledge/processes/pr-creation/README.md/0 | {
"file_path": "streamlit/agent-knowledge/processes/pr-creation/README.md",
"repo_id": "streamlit",
"token_count": 281
} |
---
status: experimental
last_updated: 2025-11-05
---
# Branch Naming - Best Practices
## Format
```
{type}/{brief-description}
```
## Types
- `feature` - New features or functionality
- `fix` - Bug fixes
- `refactor` - Code refactoring
- `chore` - Maintenance tasks (dependencies, tooling, etc.)
- `docs` - Documen... | streamlit/agent-knowledge/processes/pr-creation/branch-naming.md/0 | {
"file_path": "streamlit/agent-knowledge/processes/pr-creation/branch-naming.md",
"repo_id": "streamlit",
"token_count": 426
} |
---
status: stable
last_updated: 2025-12-02
---
# Guide: Describing Changes
Use this guide for PR template sections that ask what changed (e.g., "Describe your changes").
## Content Guidelines
**Keep it brief:** 2-4 bullets maximum for listing changes.
**List only impactful changes** - not every file touched.
**O... | streamlit/agent-knowledge/processes/pr-creation/describe-changes-guide.md/0 | {
"file_path": "streamlit/agent-knowledge/processes/pr-creation/describe-changes-guide.md",
"repo_id": "streamlit",
"token_count": 646
} |
---
status: experimental
last_updated: 2025-11-05
---
# PR Labeling Guide
All Streamlit PRs must have the following labels applied.
## Required Labels
### 1. Security Assessment
- `security-assessment-completed` - Required for all PRs
### 2. Impact Classification
Choose **one**:
- `impact:users` - Changes will ... | streamlit/agent-knowledge/processes/pr-creation/labeling-guide.md/0 | {
"file_path": "streamlit/agent-knowledge/processes/pr-creation/labeling-guide.md",
"repo_id": "streamlit",
"token_count": 410
} |
---
status: experimental
last_updated: 2025-11-05
---
# How to Fill In the Testing Plan
Guide for documenting tests in PR descriptions.
## Detect Test Changes in Git Diff
Check for modified/added test files:
**Python unit tests:**
- Pattern: `lib/tests/**/*.py`
- Example: `lib/tests/streamlit/elements/plotly_char... | streamlit/agent-knowledge/processes/pr-creation/testing-plan-guide.md/0 | {
"file_path": "streamlit/agent-knowledge/processes/pr-creation/testing-plan-guide.md",
"repo_id": "streamlit",
"token_count": 707
} |
---
status: stable
last_updated: 2025-12-02
---
# Writing Principles for PRs
**Core principle: Highlight what matters. Omit the obvious.**
Don't list every change - focus on the most impactful. Don't explain what's obvious from reading the code - only explain non-obvious decisions.
## Commit Messages
**Format:**
... | streamlit/agent-knowledge/processes/pr-creation/writing-principles.md/0 | {
"file_path": "streamlit/agent-knowledge/processes/pr-creation/writing-principles.md",
"repo_id": "streamlit",
"token_count": 726
} |
---
status: stable
last_updated: 2025-11-05
---
# Overview
This document includes details of the implementation of the layout feature for Streamlit.
The layout feature includes:
- Width parameters for widgets and elements.
- Height parameters for widgets and elements.
- A container element for flexbox layouts (st.c... | streamlit/agent-knowledge/references/guides/streamlit-layout-feature.md/0 | {
"file_path": "streamlit/agent-knowledge/references/guides/streamlit-layout-feature.md",
"repo_id": "streamlit",
"token_count": 3444
} |
nodeLinker: node-modules
| streamlit/component-lib/.yarnrc.yml/0 | {
"file_path": "streamlit/component-lib/.yarnrc.yml",
"repo_id": "streamlit",
"token_count": 8
} |
# Streamlit Component Library
An npm package that provides support code for creating [Streamlit Components](https://docs.streamlit.io/develop/concepts/custom-components).
The fastest way to start writing a Streamlit Component is to use our [Component Template repo](https://github.com/streamlit/component-template), wh... | streamlit/component-lib/README.md/0 | {
"file_path": "streamlit/component-lib/README.md",
"repo_id": "streamlit",
"token_count": 82
} |
<!--
Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required ... | streamlit/component-lib/RELEASE_NOTES.md/0 | {
"file_path": "streamlit/component-lib/RELEASE_NOTES.md",
"repo_id": "streamlit",
"token_count": 884
} |
/**
* Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unles... | streamlit/component-lib/jest.config.ts/0 | {
"file_path": "streamlit/component-lib/jest.config.ts",
"repo_id": "streamlit",
"token_count": 1938
} |
{
"name": "streamlit-component-lib",
"version": "2.0.0",
"description": "Support code for Streamlit Components",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"files": [
"dist"
],
"scripts": {
"build": "tsc",
"test": "jest ./src",
"typesync": "typesync",
"typesync:ci": "typesy... | streamlit/component-lib/package.json/0 | {
"file_path": "streamlit/component-lib/package.json",
"repo_id": "streamlit",
"token_count": 767
} |
/**
* Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unles... | streamlit/component-lib/src/ArrowTable.test.ts/0 | {
"file_path": "streamlit/component-lib/src/ArrowTable.test.ts",
"repo_id": "streamlit",
"token_count": 1591
} |
/**
* Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unles... | streamlit/component-lib/src/ArrowTable.ts/0 | {
"file_path": "streamlit/component-lib/src/ArrowTable.ts",
"repo_id": "streamlit",
"token_count": 2387
} |
/**
* Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unles... | streamlit/component-lib/src/StreamlitReact.test.tsx/0 | {
"file_path": "streamlit/component-lib/src/StreamlitReact.test.tsx",
"repo_id": "streamlit",
"token_count": 1944
} |
/**
* Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unles... | streamlit/component-lib/src/StreamlitReact.tsx/0 | {
"file_path": "streamlit/component-lib/src/StreamlitReact.tsx",
"repo_id": "streamlit",
"token_count": 1754
} |
/**
* Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unles... | streamlit/component-lib/src/index.ts/0 | {
"file_path": "streamlit/component-lib/src/index.ts",
"repo_id": "streamlit",
"token_count": 365
} |
End of preview. Expand in Data Studio
README.md exists but content is empty.
- Downloads last month
- 4