Skip to main content

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

Project description

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


Functionally identical to the TypeScript implementation version 11.4.0.


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>


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
  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.


  • 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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rimu-11.4.2.tar.gz (33.4 kB view hashes)

Uploaded Source

Built Distribution

rimu-11.4.2-py3-none-any.whl (38.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page