sidekick-py 0.0.6

Client library for Sidekick Visual Coding Buddy

Sidekick Python Library (sidekick-py)

This library provides the Python interface for interacting with the Sidekick Visual Coding Buddy frontend UI, typically running within VS Code. It allows your Python scripts to easily create, update, and interact with visual modules like grids (Grid), consoles (Console), variable visualizers (Viz), drawing canvases (Canvas), and UI controls (Control).

Quick Start

1. Install the Python Library:

   pip install sidekick-py
   

2. Install the VS Code Extension:

   Get "Sidekick - Your Visual Coding Buddy" from the VS Code Marketplace

3. Open Sidekick Panel:

   Use the command palette (Ctrl+Shift+P) and run Sidekick: Show Panel.

4. Run the sample code:

   import sidekick
   import random
   
   # Create a 5x5 Grid
   grid = sidekick.Grid(5, 5)
   
   # Define what happens on click
   def handle_click(x, y):
       colors = ["khaki", "lavender", "peachpuff", "pink", "plum", "powderblue"]
       random_color = random.choice(colors)
       grid.set_color(x, y, random_color)
   
   # Register the click handler
   grid.on_click(handle_click)
   
   # Keep your script running to listen for clicks!
   sidekick.run_forever()
   

   Run your script using python your_file.py in the terminal, or click the Run button in VS Code.

5. Interact:

   Click cells in the Sidekick panel to see colors change (press Ctrl+C to stop)

Learn More

• Sidekick GitHub Repository
• Explore the Examples Directory.
• Read the Python API Reference.