{
    "info": {
        "author": "John Helmert III",
        "author_email": "jchelmertt3@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Environment :: Console :: Curses",
            "Intended Audience :: End Users/Desktop",
            "Natural Language :: English",
            "Operating System :: MacOS :: MacOS X",
            "Operating System :: POSIX",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Message Boards",
            "Topic :: Internet :: WWW/HTTP :: Dynamic Content :: News/Diary",
            "Topic :: Terminals"
        ],
        "description": "<h1 align=\"center\">Terminal UI for Reddit (TUIR)</h1>\n\n<p align=\"center\">\nA text-based interface (TUI) to view and interact with Reddit from your terminal.<br>\n</p>\n\n<p align=\"center\">\n  <strong>TUIR is a fork of rtv, which was maintained by Michael Lazar in <a href=\"https://github.com/michael-lazar/rtv\">this respository</a> until Jun 3, 2019.</strong><br>\n</p>\n\n<p align=\"center\">\n<img alt=\"title image\" src=\"resources/title_image.png\"/>\n</p>\n\n<p align=\"center\">\n  <a href=\"https://pypi.python.org/pypi/tuir/\">\n    <img alt=\"pypi\" src=\"https://img.shields.io/pypi/v/tuir.svg?label=version\"/>\n  </a>\n  <a href=\"https://gitlab.com/ajak/tuir/pipelines?ref=master\">\n    <img alt=\"gitlab-ci\" src=\"https://gitlab.com/ajak/tuir/badges/master/build.svg\"/>\n  </a> \n  <img alt=\"coverage\" src=\"https://gitlab.com/ajak/tuir/badges/master/coverage.svg\"/>\n  <a href=\"https://repology.org/project/tuir/versions\">\n    <img src=\"https://repology.org/badge/tiny-repos/tuir.svg\" alt=\"Packaging status\">\n  </a>\n</p>\n<!--\n  <a href=\"https://saythanks.io/to/michael-lazar\">\n    <img alt=\"say-thanks\" src=\"https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg\"/>\n  </a>\n</p> -->\n\n## Table of Contents\n\n* [Demo](#demo)  \n* [Installation](#installation)  \n* [Usage](#usage)  \n* [Settings](#settings)\n* [Themes](#themes)\n* [FAQ](#faq)  \n* [Contributing](#contributing)  \n* [License](#license)  \n\n## Demo\n\n<p align=\"center\">\n<img alt=\"title image\" src=\"resources/demo.gif\"/>\n</p>\n\n<!-- You can use *telnet* or *ssh* to try out a lite version of RTV directly in your terminal, without needing to install it:\n\n- ``$ telnet redditbox.us``\n- ``$ ssh redditbox.us``\n\n*[redditbox.us](https://redditbox.us/) is an independent project by Alex Jarmoszuk* -->\n\n## Installation\n\n### PyPI package\n\nTUIR is available on [PyPI](https://pypi.python.org/pypi/tuir/) and can be installed with pip:\n\n```bash\n$ pip install tuir\n```\n\n#### Migration from RTV\n\nIf you are migrating from RTV to TUIR, you can simply rename your old config directory/config file:\n\n```bash\n$ mv ~/.config/rtv ~/.config/tuir\n$ mv ~/.config/tuir/rtv.cfg ~/.config/tuir/tuir.cfg\n```\n\nPlease take care to use the new API keys for Imgur and Reddit. To replace with sed:\n\n```bash\n$ sed -i 's/E2oEtRQfdfAfNQ/zjyhNI7tK8ivzQ/; s/93396265f59dec9/b33d69ac8931734/' ~/.config/tuir/tuir.cfg\n```\n\n### Native packages\n\nSee [Repology](https://repology.org/metapackage/tuir/packages) for an up-to-date list of supported distro packages.\n\n<!-- ```bash\n# macOS\n$ brew install rtv\n\n# Arch\n$ pacman -S rtv\n\n# Nix\n$ nix-env -i rtv\n\n# Debian\n$ apt install rtv\n\n# FreeBSD\n$ pkg install rtv\n```-->\n\n### From source\n\n```bash\n$ git clone https://gitlab.com/ajak/tuir.git\n$ cd tuir\n$ python setup.py install\n```\n\n### Windows\n\nTUIR is not supported on Windows, due to a lack of resources and interest. Sorry!\n\n## Usage\n\nTo run the program, type:\n\n```bash\n$ tuir --help\n```\n\n### Controls\n\nMove the cursor using either the arrow keys or *Vim* style movement:\n\n- Press <kbd>\u25b2</kbd> and <kbd>\u25bc</kbd> to scroll through submissions\n- Press <kbd>\u25b6</kbd> to view the selected submission and <kbd>\u25c0</kbd> to return\n- Press <kbd>space-bar</kbd> to expand/collapse comments\n- Press <kbd>u</kbd> to login (this requires a web browser for [OAuth](https://github.com/reddit-archive/reddit/wiki/oauth2))\n- Press <kbd>?</kbd> to open the help screen\n\nPress <kbd>/</kbd> to open the navigation prompt, where you can type things like:\n\n- ``/front``\n- ``/r/commandprompt+linuxmasterrace``\n- ``/r/programming/controversial``\n- ``/u/me``\n- ``/u/multi-mod/m/art``\n- ``/domain/github.com``\n\nSee [CONTROLS](CONTROLS.md) for the full list of commands.\n\n## Settings\n\n### Configuration File\n\nConfiguration files are stored in the ``{HOME}/.config/tuir/`` directory.\n\nCheck out [tuir.cfg](tuir/templates/tuir.cfg) for the full list of configurable options. You can clone this file into your home directory by running:\n\n```bash\n$ tuir --copy-config\n```\n\n### Viewing Media Links\n\nYou can use [mailcap](https://en.wikipedia.org/wiki/Media_type#Mailcap) to configure how TUIR will open different types of links.\n\n<p align=\"center\">\n<img alt=\"title image\" src=\"resources/mailcap.gif\"/>\n</p>\n\nA mailcap file allows you to associate different MIME media types, like ``image/jpeg`` or ``video/mp4``, with shell commands. This feature is disabled by default because it takes a few extra steps to configure. To get started, copy the default mailcap template to your home directory.\n\n```bash\n$ tuir --copy-mailcap\n```\n\nThis template contains examples for common MIME types that work with popular reddit websites like *imgur*, *youtube*, and *gfycat*. Open the mailcap template and follow the [instructions](tuir/templates/mailcap) listed inside.\n\nOnce you've setup your mailcap file, enable it by launching tuir with the ``tuir --enable-media`` flag (or set it in your **tuir.cfg**)\n\n### Environment Variables\n\nThe default programs that TUIR interacts with can be configured through environment variables:\n\n<table>\n  <tr>\n  <td><strong>$TUIR_EDITOR</strong></td>\n  <td>A program used to compose text submissions and comments, e.g. <strong>vim</strong>, <strong>emacs</strong>, <strong>gedit</strong>\n  <br/> <em>If not specified, will fallback to $VISUAL and $EDITOR in that order.</em></td>\n  </tr>\n  <tr>\n  <td><strong>$TUIR_BROWSER</strong></td>\n  <td>A program used to open links to external websites, e.g. <strong>firefox</strong>, <strong>google-chrome</strong>, <strong>w3m</strong>, <strong>lynx</strong>\n  <br/> <em>If not specified, will fallback to $BROWSER, or your system's default browser.</em></td>\n  </tr>\n  <tr>\n  <td><strong>$TUIR_URLVIEWER</strong></td>\n  <td>A tool used to extract hyperlinks from blocks of text, e.g. <a href=https://github.com/sigpipe/urlview>urlview</a>, <a href=https://github.com/firecat53/urlscan>urlscan</a>\n  <br/> <em>If not specified, will fallback to urlview if it is installed.</em></td>\n  </tr>\n</table>\n\n### Clipboard\n\nTUIR supports copying submission links to the OS clipboard. On macOS this is supported out of the box.\nOn Linux systems you will need to install either [xsel](http://www.vergenet.net/~conrad/software/xsel/) or [xclip](https://sourceforge.net/projects/xclip/).\n\n## Themes\n\nThemes can be used to customize the look and feel of TUIR\n\n<table>\n  <tr>\n    <td align=\"center\">\n      <p><strong>Solarized Dark</strong></p>\n      <img src=\"resources/theme_solarized_dark.png\"></img>\n    </td>\n    <td align=\"center\">\n      <p><strong>Solarized Light</strong></p>\n      <img src=\"resources/theme_solarized_light.png\"></img>\n    </td>\n  </tr>\n  <tr>\n    <td align=\"center\">\n      <p><strong>Papercolor</strong></p>\n      <img src=\"resources/theme_papercolor.png\"></img>\n    </td>\n    <td align=\"center\">\n      <p><strong>Molokai</strong></p>\n      <img src=\"resources/theme_molokai.png\"></img>\n    </td>\n  </tr>\n</table>\n\nYou can list all installed themes with the ``--list-themes`` command, and select one with ``--theme``. You can save your choice permanently in your [tuir.cfg](tuir/templates/tuir.cfg) file. You can also use the <kbd>F2</kbd> & <kbd>F3</kbd> keys inside of TUIR to cycle through all available themes.\n\nFor instructions on writing and installing your own themes, see [THEMES.md](THEMES.md).\n\n## FAQ\n\n<details>\n <summary>Why am I getting an error during installation/when launching tuir?</summary>\n\n  > If your distro ships with an older version of python 2.7 or python-requests,\n  > you may experience SSL errors or other package incompatibilities. The\n  > easiest way to fix this is to install tuir using python 3. If you\n  > don't already have pip3, see http://stackoverflow.com/a/6587528 for setup\n  > instructions. Then do\n  >\n  > ```bash\n  > $ sudo pip uninstall tuir\n  > $ sudo pip3 install -U tuir\n  > ```\n\n</details>\n<details>\n  <summary>Why do I see garbled text like <em>M-b~@M-\"</em> or <em>^@</em>?</summary>\n\n  > This type of text usually shows up when python is unable to render\n  > unicode properly.\n  >    \n  > 1. Try starting TUIR in ascii-only mode with ``tuir --ascii``\n  > 2. Make sure that the terminal/font that you're using supports unicode\n  > 3. Try [setting the LOCALE to utf-8](https://perlgeek.de/en/article/set-up-a-clean-utf8-environment)\n  > 4. Your python may have been built against the wrong curses library,\n  >    see [here](stackoverflow.com/questions/19373027) and\n  >    [here](https://bugs.python.org/issue4787) for more information\n\n</details>\n<details>\n <summary>How do I run the code directly from the repository?</summary>\n\n  > This project is structured to be run as a python *module*. This means that\n  > you need to launch it using python's ``-m`` flag. See the example below, which\n  > assumes that you have cloned the repository into the directory **~/tuir_project**.\n  >\n  > ```bash\n  > $ cd ~/tuir_project\n  > $ python3 -m tuir\n  > ```\n\n</details>\n\n## Contributing\nAll feedback and suggestions are welcome, just post an issue!\n\nBefore writing any code, please read the [Contributor Guidelines](CONTRIBUTING.rst).\n\n## License\nThis project is distributed under the [MIT](LICENSE) license.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://gitlab.com/ajak/tuir",
        "keywords": "reddit terminal praw curses",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "tuir",
        "package_url": "https://pypi.org/project/tuir/",
        "platform": "",
        "project_url": "https://pypi.org/project/tuir/",
        "project_urls": {
            "Homepage": "https://gitlab.com/ajak/tuir"
        },
        "release_url": "https://pypi.org/project/tuir/1.28.3/",
        "requires_dist": [
            "beautifulsoup4",
            "decorator",
            "kitchen",
            "requests (>=2.4.0)",
            "six",
            "mailcap-fix ; python_version<'3.6'",
            "coveralls ; extra == 'test'",
            "pytest (>=3.1.0) ; extra == 'test'",
            "coverage ; extra == 'test'",
            "mock ; extra == 'test'",
            "pylint ; extra == 'test'",
            "vcrpy ; extra == 'test'"
        ],
        "requires_python": "",
        "summary": "A simple terminal viewer for Reddit (Terminal UI for Reddit)",
        "version": "1.28.3"
    },
    "last_serial": 5773606,
    "releases": {
        "1.28.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fdfaa834d3f72e198f6d3df1051668ef",
                    "sha256": "aeb7534bb509b3035d3822088e3b50f84313f75fe944b48a6a21260bb91e1d06"
                },
                "downloads": -1,
                "filename": "tuir-1.28.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "fdfaa834d3f72e198f6d3df1051668ef",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 162312,
                "upload_time": "2019-06-10T03:12:34",
                "url": "https://files.pythonhosted.org/packages/57/03/69326e5c45504ad34ff4f5d9ffb26af597b2e7eefe3bc6ebc77fe221fa33/tuir-1.28.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "06b01f9049ead925bf14419b0fc057e0",
                    "sha256": "a27799d93326b0ce84930e92dcca55032d97c21b45131813c9e740f99dfeaa75"
                },
                "downloads": -1,
                "filename": "tuir-1.28.1.tar.gz",
                "has_sig": false,
                "md5_digest": "06b01f9049ead925bf14419b0fc057e0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17309006,
                "upload_time": "2019-06-10T03:13:38",
                "url": "https://files.pythonhosted.org/packages/eb/7d/c9db97d3dae9faf169e7ba7a02131b23e60a3371369067dbd7e4d75745e8/tuir-1.28.1.tar.gz"
            }
        ],
        "1.28.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "764e7b115e1e37b507b051e03b078e07",
                    "sha256": "940df8fe3dd6ef3c4a6dbe8f5010b75d4efc3053f0b8ac9d63867b3c5a252f30"
                },
                "downloads": -1,
                "filename": "tuir-1.28.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "764e7b115e1e37b507b051e03b078e07",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 162492,
                "upload_time": "2019-06-13T02:22:16",
                "url": "https://files.pythonhosted.org/packages/dc/6b/7c8f0859bcddd6d032d1702c6e0e5eb43ca0c37f7c40f8c55f64f47259fa/tuir-1.28.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "5a06d6926f2b944956a8cd618fd12d79",
                    "sha256": "65c96bd93ad3539a8a9681313c4a48d27052698a533b4a707c8e4bd93dc984dc"
                },
                "downloads": -1,
                "filename": "tuir-1.28.2.tar.gz",
                "has_sig": false,
                "md5_digest": "5a06d6926f2b944956a8cd618fd12d79",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17309578,
                "upload_time": "2019-06-13T02:23:17",
                "url": "https://files.pythonhosted.org/packages/cd/c9/122a10d802ff91d7b4955402ad0fa7e38f03694766c62f6efe11522f78f6/tuir-1.28.2.tar.gz"
            }
        ],
        "1.28.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "228368ed43871ed6b35723e68e34d68c",
                    "sha256": "a93edf1f9f772930ec085b130c0d5972c0acf432f41cd809d07fcdfd30b2e3aa"
                },
                "downloads": -1,
                "filename": "tuir-1.28.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "228368ed43871ed6b35723e68e34d68c",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 162594,
                "upload_time": "2019-09-03T03:07:36",
                "url": "https://files.pythonhosted.org/packages/93/99/227f48226b533864f49c13e959a5e2dc95b669fba88df5c962d8695b8a25/tuir-1.28.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "89cb0f8241e37ab6afd784757e598fbf",
                    "sha256": "b941905cf6656b2e629672249a027e216da95281df8a51c1c0d235796896febe"
                },
                "downloads": -1,
                "filename": "tuir-1.28.3.tar.gz",
                "has_sig": false,
                "md5_digest": "89cb0f8241e37ab6afd784757e598fbf",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17309748,
                "upload_time": "2019-09-03T03:07:56",
                "url": "https://files.pythonhosted.org/packages/ff/5b/16ba22727ba6248d5d60b53cc31eba6377982ee18f0fec79f0cf3adc609f/tuir-1.28.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "228368ed43871ed6b35723e68e34d68c",
                "sha256": "a93edf1f9f772930ec085b130c0d5972c0acf432f41cd809d07fcdfd30b2e3aa"
            },
            "downloads": -1,
            "filename": "tuir-1.28.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "228368ed43871ed6b35723e68e34d68c",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 162594,
            "upload_time": "2019-09-03T03:07:36",
            "url": "https://files.pythonhosted.org/packages/93/99/227f48226b533864f49c13e959a5e2dc95b669fba88df5c962d8695b8a25/tuir-1.28.3-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "89cb0f8241e37ab6afd784757e598fbf",
                "sha256": "b941905cf6656b2e629672249a027e216da95281df8a51c1c0d235796896febe"
            },
            "downloads": -1,
            "filename": "tuir-1.28.3.tar.gz",
            "has_sig": false,
            "md5_digest": "89cb0f8241e37ab6afd784757e598fbf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 17309748,
            "upload_time": "2019-09-03T03:07:56",
            "url": "https://files.pythonhosted.org/packages/ff/5b/16ba22727ba6248d5d60b53cc31eba6377982ee18f0fec79f0cf3adc609f/tuir-1.28.3.tar.gz"
        }
    ]
}