joshkarpel / spiel Goto Github PK

Noticed this while looking at the README

Should be as easy as adding an extra Align.center, though perhaps the Panel needs expand=False as well?

End goal: panel should be centered on the right half of the slide, and should snugly fit the image.

Might be convenient for contributors, plus I'd like to experiment with this workflow.

• https://docs.github.com/en/codespaces/overview
• https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces

Make sure to update the contributing guide in the docs to note that this is available.

rich-pixels covers the same ground (and more) as spiel.Image (which, incidentally, I actually forgot to re-export from spiel/__init__.py

We should probably drop Image and just use rich-pixels for images, potentially with a caching layer on top for our special case of needing to re-render slide contents so often.

re: #222

get_function_body is pretty inflexible and I'm sure it fails on a wide variety of ways of writing functions. It should be tested on a variety of functions, including ones that are not e.g. black-compliant.

Right now, spiel has built-in support for dropping into a REPL, but it's the standard library REPL. It would be nice to support other REPLs, particularly the popular IPython REPL, out-of-the-box.

This might be a little tricky because I don't think I want to make IPython the default REPL, or installed by default. Maybe there will need to be a new entry in the CI matrix for installing and testing with extras?

We're currently pinned to textual==0.4.0 due to Textualize/textual#1274 / Textualize/textual#1227 , which impact our use of reactive.watch

The model needs to be described in enough detail to answers questions like #186

It looks like the DNS settings aren't forwarding requests for spiel.how over to www.spiel.how

IIUC, .how is a Google-provided TLD, so I assume they are your registrar & DNS provider. If so, here's a StackOverflow comment from a year ago about how to "Add a forwarding address" as Google terms it: https://stackoverflow.com/a/70527251

https://watchfiles.helpmanual.io/ is a more modern take on file-watching and looks like it has a much more convenient interface. It also supports async, which will be helpful for the inevitable textual migration.

Since the code will be changing anyway, we should probably watch the cwd by default, not just the deck file. That should produce more consistent and obvious behavior.

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes

None currently take more than ~10 minutes but the default timeout is 360 minutes. This would prevent, for example, accidental blocking tests from eating up my CI minutes.

Hi Josh

Spiel looks like fun. I'm wondering whether there are plans to support custom slide layouts to speed up the writing of presentations and remove some of the need to producing the rich content by hand?

I can think of a few different ways to do that, but you may (and probably) already have a design in mind if it is even meant to be added.

Regards Kenneth

For https://github.com/JoshKarpel/pytest-its-whats-for-testing I needed to have editable and executable code examples (stored as separate files) in the presentation.

To get that talk out the door, I did this "outside the library".

• I added a mechanism to add custom keybindings on a per-slide level

  spiel/spiel/slide.py

  Line 21 in 29c5138

  bindings: Mapping[str, Callable[..., None]] = field(default_factory=dict)

  . Because the callbacks are per-slide, I was able to generate new edit functions (using the library-level suspend) for each slide https://github.com/JoshKarpel/pytest-its-whats-for-testing/blob/ada03fc54c92c90a1f18ced4b80dca4cab56f7b4/pytest_its_whats_for_testing/slides.py#L132.
• I built code execution on top of triggers https://github.com/JoshKarpel/pytest-its-whats-for-testing/blob/ada03fc54c92c90a1f18ced4b80dca4cab56f7b4/pytest_its_whats_for_testing/slides.py#L72-L83.

It would be nice for there to be some kind of first-class mechanism for this inside spiel so that people don't need to reinvent the wheel. The problem is that this mechanism needs to be highly customizable:

• Code examples may or may not need to be editable, and there might be multiple files involved in a given example.
• Code examples might not be Python code, so the executable needs to be customizable (but sys.executable is probably a reasonable default). There might even be multiple things to execute!
• The slide contents need to be totally customizable. I'm not even sure I feel comfortable providing a default...

... but it might also be worth making a "drop dead simple" version that is not very customizable, and then letting users build more complex versions if they want one - the primitives are all there, of course. Being too proscriptive is not the goal, and building something that can please everyone isn't possible either.

Options is a dataclass right now, which is fine for its current simplicity, but using a Pydantic model would make it much more flexible for future growth.

Trying to start a notebook currently fails with

ValueError: '/tmp/spiel-ngzd063k/140051478698256.ipynb' is not in the subpath of '/mnt/c/Users/joshk/projects/spiel' OR one path is relative and the other is absolute.

Since the Quick Start kicks off with a 14 line snippet of code to copy-paste, it would be nice to have a copy-to-clipboard button handy. (GitHub provides one by default with code blocks, but mkdocs material theme requires a feature to be enabled in the theme for this.)

I'll make a quick PR for your consideration here

Context: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

Here's where it is being used: