faif / python-patterns

A collection of design patterns/idioms in Python

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Suggestion] Notebook version of the repo

modasserbillah opened this issue · comments

The way this repo is structured can be hard to read at times. Have you considered creating a jupyter notebook version of this repo?

Pros

  • Better formatting of texts
  • Code output can be easily shown
  • The illustration images can be added on the same notebook

Overall it would be a nicer learning experience. I have created one example here.

Hi. I like jupyter and I think that this is a good idea. When this repo was created jupyter was out of scope, but if you want to put some effort I encourage you 👍

In case someone wants to jump into this I'd recommend to deploy the notebooks with binder.

Thanks for the feedback! I have started putting them into notebooks on my repo. Feel free to check them out and collaborate. I'll deploy with binder once I have a good number of them added.

Sphinx gallery might be worth a look:

  • Inputs can be .py files or notebooks.
  • It renders to a nice page (requires a sphinx setup)
  • You can download the result as .py or notebook independent of the input format used.
  • There's experimental Binder support.

I'm going to give this a try.