{"id":15805467,"url":"https://github.com/stephenfin/rst2txt","last_synced_at":"2025-04-01T16:30:53.733Z","repository":{"id":53213357,"uuid":"157217523","full_name":"stephenfin/rst2txt","owner":"stephenfin","description":"Convert reStructuredText to plain text","archived":false,"fork":false,"pushed_at":"2021-04-01T07:35:40.000Z","size":74,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-06T02:21:23.418Z","etag":null,"topics":["docutils","restructuredtext","sphinx"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stephenfin.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-12T13:26:14.000Z","updated_at":"2024-01-23T11:10:03.000Z","dependencies_parsed_at":"2022-09-12T14:22:30.573Z","dependency_job_id":null,"html_url":"https://github.com/stephenfin/rst2txt","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenfin%2Frst2txt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenfin%2Frst2txt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenfin%2Frst2txt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenfin%2Frst2txt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stephenfin","download_url":"https://codeload.github.com/stephenfin/rst2txt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246620442,"owners_count":20806775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docutils","restructuredtext","sphinx"],"created_at":"2024-10-05T02:21:03.503Z","updated_at":"2025-04-01T16:30:53.504Z","avatar_url":"https://github.com/stephenfin.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=======\nrst2txt\n=======\n\n.. image:: https://badge.fury.io/py/rst2txt.svg\n   :target: https://badge.fury.io/py/rst2txt\n   :alt: PyPi Status\n\n.. image:: https://travis-ci.org/stephenfin/rst2txt.svg?branch=master\n   :target: https://travis-ci.org/stephenfin/rst2txt\n   :alt: Build Status\n\nreStructuredText is pretty-damn consumable in its raw form, but extensive use\nof directives and roles can hamper things or leave the document incomplete in\nits raw form (cough, ``.. include``, cough).\n\n*rst2txt* allows you to work around this by evaluating the reStructuredText\nsource and stripping it of most of its formatting. The end result is a document\nthat's more readable and has elements that don't make sense in a plain text\ndocument, such as images, stripped.\n\n*rst2txt* is based on the ``sphinx.writer.text.TextWriter`` writer used by\nSphinx's `TextBuilder\n\u003chttps://www.sphinx-doc.org/en/1.8/usage/builders/index.html#sphinx.builders.text.TextBuilder\u003e`__\nbut with the Sphinx-specific features stripped out.\n\nInstallation\n------------\n\n*rst2txt* is available on PyPI. To install, run:\n\n.. code-block:: shell\n\n   $ pip install --user rst2txt\n\nUsage\n-----\n\nMost users will want just the ``rst2txt`` application:\n\n.. code-block:: shell\n\n   $ rst2txt README.rst\n\nIt is also possible to call this programmatically though. This can be useful\nfor things like consuming README files:\n\n.. code-block:: python\n\n   from docutils.core import publish_file\n   import rst2txt\n\n   with open('README.rst', 'r') as source:\n       publish_file(source=source, destination_path='README.txt',\n                    writer=rst2txt.Writer())\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenfin%2Frst2txt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstephenfin%2Frst2txt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenfin%2Frst2txt/lists"}