pdit 0.1.0__tar.gz → 0.2.0__tar.gz

{pdit-0.1.0 → pdit-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdit
-Version: 0.1.0
+Version: 0.2.0
 Summary: Interactive Python code editor with inline execution results
 Author: Harry Vangberg
 License: Private
@@ -26,11 +26,10 @@ Requires-Dist: jupyter_client>=8.0.0
 Requires-Dist: ipykernel>=6.29.0
 Requires-Dist: itables>=2.6.1
 Requires-Dist: ipython>=8.18.1
-Provides-Extra: examples
-Requires-Dist: great-tables>=0.20.0; extra == "examples"
-Requires-Dist: matplotlib>=3.7.5; extra == "examples"
-Requires-Dist: pandas>=2.0.3; extra == "examples"
-Requires-Dist: polars>=1.8.2; extra == "examples"
+Provides-Extra: demo
+Requires-Dist: great-tables>=0.20.0; extra == "demo"
+Requires-Dist: matplotlib>=3.7.5; extra == "demo"
+Requires-Dist: polars>=1.8.2; extra == "demo"
 
 # pdit
 
@@ -42,6 +41,7 @@ pdit lets you write regular Python files and see execution results inline, like
 
 ```bash
 pip install pdit
+pdit --demo
 pdit script.py
 ```
 
@@ -80,18 +80,29 @@ Pandas and Polars DataFrames render as interactive tables automatically.
 
 ### Plots
 
-Matplotlib figures display inline. Call `plt.show()`.
+Matplotlib figures display inline. Call `plt.show()`. To avoid every
+`plt.*` call emitting a plot, wrap plot creation in `with plt.ioff():` and
+call `plt.show()` when you're ready.
+
+```python
+import matplotlib.pyplot as plt
+
+with plt.ioff():
+    plt.figure()
+    plt.plot(x, y)
+    plt.show()
+```
 
 ## Installation
 
 For development installs or running from source, use [uv](https://github.com/astral-sh/uv).
 
 ```bash
-# Install from dist branch (recommended, includes pre-built assets)
-uv add git+https://github.com/vangberg/pdit@dist
+# Install from PyPI
+uv add pdit
 
 # Or use directly with uvx
-uvx --from git+https://github.com/vangberg/pdit@dist pdit script.py
+uvx pdit script.py
 
 # From cloned repo (for development)
 git clone git@github.com:vangberg/pdit.git
@@ -125,6 +136,7 @@ uv run pdit script.py
 pdit [OPTIONS] [SCRIPT]
 
 Options:
+  --demo             Open the bundled demo script
   --port INTEGER      Port to run server on (default: 8888)
   --host TEXT         Host to bind to (default: 127.0.0.1)
   --no-browser        Don't open browser automatically
@@ -137,6 +149,9 @@ Options:
 # Start with script
 pdit analysis.py
 
+# Start with the bundled demo script
+pdit --demo
+
 # Custom port
 pdit --port 9000 script.py
 

{pdit-0.1.0 → pdit-0.2.0}/README.md

@@ -8,6 +8,7 @@ pdit lets you write regular Python files and see execution results inline, like
 
 ```bash
 pip install pdit
+pdit --demo
 pdit script.py
 ```
 
@@ -46,18 +47,29 @@ Pandas and Polars DataFrames render as interactive tables automatically.
 
 ### Plots
 
-Matplotlib figures display inline. Call `plt.show()`.
+Matplotlib figures display inline. Call `plt.show()`. To avoid every
+`plt.*` call emitting a plot, wrap plot creation in `with plt.ioff():` and
+call `plt.show()` when you're ready.
+
+```python
+import matplotlib.pyplot as plt
+
+with plt.ioff():
+    plt.figure()
+    plt.plot(x, y)
+    plt.show()
+```
 
 ## Installation
 
 For development installs or running from source, use [uv](https://github.com/astral-sh/uv).
 
 ```bash
-# Install from dist branch (recommended, includes pre-built assets)
-uv add git+https://github.com/vangberg/pdit@dist
+# Install from PyPI
+uv add pdit
 
 # Or use directly with uvx
-uvx --from git+https://github.com/vangberg/pdit@dist pdit script.py
+uvx pdit script.py
 
 # From cloned repo (for development)
 git clone git@github.com:vangberg/pdit.git
@@ -91,6 +103,7 @@ uv run pdit script.py
 pdit [OPTIONS] [SCRIPT]
 
 Options:
+  --demo             Open the bundled demo script
   --port INTEGER      Port to run server on (default: 8888)
   --host TEXT         Host to bind to (default: 127.0.0.1)
   --no-browser        Don't open browser automatically
@@ -103,6 +116,9 @@ Options:
 # Start with script
 pdit analysis.py
 
+# Start with the bundled demo script
+pdit --demo
+
 # Custom port
 pdit --port 9000 script.py
 

pdit-0.2.0/pdit/_demo.py

@@ -0,0 +1,103 @@
+"""
+# Markdown
+
+Top-level strings are _rendered_ as [Markdown](https://en.wikipedia.org/wiki/Markdown).
+"""
+
+"""
+## Expressions
+"""
+
+1 + 2
+
+[x * 2 for x in [1, 2, 3]]
+
+"""
+## Matplotlib
+"""
+
+import math
+import matplotlib.pyplot as plt
+
+x = [i * 0.1 for i in range(0, 63)]
+y = [math.sin(v) for v in x]
+
+# Wrap in `with plt.ioff():` to avoid every call to `plt.*` rendering a
+# plot.
+with plt.ioff():
+  plt.figure()
+  plt.plot(x, y)
+  plt.xlabel('x')
+  plt.ylabel('sin(x)')
+  plt.show()
+
+"""
+## Polars/Pandas
+
+DataFrames are rendered as interactive tables.
+"""
+
+import polars as pl
+
+df = pl.read_csv("https://raw.githubusercontent.com/mwaskom/seaborn-data/master/iris.csv")
+df
+
+"""
+## GreatTables
+
+[GreatTables](https://posit-dev.github.io/great-tables/) renders rich HTML tables.
+"""
+
+from great_tables import GT
+
+GT(df.head(5))
+
+"""
+## HTML representation
+
+Classes that implement a `_repr_html_()` function returning HTML are rendered
+as HTML.
+"""
+
+class IrisSummary:
+  def __init__(self, df: pl.DataFrame):
+    self.df = df
+
+  def _repr_html_(self) -> str:
+    summary = (
+      self.df.group_by("species")
+      .agg(pl.col("sepal_length").mean().round(2).alias("mean"))
+      .sort("mean", descending=True)
+    )
+    max_mean = float(summary["mean"].max())
+    rows = "".join(
+      "<tr>"
+      f"<td style='padding-right:8px'>{species}</td>"
+      f"<td><meter min='0' max='{max_mean:.2f}' value='{mean:.2f}'></meter></td>"
+      f"<td style='padding-left:6px'>{mean:.2f}</td>"
+      "</tr>"
+      for species, mean in summary.iter_rows()
+    )
+    return (
+      "<div style='display:inline-block;border:1px solid #ddd;border-radius:8px;"
+      "padding:8px 10px;background:#fff;'>"
+      "<div style='font-weight:600;margin-bottom:6px'>Mean sepal length</div>"
+      "<table style='border-collapse:collapse;font-size:12px'>"
+      + rows
+      + "</table></div>"
+    )
+
+
+IrisSummary(df)
+
+
+"""
+## IPython display objects
+
+IPython [display objects](https://ipython.readthedocs.io/en/latest/api/generated/IPython.display.html)
+are supported, e.g. images.
+"""
+
+from IPython.display import Image
+
+Image('pea.png')