Skip to content

DEVLOG.md

Latest commit

 

History

History
121 lines (87 loc) · 4.73 KB

DEVLOG.md

File metadata and controls

121 lines (87 loc) · 4.73 KB
Raw

DEVLOG

TODO

  • Serve images as files, consider separate json for use with claude.
  • Revisit parser, consider using ast (and implement dependency tracking)
  • Package Setup.
  • Add a rest style server API for better agentic support.
  • Add a download button to recover the raw file.
  • Switch to IPython execution engine.
  • Create MCP server
  • Add SSE Updates. Server sent events with live updating
  • Documentation.
  • Enhanced pandas and plotting support (from marimo?)
  • Add other mime types (pdf, video)

2025-12-13

Major rewrite of the execution engine to use IPython instead of plain Python exec/eval.

IPython Execution Engine

  • Rewrote environment.py to use IPython's InteractiveShell
  • Added support for magic commands (%timeit, %%time, %who, %%capture, etc.)
  • Enabled top-level async/await without needing asyncio.run()
  • Added shell command support with ! prefix
  • Created SilentDisplayHook to capture results without printing to stdout
  • Fixed IPython's display_trap.hook caching issue for proper result capture

Error Formatting

  • Implemented ANSI-to-HTML conversion for colored error tracebacks
  • IPython's rich error formatting now displays with proper colors in the browser
  • Added filtering for internal plaque frames in stack traces

Download Button

  • Added [download] link in notebook header to retrieve original Python source
  • Source code is base64 encoded and embedded in the HTML
  • Notebooks are now fully self-contained and portable

Notebook Header

  • Added header with "Plaque Notebook" link to GitHub repository
  • Displays generation timestamp in UTC (YYYY-MM-DD HH:MM:SS UTC)
  • Clean monospace styling for both branding and download link

Testing

  • Added 8 new tests for IPython features (magics, async, shell commands)
  • Updated existing tests for IPython's different namespace behavior
  • All 218+ tests passing

2025-07-18

Added a gettting-started.py example.

2025-07-16

Created an ast based parser that should be more robust and dependency tracking which is enabled by default. Initially this was breaking on doc strings for functions but now should just be top level. For some reason the execution counts don't seem to start at zero, not sure what the deal is there.

Next enhancement to add would probably be to add some kind of api, which would let an agent like claude query or get the results of individual cells, that way they could see what is happening in a more fine grained way. The api should probably just serve json of the Cell objects on some path like /cells/ or something, not sure the right format there, and not sure if we can return proper python objects or maybe pickle serializations of them, but that seems a bit dangerous.

Added support for top level f, b, u and r strings. F strings are like code cells but look like markdown, but otherwise satisfy the depedency tracking.

Tried to update tests to add these cases.

Fixed the render and watch commands to be able to take a directory.

Decided to merge the ast branch to main and bump the minor version.

Started on the api branch to make it easier for agents to "see" the notebook. Need to remove the data uri's from the api calls, unless requested. And the image filenames keep incrementing.

Added to the README to document the f strings as a way of doing formatted markdown.

Bumped minor version number to 0.3.0

2025-07-15

Published on PyPI. uv publish. Also tried to fix the double formatting of the LaTeX.

2025-07-08

Picking this back up. I think I should start by writing some tests for the parser. Got a test harness written. Got a simple HTML Formatter and rich display support.

One thing to remember is to add a simple download button or something, to recover the raw file.

Fixed the watcher module. Enhanced the HTML formatter. Create proper HTML templates with CSS styling. Added Rich Display support. implement hooks for matplotlib, dataframes, etc. Improved error handling. Add capture for errors Updated CLI interface, --serve, --port Implemented live server, HTTP server with autoreload Added basic dependency tracking, caching and execution counters.

2025-05-16

I figured out that the code.InteractiveInterpreter really wasn't doing much, so I made my own environment with its own globals and locals. Now I think I am properly generating outputs, though I should catch and handle syntax errors and other errors and forward them.

Seems like next step is generating a proper html template and some styling, then at least I'll already having a thing that can generate nice outputs, after I add in the rich display hooks, that sort of thing.

Then I need to add support for the hashing and only selective running of code.

And I need the server that can stream the updates.