Quick Start

Quick Start Guide ⚡

Get started with PipePlotly in three simple steps.

1. Installation

Install the core package. For full features (including statistical smoothing), use the full extra.

pip install pipeplotly[full]

2. Your First Plot (The Functional Way)

PipePlotly's "North Star" is the pipe operator (>>). Import the verbs you need and flow your data.

import pandas as pd
from pipeplotly import Plot
from pipeplotly.verbs import plot_points, add_color, show

# Create data
df = pd.DataFrame({
    'weight': [10, 20, 30, 40],
    'height': [100, 110, 120, 130],
    'type': ['A', 'A', 'B', 'B']
})

# The Pipeline
df >> Plot() >> plot_points('weight', 'height') >> add_color('type') >> show()

3. Go Interactive

Want to zoom, hover, and pan? Simply inject to_interactive() into your existing pipeline.

(df 
 >> Plot() 
 >> plot_points('weight', 'height') 
 >> add_color('type') 
 >> to_interactive()  # Switch to Plotly backend
 >> show())

---

What's Next?

• Learn about verbs: See the API-Reference.
• Master complex flows: Check the Pipe-Operator-Guide.
• Home: Return to the Home page.