plotly/dash

CLAUDE.md

View on GitHub ↗Yours? Claim it ↗

§ 01 — Stats

Stars24.2k

Forks2.3k

Prior1393

Quality—

Score—

Tasks—

§ 02 — Use

Drop into your project.

A CLAUDE.md is just a markdown file at the root of your repo. Copy the content below into your own project's CLAUDE.md to give your agent the same context.

One-line install · current directory

$npx versuz@latest install plotly-dash --kind=claude-md

Or curl directly

$curl -o CLAUDE.md https://raw.githubusercontent.com/plotly/dash/HEAD/CLAUDE.md

Project typepython-data

Tokens—

Show CLAUDE.md content (~338 tokens)

# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Required Reading

**At the start of each session, read the documentation in `.ai/` before making changes:**

1. `.ai/COMMANDS.md` - Build, test, lint commands
2. `.ai/ARCHITECTURE.md` - Backend, callbacks, pages, assets, errors, background callbacks, Jupyter, config, stores, async, security
3. `.ai/RENDERER.md` - Frontend, crawlLayout, Redux store, clientside API, component API
4. `.ai/COMPONENTS.md` - Component system, generation, resources
5. `.ai/TESTING.md` - Testing framework, fixtures, patterns, type compliance
6. `.ai/TROUBLESHOOTING.md` - Common errors and solutions

## Project Overview

Dash is a Python framework for building reactive web-based data visualization applications. Built on Plotly.js, React, and Flask.

## Key Files

- `dash/dash.py` - Main Dash app class, layout, callbacks, routing
- `dash/_callback.py` - `@callback` decorator and execution
- `dash/dependencies.py` - `Input`, `Output`, `State`, wildcards
- `dash/development/base_component.py` - Component base class, `to_plotly_json()`
- `dash/dash-renderer/` - TypeScript/React frontend
- `components/` - Component packages (dcc, html, table)