Search code examples
pythonwindowsliterate-programmingnoweb

What's the best way to do literate programming in Python on Windows?


I've been playing with various ways of doing literate programming in Python. I like noweb, but I have two main problems with it: first, it is hard to build on Windows, where I spend about half my development time; and second, it requires me to indent each chunk of code as it will be in the final program --- which I don't necessarily know when I write it. I don't want to use Leo, because I'm very attached to Emacs.

Is there a good literate programming tool that:

  1. Runs on Windows
  2. Allows me to set the indentation of the chunks when they're used, not when they're written
  3. Still lets me work in Emacs

Thanks!


Correction: noweb does allow me to indent later --- I misread the paper I found on it.

By default, notangle preserves whitespace and maintains indentation when expanding chunks. It can therefore be used with languages like Miranda and Haskell, in which indentation is significant

That leaves me with only the "Runs on Windows" problem.


Solution

  • I did this:

    http://sourceforge.net/projects/pywebtool/

    You can get any number of web/weave products that will help you construct a document and code in one swoop.

    You can -- pretty easily -- write your own. It's not rocket science to yank the Python code blocks out of RST source and assemble it. Indeed, I suggest you write your own Docutils directives to assemble the Python code from an RST source document.

    You run the RST through docutils rst2html (or Sphinx) to produce your final HTML report.

    You run your own utility on the same RST source to extract the Python code blocks and produce the final modules.