toxinu / Pyhn
Licence: mit
Hacker news command line client
Stars: ✭ 386
Programming Languages
python
139335 projects - #7 most used programming language
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
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].