You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

PKG-INFO 6.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
  1. Metadata-Version: 1.1
  2. Name: rtv
  3. Version: 1.2.2
  4. Summary: A simple terminal viewer for Reddit (Reddit Terminal Viewer)
  5. Home-page: https://github.com/michael-lazar/rtv
  6. Author: Michael Lazar
  7. Author-email: lazar.michael22@gmail.com
  8. License: MIT
  9. Description:
  10. ===========================
  11. RTV: Reddit Terminal Viewer
  12. ===========================
  13. 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.
  14. .. image:: http://i.imgur.com/W1hxqCt.png
  15. RTV is built in **python** using the **curses** library.
  16. ---------------
  17. |pypi| |python| |downloads|
  18. ---------------
  19. * `Installation`_
  20. * `Configuration`_
  21. * `Usage`_
  22. * `Changelog`_
  23. * `Contributors`_
  24. * `License`_
  25. ============
  26. Installation
  27. ============
  28. Install using pip
  29. .. code-block:: bash
  30. $ sudo pip install rtv
  31. Or clone the repository
  32. .. code-block:: bash
  33. $ git clone https://github.com/michael-lazar/rtv.git
  34. $ cd rtv
  35. $ sudo python setup.py install
  36. The installation will place a script in the system path
  37. .. code-block:: bash
  38. $ rtv
  39. $ rtv --help
  40. =============
  41. Configuration
  42. =============
  43. 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.
  44. This can be used to avoid having to re-enter login credentials every time the program is launched.
  45. Each line in the file will replace the corresponding default argument in the launch script.
  46. Example config:
  47. .. code-block:: ini
  48. [rtv]
  49. username=MyUsername
  50. password=MySecretPassword
  51. # Log file location
  52. log=/tmp/rtv.log
  53. # Default subreddit
  54. subreddit=CollegeBasketball
  55. # Default submission link - will be opened every time the program starts
  56. # link=http://www.reddit.com/r/CollegeBasketball/comments/31irjq
  57. # Enable unicode characters (experimental)
  58. # This is known to be unstable with east asian wide character sets
  59. # unicode=true
  60. RTV allows users to compose comments and replys using their preferred text editor (**vi**, **nano**, **gedit**, etc).
  61. Set the environment variable ``RTV_EDITOR`` to specify which editor the program should use.
  62. .. code-block:: bash
  63. $ export RTV_EDITOR=gedit
  64. =====
  65. Usage
  66. =====
  67. RTV currently supports browsing both subreddits and individual submissions. In each mode the controls are slightly different.
  68. ---------------
  69. Global Commands
  70. ---------------
  71. :``▲``/``▼`` or ``j``/``k``: Scroll to the prev/next item
  72. :``a``/``z``: Upvote/downvote the selected item
  73. :``ENTER`` or ``o``: Open the selected item in the default web browser
  74. :``r``: Refresh the current page
  75. :``u``: Login and logout of your user account
  76. :``?``: Show the help screen
  77. :``q``: Quit
  78. --------------
  79. Subreddit Mode
  80. --------------
  81. In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit.
  82. :``►`` or ``l``: View comments for the selected submission
  83. :``/``: Open a prompt to switch subreddits
  84. :``f``: Open a prompt to search the current subreddit
  85. :``p``: Post a new submission to the current subreddit
  86. The ``/`` prompt accepts subreddits in the following formats
  87. * ``/r/python``
  88. * ``/r/python/new``
  89. * ``/r/python+linux`` supports multireddits
  90. * ``/r/front`` will redirect to the front page
  91. * ``/r/me`` will display your submissions
  92. ---------------
  93. Submission Mode
  94. ---------------
  95. In submission mode you can view the self text for a submission and browse comments.
  96. :``◄`` or ``h``: Return to subreddit mode
  97. :``►`` or ``l``: Fold the selected comment, or load additional comments
  98. :``c``: Post a new comment on the selected item
  99. =========
  100. Changelog
  101. =========
  102. Please see `CHANGELOG.rst <https://github.com/michael-lazar/rtv/blob/master/CHANGELOG.rst>`_.
  103. ============
  104. Contributors
  105. ============
  106. Please see `CONTRIBUTORS.rst <https://github.com/michael-lazar/rtv/blob/master/CONTRIBUTORS.rst>`_.
  107. =======
  108. License
  109. =======
  110. Please see `LICENSE <https://github.com/michael-lazar/rtv/blob/master/LICENSE>`_.
  111. .. |python| image:: https://pypip.in/py_versions/rtv/badge.svg?style=flat-square
  112. :target: https://pypi.python.org/pypi/rtv/
  113. :alt: Supported Python versions
  114. .. |pypi| image:: https://pypip.in/version/rtv/badge.svg?text=version&style=flat-square
  115. :target: https://pypi.python.org/pypi/rtv/
  116. :alt: Latest Version
  117. .. |downloads| image:: https://pypip.in/download/rtv/badge.svg?period=month&style=flat-square
  118. :target: https://pypi.python.org/pypi/rtv/
  119. :alt: Downloads
  120. Keywords: reddit terminal praw curses
  121. Platform: UNKNOWN
  122. Classifier: Intended Audience :: End Users/Desktop
  123. Classifier: Environment :: Console :: Curses
  124. Classifier: Operating System :: MacOS :: MacOS X
  125. Classifier: Operating System :: POSIX
  126. Classifier: Natural Language :: English
  127. Classifier: Programming Language :: Python :: 2.7
  128. Classifier: Programming Language :: Python :: 3.4
  129. Classifier: Programming Language :: Python :: 3
  130. Classifier: Topic :: Terminals
  131. Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Message Boards
  132. Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: News/Diary