spylang/spy

Make it possible to use the playground for interactive docs

Offen

#312 geöffnet am 15.11.2025

Auf GitHub ansehenContributor Guide
 (5 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (60 Forks)auto 404
help wantedplayground

Repository-Metriken

Stars
 (803 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 11T 20h) (22 gemergte PRs in 30 T)

Beschreibung

It would be awesome to have a version of the playground which we can embed in documentation and/or blog posts to have interactive snippets.

This is similar in spirit to what @JeffersGlass showed in his excellent pycon talk, with a twist: I think that in his talk, Jeff uses the standard py-editor component, while for spy we probably cannot (because the standard py-editor automatically executes the code with micropython/pyodide, while what we want is to save the content to a virtual file and call the spy cli).

Contributor Guide

Research-Richtung
Erkunde den vorhandenen Playground Code und die py editor Komponente. Verstehe, wie die spy CLI mit virtuellen Dateien arbeitet. Entwerfe eine Möglichkeit, den Playground in die Dokumentation einzubetten, die den Code in einer virtuellen Datei speichert und die spy CLI auslöst.
Tech Stack
python
Domain
documentationdeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60