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

Merge branch 'master' of https://github.com/Brobin/rtv into Brobin-master

Browse Source
This commit is contained in:
Michael Lazar
2015-04-06 00:03:56 -07:00
parent f9f955deb0 161fe186dd
commit 2d0717192c
3 changed files with 157 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
CHANGELOG.rst Normal file
View File

@@ -0,0 +1,40 @@
=============
RTV Changelog
=============
.. _1.2.1: http://github.com/michael-lazar/rtv/releases/tag/v1.2.1
.. _1.2: http://github.com/michael-lazar/rtv/releases/tag/v1.2
------
1.2.1_
------
Bugfixes
* Fixed crashing on invalid subreddit names
----
1.2_
----
Features
* Added user login / logout with the `u` key.
* Added subreddit searching with the `f` key.
* Added submission posting with the `p` key.
* Added viewing of user submissions with `/r/me`.
* Program title now displays in the terminal window.
* Gold symbols now display on guilded comments and posts.
* Moved default config location to XDG_CONFIG_HOME.
Bugfixes
* Improved error handling for submission / comment posts.
* Fixed handling of unicode flairs.
* Improved displaying of the help message and selfposts on small terminal windows.
* The author's name now correctly highlights in submissions
* Corrected user agent formatting.
* Various minor bugfixes.
---
1.1
---
* Post comments using your text editor.

23
CONTRIBUTORS.rst Normal file
View File

@@ -0,0 +1,23 @@
================
RTV Contributors
================
Thanks to the following people for their contributions to this project.
* `michael-lazar <http://github.com/michael-lazar>`_
* `Tobin Brown <http://github.com/Brobin>`_
* `Yusuke Sakamoto <http://github.com/yskmt>`_
* `Noah Morrison <http://github.com/noahmorrison>`_
* `Toby Hughes <http://github.com/tobywhughes>`_
* `Shawn Hind <http://github.com/shanhind>`_
* `mekhami <http://github.com/mekhami>`_
* `JuanPablo <http://github.com/juanpabloaj>`_
* `Robert Greener <http://github.com/ragreener1>`_
* `Hans Roman <http://github.com/snahor>`_
* `peterpans01 <http://github.com/peterpans01>`_
* `Ram-Z <http://github.com/Ram-Z>`_
* `Marc Abramowitz <http://github.com/msabramo>`_
* `Adam Talsma <http://github.com/a-tal>`_
* `Wieland Hoffmann <http://github.com/mineo>`_
* `Thomas Kajder <http://github.com/tkajder>`_

155
README.rst
View File

