Skip to content

ccmitchellusa/plotext_plus

Repository files navigation

πŸ“Š Plotext+ - Modern Terminal Plotting

PyPi Downloads GitHubIssues GitTutorial

logo

Plotext+ plots directly in your terminal with stunning visuals, modern APIs, and professional styling. Plotext+ is a redesigned version of the original plotext library by Savino Piccolomo. New features include an updated API with object oriented features, an MCP server to make the project easily usable with AI & LLM scenarios, new themes and integration with chuk-term to make sure it works in the awesome mcp-cli by Chris Hay.

✨ Key Features

🎯 Multiple Plot Types: scatter, line, bar, histogram, candlestick, heatmap, confusion matrix, pie, doughnut and more

🎨 Rich Visuals: Banner mode, themes, colored text, automatic terminal width detection

πŸ“Š Advanced Features: Subplots, datetime plots, image/GIF display, video streaming (including YouTube)

πŸ”§ Modern APIs: Clean public API, object-oriented charts, quick functions, 100% backward compatible

πŸ€– AI Integration: MCP server for direct AI client access (Claude, etc.)

⚑ Zero Dependencies: No required dependencies (optional packages for multimedia and AI integration)

subplots

πŸš€ Quick Start

Installation

# Modern Python package management
uv add plotext_plus

# Traditional installation
pip install plotext_plus

# With optional dependencies
pip install plotext_plus[image,video]      # Multimedia support
pip install plotext_plus[mcp]              # AI integration (MCP server)
pip install plotext_plus[image,video,mcp]  # All features

Basic Usage

import plotext_plus as plt

# Simple scatter plot
plt.scatter([1, 2, 3, 4], [1, 4, 9, 16])
plt.title("My First Plot")
plt.show()

Enhanced Visual Styling ✨

import plotext_plus as plt

# Enable beautiful banner mode
plt.banner_mode(True, "πŸ“Š Data Analysis Dashboard")

# Apply professional themes
plt.theme('professional')

# Create styled plot
plt.plot([1, 2, 3, 4], [1, 4, 2, 3], label="Data Series")
plt.title("Enhanced Line Plot")
plt.xlabel("Time")
plt.ylabel("Values")
plt.show()

Modern Chart Classes 🎯

import plotext_plus as plt

# Object-oriented chart creation with method chaining
chart = (plt.ScatterChart([1, 2, 3, 4], [1, 4, 9, 16])
         .title("Scientific Analysis")
         .xlabel("X Variable")
         .ylabel("Y Variable")
         .color('blue')
         .show())

# Quick one-liner plots
plt.quick_scatter(x_data, y_data, title="Quick Analysis")

Public API πŸ”§

import plotext_plus as plt

# Access organized functionality
plt.plotting.bar(categories, values)      # Main plotting functions
plt.themes.apply_theme('dark_mode')       # Theme management  
plt.utilities.log_success("Plot ready!")  # Helper utilities

AI Integration πŸ€–

# Install with MCP (Model Context Protocol) support  
pip install plotext_plus[mcp]

# Start the MCP server for AI clients like Claude
plotext-mcp

Use with Claude Desktop: Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "plotext-plus": {
      "command": "plotext-mcp",
      "args": [],
      "env": {}
    }
  }
}

Now AI clients can create plots directly:

"Create a scatter plot showing x=[1,2,3,4,5] vs y=[1,4,9,16,25] with title 'Quadratic Function'"

πŸ—οΈ Architecture & API

Public API Structure

# 🎯 Main Modules (Public API - no underscores)
plotext_plus.plotting    # Core plotting functions
plotext_plus.charts      # Object-oriented chart classes  
plotext_plus.themes      # Theme and styling system
plotext_plus.utilities   # Helper functions and tools

# πŸ“ Internal Modules (Private - with underscores)
plotext_plus._core       # Internal implementation
plotext_plus._api        # Internal API details
plotext_plus._themes     # Theme internals
# ... other internal modules

Project Structure

plotext_plus/
β”œβ”€β”€ src/plotext_plus/              # Modern src-layout
β”‚   β”œβ”€β”€ plotting.py           # 🎯 Main plotting functions (PUBLIC)
β”‚   β”œβ”€β”€ charts.py             # 🎯 Chart classes (PUBLIC)
β”‚   β”œβ”€β”€ themes.py             # 🎯 Theme system (PUBLIC)
β”‚   β”œβ”€β”€ utilities.py          # 🎯 Utilities (PUBLIC)
β”‚   └── _*.py                 # πŸ”’ Internal modules (PRIVATE)
β”œβ”€β”€ examples/                 # Interactive demos
β”‚   β”œβ”€β”€ interactive_demo.py   # Full interactive showcase
β”‚   └── theme_showcase_demo.py # Theme comparison tool
β”œβ”€β”€ tests/                    # Test suites
β”œβ”€β”€ docs/                     # Comprehensive documentation
└── pyproject.toml            # Modern packaging

🎨 Enhanced Features

🎭 Visual Enhancements

  • Professional Banners: Automatic width detection and border styling
  • Advanced Theming: Multiple built-in themes with chuk-term integration
  • Smart Layouts: Charts automatically resize to fit terminal dimensions
  • Rich Colors: 24-bit color support with automatic fallbacks

πŸš€ Developer Experience

  • Clean API: Public modules clearly separated from internals
  • Method Chaining: Fluent interface for complex plot creation
  • Quick Functions: One-liner plots for rapid prototyping
  • Type Safety: Better IDE support and autocomplete
  • Zero Breaking Changes: 100% backward compatibility guaranteed

πŸ§ͺ Try It Now

# Install and run interactive demo
pip install plotext_plus
python -c "
import plotext_plus as plt
plt.banner_mode(True, '🎨 Plotext Plus Demo')
plt.scatter([1,2,3,4], [1,4,2,3], color='blue')
plt.title('Welcome to Plotext Plus!')
plt.show()
"

# Run comprehensive demos
git clone https://github.com/ccmitchellusa/plotext_plus.git
cd plotext_plus
python examples/interactive_demo.py      # Full interactive showcase  
python examples/theme_showcase_demo.py   # Theme comparison

πŸ“š Complete Documentation

🎯 Core Plotting

πŸ–ΌοΈ Multimedia & Advanced

βš™οΈ Configuration & Styling

πŸ› οΈ Tools & Integration

πŸš€ Getting Started Guides

  1. πŸ‘‹ Introduction - First steps with Plotext
  2. πŸ“¦ Installation - Setup and dependencies
  3. 🎯 Quick Examples - Jump right in with code samples
  4. 🎨 Theming Guide - Make your plots beautiful
  5. πŸ”§ Modern API Guide - Use the clean public interface

πŸ’‘ Migration & Compatibility

For Existing Users: All your current code works unchanged! The new features are purely additive.

For New Users: Take advantage of the modern APIs and enhanced styling while learning the fundamentals.

# βœ… Your existing code still works
import plotext_plus as plt
plt.plot([1,2,3], [1,4,2])
plt.show()

# πŸ†• Enhanced with new features  
plt.banner_mode(True, "πŸ“Š My Analysis")
plt.theme('professional')
plt.plot([1,2,3], [1,4,2])
plt.show()

πŸ› οΈ Development & Build System

Plotext+ includes a comprehensive build system with modern tooling. See Build Documentation for complete setup, testing, publishing, and deployment instructions.

About

Modern terminal plotting library with enhanced visual features

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •