Metadata-Version: 2.4
Name: rst2ansi
Version: 0.1.5
Summary: A rst converter to ansi-decorated console output
Home-page: https://github.com/Snaipe/python-rst-to-ansi
Author: Snaipe
Author-email: franklinmathieu@gmail.com
License: MIT
Keywords: rst restructuredtext ansi console code converter
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Utilities
Requires: docutils
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires
Dynamic: summary

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

.. code:: bash

    pip install rst2ansi

Usage
-----

As a CLI utility:
~~~~~~~~~~~~~~~~~

.. code:: bash

    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:
~~~~~~~~~~~~~~~~~~~

.. code:: python

    from rst2ansi import rst2ansi

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

.. |build| image:: https://api.travis-ci.org/Snaipe/python-rst2ansi.svg
   :target: https://travis-ci.org/Snaipe/python-rst2ansi

.. |downloads| image:: https://img.shields.io/pypi/dm/rst2ansi.svg
   :target: https://pypi.python.org/pypi/rst2ansi/

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/rst2ansi.svg

.. |format| image:: https://img.shields.io/pypi/format/rst2ansi.svg

.. |asciicast| image:: https://asciinema.org/a/drykz69gtn557z3hxnbb1jybq.png
   :target: https://asciinema.org/a/drykz69gtn557z3hxnbb1jybq
