Skip to content

Snaipe/python-rst2ansi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rst2ansi

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!'))

About

A python utility for rendering RST in the terminal

Resources

License

Stars

Watchers

Forks

Packages

No packages published