Metadata-Version: 2.5
Name: plotly-cloud
Version: 0.6.0
Summary: Python extension for Plotly Cloud with CLI and Dash dev tools integration
Project-URL: Repository, https://github.com/plotly/plotly-cloud-extension
License-File: LICENSE
Requires-Python: >=3.9
Requires-Dist: asgiref>=3.2
Requires-Dist: dash>=3.2.0
Requires-Dist: httpx<1.0.0,>=0.24.0
Requires-Dist: rich>=10.0.0
Requires-Dist: tomli-w>=1.2.0
Requires-Dist: tomli>=2.2.1
Description-Content-Type: text/markdown

# Plotly Cloud Extension

A Python extension for [Plotly Cloud](https://cloud.plotly.com) that provides both a command-line interface and Dash dev tools integration for publishing and managing Dash applications.

## Features

- 🔐 **Authentication**: Log in to Plotly Cloud with OAuth or an API key
- 🌱 **Scaffold**: Generate an agent-ready starter Dash app (ships AI-agent guidance), or add that guidance to an existing project
- 🚀 **Local Development**: Run Dash applications locally with comprehensive dev tools
- 📦 **Publish**: Publish Dash applications to Plotly Cloud and track build status
- 👥 **Teams**: Publish to and manage apps across the teams you belong to

## Scaffolding a new app

Create a starter Dash app in a new directory. The generated project ships AI-agent
guidance — an `AGENTS.md` and a skill that teach coding agents to drive the app
with the `dash_duo` fixture as their eyes:

```bash
plotly app scaffold my-app          # interactive prompts (name, guidance, config)
plotly app scaffold my-app --yes    # non-interactive, use defaults
```

The skill can be written for multiple agent harnesses at once. Interactive mode
asks which to include; non-interactively, pass `--harness` (comma-separated) and/or
`--skill-dir` for a custom folder:

```bash
# write the skill for Claude, Cursor, and Codex CLI
plotly app scaffold my-app --yes --harness claude,cursor,codex

# also drop the skill into a custom folder
plotly app scaffold my-app --yes --harness claude --skill-dir tools/skills
```

Supported harnesses (skill folder in parentheses): `claude` (`.claude/skills`, the
default), `oh-my-pi` (`.omp/skills`; aliases `omp`, `pi`), `opencode`
(`.opencode/skills`), `cursor` (`.cursor/skills`), and `codex` (`.agents/skills`,
also the cross-tool portable namespace). `AGENTS.md` is harness-independent and is
always written once at the project root.

Already have a project? Add or refresh just the agent guidance (the same
`--harness`/`--skill-dir` selection applies):

```bash
plotly app scaffold . --update
plotly app scaffold . --update --harness claude,opencode
```

## Installation

Install as a Dash extra:

```bash
pip install "dash[cloud]"
```

It can also be installed on its own:

```bash
pip install plotly-cloud
```

Verify the installation:

```bash
plotly --help
```

## Documentation

Full documentation lives in the Dash docs:

- [Overview](https://dash.plotly.com/plotly-cloud) — publishing, managing apps, and teams
- [CLI Configuration](https://dash.plotly.com/plotly-cloud/cli) — authentication and the `plotly-cloud.toml` project file
- [CLI Reference](https://dash.plotly.com/plotly-cloud/cli/reference) — every command, option, and flag
- [API Keys](https://dash.plotly.com/plotly-cloud/api-keys) and [CI/CD](https://dash.plotly.com/plotly-cloud/ci-cd) — automated deployments

## License

This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.

## Support

For issues and questions, please [open an issue in the Dash repository](https://github.com/plotly/dash/issues) or see the [Support](https://dash.plotly.com/support) page.
