Metadata-Version: 1.1
Name: pyhn
Version: 0.3.10
Summary: Hacker News in your terminal
Home-page: https://github.com/toxinu/pyhn/
Author: toxinu
Author-email: toxinu@gmail.com
License: The MIT License (MIT)

Copyright (c) 2015 toxinu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Description: Pyhn
        ====
        
        Hacker news in your terminal.
        
        .. image:: https://raw.github.com/socketubs/pyhn/master/screenshot.png
        
        Don't be worry about your IP. Pyhn is not aggressive, it uses cache.
        
        * ``Cache manager``
        * ``Customize all the colors``
        * ``Customize all the keybinds``
        * ``Default vim-like keybindings``
        * ``Compatible with Top, Ask, Show and Job stories``
        * ``Auto refresh support``
        * ``Play nice with tmux and screen (over ssh too!)``
        * ``Open storiers in your commandline web browser``
        * ``Mouse support``
        * ``Easily installable``
        * ``Easily hackable``
        * ``Ultra fast``
        * ``Python 2 and 3``
        * ``MIT license``
        
        Installation
        ------------
        
        Using pip: ::
        
        	pip install pyhn
        
        Run it: ::
        
        	pyhn
        
        Arch Linux
        ~~~~~~~~~~
        
        ``pyhn`` is available in the AUR_.
        
        Usage
        -----
        
        Use help for all key bindings:
        
        * **h**, **?**: Print help popup
        
        Configuration
        -------------
        
        By default, configuration file is in your ``$HOME/.pyhn/config``.
        You can set key bindings, colors and more.
        
        This is an example file: ::
        
          [keybindings]
          open_story_link = S,enter
          show_story_link = s
          open_comments_link = C
          show_comments_link = c
          open_user_link = U
          show_user_link = u
          up = j
          down = k
          page_up = ctrl d
          page_down = ctrl u
          first_story = g
          last_story = G
          refresh = r,R
          reload_config = ctrl r,ctrl R
        
          newest_stories = n
          top_stories = t
          best_stories = b
          show_stories = d
          show_newest_stories = D
          ask_stories = a
          jobs_stories = J
        
          [settings]
          cache = /home/socketubs/.pyhn/cache
          cache_age = 5
          # Refresh interval in minutes (default: 5. minimum: 1)
          refresh_interval = 5
          browser_cmd = __default__
        
          [colors]
          body = default|
          focus = white,bold|dark cyan
          footer = black|light gray
          footer-error = dark red,bold|light gray
          header = black,bold|light gray
          title = dark red,bold|light gray
          help = black,standout|dark cyan
        
        
        Settings
        ~~~~~~~~
        
        * ``cache_age`` is a minute indicator which say to ``CacheManager`` when cache is outdated
        * ``browser_cmd`` is a bash command which will be use to open links
        
        Examples: ::
        
          browser_cmd = lynx __url__
          browser_cmd = __default__
          browser_cmd = w3m __url__
          browser_cmd = echo "[INFO] Open with w3m: __url__" >> /tmp/pyhn.log && w3m __url__
        
        Key bindings
        ~~~~~~~~~~~~
        
        You can set different key bindings for same action with a comma separator.
        Take a look at ``urwid`` `input`_ manual.
        
        Colors
        ~~~~~~
        
        Colors options are designed like that: ``foreground|background|monochrome``.
        
        **foreground**
        
        * *colors*:  ‘default’ (use the terminal’s default foreground), ‘black’, ‘dark red’, ‘dark green’, ‘brown’, ‘dark blue’, ‘dark magenta’, ‘dark cyan’, ‘light gray’, ‘dark gray’, ‘light red’, ‘light green’, ‘yellow’, ‘light blue’, ‘light magenta’, ‘light cyan’, ‘white’
        * *settings*: ‘bold’, ‘underline’, ‘blink’, ‘standout’
        
        **background**
        
        * *colors*: ‘default’ (use the terminal’s default background), ‘black’, ‘dark red’, ‘dark green’, ‘brown’, ‘dark blue’, ‘dark magenta’, ‘dark cyan’, ‘light gray’
        
        **monochrome**
        
        * *settings* : ‘bold’, ‘underline’, ‘blink’, ‘standout’
        
        For more informations you can take a look at ``urwid`` `manual`_.
        
        License
        -------
        
        License is `MIT`_. See `LICENSE`_.
        
        .. _AUR: https://aur.archlinux.org/packages/pyhn/
        .. _input: http://excess.org/urwid/docs/manual/userinput.html#keyboard-input
        .. _manual: http://excess.org/urwid/docs/manual/displayattributes.html#foreground-and-background-settings
        .. _MIT: http://opensource.org/licenses/MIT
        .. _LICENSE: https://raw.github.com/socketubs/pyhn/master/LICENSE
        
Keywords: python hackernews hn terminal commandline
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
