PyLit

Literate Programming with reStructuredText

The idea is that you do not document programs (after the fact), but write documents that contain the programs. [1]

Features

PyLit (Python Literate) provides a plain but efficient tool for literate programming: a bidirectional text/code converter.

• Features
  • Dual Source
  • Simplicity
  • Markup with reStructuredText
  • Python Doctest Support

Documentation

• Usage
• Tutorial
• Examples
• Literate Programming

Download

• Requirements
• Download
• Installation

Project page

The PyLit project is hosted at BerliOS. The project page provides project statistics and info as well as links to the

• Bugtracker,
• Feature Requests,
• pylit-users Mail List, and
• the SVN repository.

Changes

PyLit versions and SVN log.

Usage, behaviour, and API are not fixed yet. Ideas and feedback welcome.

The PyLit source has a chapter on open questions and ideas.

Copyright

Copyright

© 2005, 2009 Günter Milde.

License

PyLit is free software, released under the GNU General Public License (GPL)

PyLit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

I am using PyLit in my daily work for more than two years now without major problems. It works for me, but your mileage might vary.

Remember to back up your data. A version control system is recommended.

About this site

The PyLit site is created from reStructuredText sources with Sphinx. (Earlier versions used the rest2web site builder.)

It is located at http://pylit.berlios.de/ on BerliOS, a free (and ad-free!) service to Open Source developers by the Fraunhofer-Institut für Offene Kommunikationssysteme (FOKUS) in Berlin.

[1]	John Max Skaller in a Charming Python interview