Seite auswählen

PyLit

PyLit (Python-Literate) bietet ein einfaches, aber effizientes Werkzeug für die literate programming: einen bidirektionalen Konverter zwischen

  • eine “Text”-Quelle mit eingebetteten Codeblöcken und
  • eine “Code”-Quelle mit der Dokumentation in Kommentarblöcken.

Es ist in Python geschrieben, sollte aber mit jeder Programmiersprache funktionieren, die eine Syntax für Kommentarblöcke bietet.

Die folgenden Merkmale unterscheiden PyLit von anderen literarischen Programmier-Frameworks

Dual Source

Die Programmquelle kann entweder im Format “Text” oder “Code” vorliegen:

  • Der “Code”-Quelltext kann mit Standardwerkzeugen debugged, kompiliert oder ausgeführt werden.
  • Die “Text”-Quelle kann in HTML- oder LaTeX-Dokumente umgewandelt werden, z.B. mit den Python-Dokutilen oder Sphinx.

Das Pylit-Modulskript konvertiert die Quelle zwischen den Formaten “text” und “code”.

Beide Formate enthalten die vollständigen Informationen. Roundtrips sind verlustfrei möglich.

Vorteile

  • Die Arbeit an Code- oder Dokumentationsteilen kann in angepassten Editor-Modi oder Umgebungen erfolgen, die Formatierungswerkzeuge, Syntaxhervorhebung, Skizzierung und andere Annehmlichkeiten bieten.
  • Das Debugging ist einfach (im Format “Code”). Korrekturen lassen sich leicht an das Format “text” übergeben (einfach pylit.py im Quellcode “code” aufrufen).

Download

https://pypi.org/project/pylit/