A rst converter to ansi-decorated console output

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Snaipe from gravatar.com Snaipe

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Snaipe
  • Tags rst, restructuredtext, ansi, console, code, converter
Classifiers
Report project as malware

Project description

build downloads pyversions format

A python module dedicated to rendering RST (reStructuredText) documents to ansi-escaped strings suitable for display in a terminal.

asciicast

Installation

Requirements

Python 3.3+

PyPi package

pip install rst2ansi

Usage

As a CLI utility:

usage: rst2ansi [-h] [file]

Prints a reStructuredText input in an ansi-decorated format suitable for
console output.

positional arguments:
  file        A path to the file to open

optional arguments:
  -h, --help  show this help message and exit

As a python module:

from rst2ansi import rst2ansi

print(rst2ansi('I **love** reStructuredText!'))

Supported by

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