# OSHit -- Get your hit of the Orange Site in the terminal
## Introduction
OSHit is a read-only terminal-based client for HackerNews. It provides the
ability to view all the top/recent items in the major categories, as well as
allowing viewing comments and user details. Where relevant, bindings are
always available to open the relevant view on HackerNews itself in your web
browser.
Please note that this client *isn't* designed to allow reading any and all
stories on HackerNews, it's about reading what's current "hot" or new,
within the categories provided by [their
API](https://github.com/HackerNews/API).
## Installing
### pipx
The package can be installed using [`pipx`](https://pypa.github.io/pipx/):
```sh
$ pipx install oshit
```
### Homebrew
The package can be installed using Homebrew. Use the following commands to
install:
```sh
$ brew tap davep/homebrew
$ brew install oshit
```
## Running
Once installed run the `oshit` command.
## Main features
When run up the opening display is a list of items, the initial list being
the current top stories and jobs on HackerNews. Other lists available, via
shortcut keys or via tabs at the top of the screen, are "New", "Best",
"Ask", "Show" and "Jobs".
Pressing <kbd>u</kbd> when viewing a job or a comment will open a dialog
that shows the details of the user who posted the item.
When viewing a story or job and pressing <kbd>c</kbd> a dialog will open
that will let you view and navigate its comments.
## Tweaking
Because of the nature of the HackerNews API there might be a need for you to
dial in the ideal number of concurrent connections made to load up the data,
and also the timeout for the connections. As of the time of writing the
defaults are 50 concurrent connections and a timeout of 20 seconds.
If you run into problems press <kbd>F11</kbd> and tweak the maximum
concurrency and connection timeout values to taste (or look in
`~/.config/oshit/configuration.json` and change the `"maximum_concurrency"`
and `"connection_timeout"` values).
## Getting help
If you need help, or have any ideas, please feel free to [raise an
issue](https://github.com/davep/oshit/issues) or [start a
discussion](https://github.com/davep/oshit/discussions).
## TODO
Things I'm considering adding or addressing:
- [X] Chill out on item loading (see [#2](https://github.com/davep/oshit/issues/2))
- [ ] Add a configuration dialog for the connection value tweaks.
- [ ] Some degree of caching of items to reduce API hits.
- [ ] Expand the text-cleaning code to handle links, etc.
- [ ] Look at some "markup" of comments, eg: make quoted text more obvious.
- [ ] Add searching
- [X] Amongst the current view
- [ ] Amongst loaded comments within comment view
- [ ] All of history ([`hn.algolia.com`](https://hn.algolia.com/api))
[//]: # (README.md ends here)
Raw data
{
"_id": null,
"home_page": "https://github.com/davep/oshit",
"name": "oshit",
"maintainer": "Dave Pearson",
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": "davep@davep.org",
"keywords": "terminal",
"author": "Dave Pearson",
"author_email": "davep@davep.org",
"download_url": "https://files.pythonhosted.org/packages/cc/e4/a53a244655b68bdd073d5fd517373a67e9b9642cd15bb5fbf10e48344d38/oshit-0.12.4.tar.gz",
"platform": null,
"description": "# OSHit -- Get your hit of the Orange Site in the terminal\n\n## Introduction\n\nOSHit is a read-only terminal-based client for HackerNews. It provides the\nability to view all the top/recent items in the major categories, as well as\nallowing viewing comments and user details. Where relevant, bindings are\nalways available to open the relevant view on HackerNews itself in your web\nbrowser.\n\nPlease note that this client *isn't* designed to allow reading any and all\nstories on HackerNews, it's about reading what's current \"hot\" or new,\nwithin the categories provided by [their\nAPI](https://github.com/HackerNews/API).\n\n## Installing\n\n### pipx\n\nThe package can be installed using [`pipx`](https://pypa.github.io/pipx/):\n\n```sh\n$ pipx install oshit\n```\n\n### Homebrew\n\nThe package can be installed using Homebrew. Use the following commands to\ninstall:\n\n```sh\n$ brew tap davep/homebrew\n$ brew install oshit\n```\n\n## Running\n\nOnce installed run the `oshit` command.\n\n## Main features\n\nWhen run up the opening display is a list of items, the initial list being\nthe current top stories and jobs on HackerNews. Other lists available, via\nshortcut keys or via tabs at the top of the screen, are \"New\", \"Best\",\n\"Ask\", \"Show\" and \"Jobs\".\n\n\n\nPressing <kbd>u</kbd> when viewing a job or a comment will open a dialog\nthat shows the details of the user who posted the item.\n\n\n\nWhen viewing a story or job and pressing <kbd>c</kbd> a dialog will open\nthat will let you view and navigate its comments.\n\n\n\n## Tweaking\n\nBecause of the nature of the HackerNews API there might be a need for you to\ndial in the ideal number of concurrent connections made to load up the data,\nand also the timeout for the connections. As of the time of writing the\ndefaults are 50 concurrent connections and a timeout of 20 seconds.\n\nIf you run into problems press <kbd>F11</kbd> and tweak the maximum\nconcurrency and connection timeout values to taste (or look in\n`~/.config/oshit/configuration.json` and change the `\"maximum_concurrency\"`\nand `\"connection_timeout\"` values).\n\n## Getting help\n\nIf you need help, or have any ideas, please feel free to [raise an\nissue](https://github.com/davep/oshit/issues) or [start a\ndiscussion](https://github.com/davep/oshit/discussions).\n\n## TODO\n\nThings I'm considering adding or addressing:\n\n- [X] Chill out on item loading (see [#2](https://github.com/davep/oshit/issues/2))\n- [ ] Add a configuration dialog for the connection value tweaks.\n- [ ] Some degree of caching of items to reduce API hits.\n- [ ] Expand the text-cleaning code to handle links, etc.\n- [ ] Look at some \"markup\" of comments, eg: make quoted text more obvious.\n- [ ] Add searching\n - [X] Amongst the current view\n - [ ] Amongst loaded comments within comment view\n - [ ] All of history ([`hn.algolia.com`](https://hn.algolia.com/api))\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"summary": "A terminal-based HackerNews reader",
"version": "0.12.4",
"project_urls": {
"Discussions": "https://github.com/davep/oshit/discussions",
"Documentation": "https://github.com/davep/oshit/blob/main/README.md",
"Homepage": "https://github.com/davep/oshit",
"Issues": "https://github.com/davep/oshit/issues",
"Source": "https://github.com/davep/oshit"
},
"split_keywords": [
"terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fde0935616648bded3267e1cf7c6756f58649c184968c42939031f0efcd6a546",
"md5": "6f1308c53ca187f7eda636350b263b2c",
"sha256": "2669eace9459e4f9264b435c446efe8f2dee5a0a5c6cd7f831a7eb2a39c969ec"
},
"downloads": -1,
"filename": "oshit-0.12.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f1308c53ca187f7eda636350b263b2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 36702,
"upload_time": "2024-08-02T16:20:16",
"upload_time_iso_8601": "2024-08-02T16:20:16.860128Z",
"url": "https://files.pythonhosted.org/packages/fd/e0/935616648bded3267e1cf7c6756f58649c184968c42939031f0efcd6a546/oshit-0.12.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cce4a53a244655b68bdd073d5fd517373a67e9b9642cd15bb5fbf10e48344d38",
"md5": "78dcdb3e411be52d8f3948c4a66adae4",
"sha256": "d1f64893532f65643659c0f42840d2a64646e3f57e7397edcbc79c638b654fd5"
},
"downloads": -1,
"filename": "oshit-0.12.4.tar.gz",
"has_sig": false,
"md5_digest": "78dcdb3e411be52d8f3948c4a66adae4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 25872,
"upload_time": "2024-08-02T16:20:18",
"upload_time_iso_8601": "2024-08-02T16:20:18.482822Z",
"url": "https://files.pythonhosted.org/packages/cc/e4/a53a244655b68bdd073d5fd517373a67e9b9642cd15bb5fbf10e48344d38/oshit-0.12.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 16:20:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davep",
"github_project": "oshit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "oshit"
}
JSON
