rimu 11.4.2

Rimu is a readable-text to HTML markup language inspired by AsciiDoc and Markdown.

A port of the Rimu Markup language written in the Python language.

Features

Functionally identical to the TypeScript implementation version 11.4.0.

Usage

Install from PyPI using the Python pip command:

pip install rimu

Example usage:

import rimu

print(rimu.render('*Hello World*!'))

See also Rimu API documentation.

CLI command

The Rimu CLI command installed by Pip is named rimupy. CLI command example:

echo 'Hello *Rimu*!' | rimupy

This will output:

<p>Hello <em>Rimu</em>!</p>

Building

Development is carried out in a Conda virtual environment so you need to have either Anaconda or Miniconda installed.

Build instructions:

1. Install the source repo from Github:

    git clone https://github.com/srackham/rimu-py.git
   

2. Create the rimu-py Conda environment (this includes Python and all the necessary Python packages):

    cd rimu-py/
    conda env create --file environment.yaml
   

3. Run tests and build rimu-py:

    conda activate rimu-py
    make build
   

Learn more

Read the documentation and experiment with Rimu in the Rimu Playground.

Implementation

• The largely one-to-one correspondence between the canonical TypeScript code and the Python code eased porting and debugging. This will also make it easier to cross-port new features and bug-fixes.

• All Rimu implementations share the same JSON driven test suites comprising over 300 compatibility checks.