lamarqua / lyt

A small python script for writing literate programs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Lyt : simple literate programming in Markdown.

Lyt is a literate programming tool, written in Python, that extracts fenced code blocks from Markdown documents. It is meant to be used as a preprocess tool before a conventional build.

It is licensed under the GPLv3. See the LICENSE.txt file in this repo.

Installation

Using pip:

pip install lyt

lyt depends solely on click for command line processing.

Usage

Open your favorite command line:

$ lyt file.md

For more information, use --help:

$ lyt --help

Goals

  • Stay python 2 and 3 compatible.
  • Stay simple.
    • In particular, handling several files at a time isn't a goal
    • Nor is handling the dependency between generated files and the source.

Future

  • Add support for more languages.
  • Allow autodetection of languages.
  • Add better tests.
  • Add static types and validate with mypy.
  • Maybe allow hierarchical embedding?

About

A small python script for writing literate programs.

License:GNU General Public License v3.0


Languages

Language:Python 100.0%