@@ -1,32 +1,30 @@
.. image:: https://pypip.in/version/rtv/badge.svg?text=version&style=flat
:target: https://pypi.python.org/pypi/rtv/
:alt: Latest Version
.. image:: https://pypip.in/py_versions/rtv/badge.svg?style=flat ===========================
:target: https://pypi.python.org/pypi/rtv/ RTV: Reddit Terminal Viewer
:alt: Supported Python versions ===========================
====================== RTV is an application that allows you to view and interact with reddit from your terminal. It is compatible with *most* terminal emulators on Linux and OSX.
Reddit Terminal Viewer
======================
Browse Reddit from your terminal
.. image:: http://i.imgur.com/W1hxqCt.png .. image:: http://i.imgur.com/W1hxqCt.png
RTV is built in **python** using the **curses** library, and is compatible with *most* terminal emulators on Linux and OS X. RTV is built in **python** using the **curses** library.
------------- ---------------
Update (v1.1)
-------------
Users can now post comments! |pypi| |python|
.. image:: http://i.imgur.com/twls7iM.png ---------------
------------ * `Installation`_
* `Configuration`_
* `Usage`_
* `Changelog`_
* `Contributors`_
* `License`_
============
Installation Installation
------------ ============
Install using pip Install using pip
@@ -49,50 +47,10 @@ The installation will place a script in the system path
$ rtv $ rtv
$ rtv --help $ rtv --help
-----
Usage
-----
RTV currently supports browsing both subreddits and individual submissions. In each mode the controls are slightly different. =============
**Global Commands**
:``▲``/``▼`` or ``j``/``k``: Scroll to the prev/next item
:``a``/``z``: Upvote/downvote the selected item
:``ENTER`` or ``o``: Open the selected item in the default web browser
:``r``: Refresh the current page
:``u``: Login and logout of your user account
:``?``: Show the help screen
:``q``: Quit
**Subreddit Mode**
In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit.
:``►`` or ``l``: View comments for the selected submission
:``/``: Open a prompt to switch subreddits
:``f``: Open a prompt to search the current subreddit
:``p``: Post a new submission to the current subreddit
The ``/`` prompt accepts subreddits in the following formats
* ``/r/python``
* ``/r/python/new``
* ``/r/python+linux`` supports multireddits
* ``/r/front`` will redirect to the front page
* ``/r/me`` will display your submissions
**Submission Mode**
In submission mode you can view the self text for a submission and browse comments.
:``◄`` or ``h``: Return to subreddit mode
:``►`` or ``l``: Fold the selected comment, or load additional comments
:``c``: Post a new comment on the selected item
-------------
Configuration Configuration
------------- =============
RTV will read a configuration file located at ``$XDG_CONFIG_HOME/rtv/rtv.cfg`` or ``~/.config/rtv/rtv.cfg`` if ``$XDG_CONFIG_HOME`` is not set. RTV will read a configuration file located at ``$XDG_CONFIG_HOME/rtv/rtv.cfg`` or ``~/.config/rtv/rtv.cfg`` if ``$XDG_CONFIG_HOME`` is not set.
This can be used to avoid having to re-enter login credentials every time the program is launched. This can be used to avoid having to re-enter login credentials every time the program is launched.
@@ -125,3 +83,78 @@ Set the environment variable ``RTV_EDITOR`` to specify which editor the program
.. code-block:: bash .. code-block:: bash
$ export RTV_EDITOR=gedit $ export RTV_EDITOR=gedit
=====
Usage
=====
RTV currently supports browsing both subreddits and individual submissions. In each mode the controls are slightly different.
---------------
Global Commands
---------------
:``▲``/``▼`` or ``j``/``k``: Scroll to the prev/next item
:``a``/``z``: Upvote/downvote the selected item
:``ENTER`` or ``o``: Open the selected item in the default web browser
:``r``: Refresh the current page
:``u``: Login and logout of your user account
:``?``: Show the help screen
:``q``: Quit
--------------
Subreddit Mode
--------------
In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit.
:``►`` or ``l``: View comments for the selected submission
:``/``: Open a prompt to switch subreddits
:``f``: Open a prompt to search the current subreddit
:``p``: Post a new submission to the current subreddit
The ``/`` prompt accepts subreddits in the following formats
* ``/r/python``
* ``/r/python/new``
* ``/r/python+linux`` supports multireddits
* ``/r/front`` will redirect to the front page
* ``/r/me`` will display your submissions
---------------
Submission Mode
---------------
In submission mode you can view the self text for a submission and browse comments.
:``◄`` or ``h``: Return to subreddit mode
:``►`` or ``l``: Fold the selected comment, or load additional comments
:``c``: Post a new comment on the selected item
=========
Changelog
=========
Please see `CHANGELOG.rst <https://github.com/michael-lazar/rtv/blob/master/CHANGELOG.rst>`_.
============
Contributors
============
Please see `CONTRIBUTORS.rst <https://github.com/michael-lazar/rtv/blob/master/CONTRIBUTORS.rst>`_.
=======
License
=======
Please see `LICENSE <https://github.com/michael-lazar/rtv/blob/master/LICENSE>`_.
.. |python| image:: https://pypip.in/py_versions/rtv/badge.svg?style=flat
:target: https://pypi.python.org/pypi/rtv/
:alt: Supported Python versions
.. |pypi| image:: https://pypip.in/version/rtv/badge.svg?text=version&style=flat
:target: https://pypi.python.org/pypi/rtv/
:alt: Latest Version