gryf/tuir
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename rtv to tuir

Browse Source
This commit is contained in:
John Helmert
2019-06-09 19:31:35 -05:00
parent 481780fffa
commit 7e9455b4ca
76 changed files with 352 additions and 359 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@@ -1,34 +1,34 @@
<h1 align="center">Reddit Terminal Viewer (RTV)</h1>
<h1 align="center">Terminal UI for Reddit (TUIR)</h1>
<p align="center">
A text-based interface (TUI) to view and interact with Reddit from your terminal.<br>
</p>
<p align="center">
<strong>This fork of rtv is currently maintained by John Helmert III (ajak) and was maintained by Michael Lazar in <a href="https://github.com/michael-lazar/rtv">this respository</a> until commit 7923890 on Jun 3, 2019.</strong><br>
<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>
</p>
<p align="center">
<img alt="title image" src="resources/title_image.png"/>
</p>
<p align="center">
<!-- <p align="center">
<a href="https://pypi.python.org/pypi/rtv/">
<img alt="pypi" src="https://img.shields.io/pypi/v/rtv.svg?label=version"/>
</a>
<!-- <a href="https://travis-ci.org/michael-lazar/rtv">
<a href="https://travis-ci.org/michael-lazar/rtv">
<img alt="travis-ci" src="https://travis-ci.org/michael-lazar/rtv.svg?branch=master"/>
</a> -->
</a>
<a href="https://repology.org/project/rtv/versions">
<img src="https://repology.org/badge/tiny-repos/rtv.svg" alt="Packaging status">
</a>
<!-- <a href="https://coveralls.io/github/michael-lazar/rtv?branch=master">
<a href="https://coveralls.io/github/michael-lazar/rtv?branch=master">
<img alt="coveralls" src="https://coveralls.io/repos/michael-lazar/rtv/badge.svg?branch=master&service=github"/>
</a>
<a href="https://saythanks.io/to/michael-lazar">
<img alt="say-thanks" src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg"/>
</a> -->
</p>
</a>
</p> -->
## Table of Contents
@@ -88,21 +88,21 @@ $ pkg install rtv
### From source
```bash
$ git clone https://gitlab.com/ajak/rtv.git
$ cd rtv
$ git clone https://gitlab.com/ajak/tuir.git
$ cd tuir
$ python setup.py install
```
### Windows
RTV is not supported on Windows, due to a lack of resources and interest. Sorry!
TUIR is not supported on Windows, due to a lack of resources and interest. Sorry!
## Usage
To run the program, type:
```bash
$ rtv --help
$ tuir --help
```
### Controls
@@ -130,17 +130,17 @@ See [CONTROLS](CONTROLS.md) for the full list of commands.
### Configuration File
Configuration files are stored in the ``{HOME}/.config/rtv/`` directory.
Configuration files are stored in the ``{HOME}/.config/tuir/`` directory.
Check out [rtv.cfg](rtv/templates/rtv.cfg) for the full list of configurable options. You can clone this file into your home directory by running:
Check 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:
```bash
$ rtv --copy-config
$ tuir --copy-config
```
### Viewing Media Links
You can use [mailcap](https://en.wikipedia.org/wiki/Media_type#Mailcap) to configure how RTV will open different types of links.
You can use [mailcap](https://en.wikipedia.org/wiki/Media_type#Mailcap) to configure how TUIR will open different types of links.
<p align="center">
<img alt="title image" src="resources/mailcap.gif"/>
@@ -149,30 +149,30 @@ You can use [mailcap](https://en.wikipedia.org/wiki/Media_type#Mailcap) to confi
A 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.
```bash
$ rtv --copy-mailcap
$ tuir --copy-mailcap
```
This 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](rtv/templates/mailcap) listed inside.
This 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.
Once you've setup your mailcap file, enable it by launching rtv with the ``rtv --enable-media`` flag (or set it in your **rtv.cfg**)
Once you've setup your mailcap file, enable it by launching tuir with the ``tuir --enable-media`` flag (or set it in your **tuir.cfg**)
### Environment Variables
The default programs that RTV interacts with can be configured through environment variables:
The default programs that TUIR interacts with can be configured through environment variables:
<table>
<tr>
<td><strong>$RTV_EDITOR</strong></td>
<td><strong>$TUIR_EDITOR</strong></td>
<td>A program used to compose text submissions and comments, e.g. <strong>vim</strong>, <strong>emacs</strong>, <strong>gedit</strong>
<br/> <em>If not specified, will fallback to $VISUAL and $EDITOR in that order.</em></td>
</tr>
<tr>
<td><strong>$RTV_BROWSER</strong></td>
<td><strong>$TUIR_BROWSER</strong></td>
<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>
<br/> <em>If not specified, will fallback to $BROWSER, or your system's default browser.</em></td>
</tr>
<tr>
<td><strong>$RTV_URLVIEWER</strong></td>
<td><strong>$TUIR_URLVIEWER</strong></td>
<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>
<br/> <em>If not specified, will fallback to urlview if it is installed.</em></td>
</tr>
@@ -180,12 +180,12 @@ The default programs that RTV interacts with can be configured through environme
### Clipboard
RTV supports copying submission links to the OS clipboard. On macOS this is supported out of the box.
TUIR supports copying submission links to the OS clipboard. On macOS this is supported out of the box.
On Linux systems you will need to install either [xsel](http://www.vergenet.net/~conrad/software/xsel/) or [xclip](https://sourceforge.net/projects/xclip/).
## Themes
Themes can be used to customize the look and feel of RTV
Themes can be used to customize the look and feel of TUIR
<table>
<tr>
@@ -210,24 +210,24 @@ Themes can be used to customize the look and feel of RTV
</tr>
</table>
You can list all installed themes with the ``--list-themes`` command, and select one with ``--theme``. You can save your choice permanently in your [rtv.cfg](rtv/templates/rtv.cfg) file. You can also use the <kbd>F2</kbd> & <kbd>F3</kbd> keys inside of RTV to cycle through all available themes.
You 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.
For instructions on writing and installing your own themes, see [THEMES.md](THEMES.md).
## FAQ
<details>
<summary>Why am I getting an error during installation/when launching rtv?</summary>
<summary>Why am I getting an error during installation/when launching tuir?</summary>
> If your distro ships with an older version of python 2.7 or python-requests,
> you may experience SSL errors or other package incompatibilities. The
> easiest way to fix this is to install rtv using python 3. If you
> easiest way to fix this is to install tuir using python 3. If you
> don't already have pip3, see http://stackoverflow.com/a/6587528 for setup
> instructions. Then do
>
> ```bash
> $ sudo pip uninstall rtv
> $ sudo pip3 install -U rtv
> $ sudo pip uninstall tuir
> $ sudo pip3 install -U tuir
> ```
</details>
@@ -237,7 +237,7 @@ For instructions on writing and installing your own themes, see [THEMES.md](THEM
> This type of text usually shows up when python is unable to render
> unicode properly.
>
> 1. Try starting RTV in ascii-only mode with ``rtv --ascii``
> 1. Try starting TUIR in ascii-only mode with ``tuir --ascii``
> 2. Make sure that the terminal/font that you're using supports unicode
> 3. Try [setting the LOCALE to utf-8](https://perlgeek.de/en/article/set-up-a-clean-utf8-environment)
> 4. Your python may have been built against the wrong curses library,
@@ -250,11 +250,11 @@ For instructions on writing and installing your own themes, see [THEMES.md](THEM
> This project is structured to be run as a python *module*. This means that
> you need to launch it using python's ``-m`` flag. See the example below, which
> assumes that you have cloned the repository into the directory **~/rtv_project**.
> assumes that you have cloned the repository into the directory **~/tuir_project**.
>
> ```bash
> $ cd ~/rtv_project
> $ python3 -m rtv
> $ cd ~/tuir_project
> $ python3 -m tuir
> ```
</details>
@@ -266,4 +266,3 @@ Before writing any code, please read the [Contributor Guidelines](CONTRIBUTING.r
## License
This project is distributed under the [MIT](LICENSE) license.