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
Raw data
{
"_id": null,
"home_page": "https://github.com/Snaipe/python-rst-to-ansi",
"name": "rst2ansi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "rst restructuredtext ansi console code converter",
"author": "Snaipe",
"author_email": "franklinmathieu@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3c/19/b29bc04524e7d1dbde13272fbb67e45a8eb24bb6d112cf10c46162b350d7/rst2ansi-0.1.5.tar.gz",
"platform": "UNKNOWN",
"description": "rst2ansi\n========\n\n|build| |downloads| |pyversions| |format|\n\nA python module dedicated to rendering RST (reStructuredText) documents\nto ansi-escaped strings suitable for display in a terminal.\n\n|asciicast|\n\nInstallation\n------------\n\nRequirements\n~~~~~~~~~~~~\n\nPython 3.3+\n\nPyPi package\n~~~~~~~~~~~~\n\n.. code:: bash\n\n pip install rst2ansi\n\nUsage\n-----\n\nAs a CLI utility:\n~~~~~~~~~~~~~~~~~\n\n.. code:: bash\n\n usage: rst2ansi [-h] [file]\n\n Prints a reStructuredText input in an ansi-decorated format suitable for\n console output.\n\n positional arguments:\n file A path to the file to open\n\n optional arguments:\n -h, --help show this help message and exit\n\nAs a python module:\n~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n from rst2ansi import rst2ansi\n\n print(rst2ansi('I **love** reStructuredText!'))\n\n.. |build| image:: https://api.travis-ci.org/Snaipe/python-rst2ansi.svg\n :target: https://travis-ci.org/Snaipe/python-rst2ansi\n\n.. |downloads| image:: https://img.shields.io/pypi/dm/rst2ansi.svg\n :target: https://pypi.python.org/pypi/rst2ansi/\n\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/rst2ansi.svg\n\n.. |format| image:: https://img.shields.io/pypi/format/rst2ansi.svg\n\n.. |asciicast| image:: https://asciinema.org/a/drykz69gtn557z3hxnbb1jybq.png\n :target: https://asciinema.org/a/drykz69gtn557z3hxnbb1jybq",
"bugtrack_url": null,
"license": "MIT",
"summary": "A rst converter to ansi-decorated console output",
"version": "0.1.5",
"split_keywords": [
"rst",
"restructuredtext",
"ansi",
"console",
"code",
"converter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "46cbfdb216f2b8bbec9c43655a79f2f280b2ba7822b2c8396ecceafa0c232320",
"md5": "3175c1575e431b220061efeb4b272503",
"sha256": "b2cf192e38975918d07540bba7d673550cd7d28ca7443410984e22d5ab058fb3"
},
"downloads": -1,
"filename": "rst2ansi-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3175c1575e431b220061efeb4b272503",
"packagetype": "bdist_wheel",
"python_version": "3.5",
"requires_python": null,
"size": 18414,
"upload_time": "2016-05-24T16:43:27",
"upload_time_iso_8601": "2016-05-24T16:43:27.677541Z",
"url": "https://files.pythonhosted.org/packages/46/cb/fdb216f2b8bbec9c43655a79f2f280b2ba7822b2c8396ecceafa0c232320/rst2ansi-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3c19b29bc04524e7d1dbde13272fbb67e45a8eb24bb6d112cf10c46162b350d7",
"md5": "e782c60f3f3696bd7702b6a3082be195",
"sha256": "1b17fb9a628d40f57933ad1a3aa952346444be069469508e73e95060da33fe6f"
},
"downloads": -1,
"filename": "rst2ansi-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "e782c60f3f3696bd7702b6a3082be195",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9989,
"upload_time": "2016-05-24T16:43:11",
"upload_time_iso_8601": "2016-05-24T16:43:11.878364Z",
"url": "https://files.pythonhosted.org/packages/3c/19/b29bc04524e7d1dbde13272fbb67e45a8eb24bb6d112cf10c46162b350d7/rst2ansi-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2016-05-24 16:43:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Snaipe",
"github_project": "python-rst-to-ansi",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "rst2ansi"
}
JSON
