# twitchez
<a href="https://betterttv.com/emotes/shared/search?query=hackermans">
<img src="https://cdn.betterttv.net/emote/5b490e73cf46791f8491f6f4/3x"
align="right" title="HACKERMANS" alt="The famous HACKERMANS twitch.tv emote"
style="width: 112px; height: 112px">
</a>
<a href="https://pypistats.org/packages/twitchez">
</a>
twitchez - TUI client for twitch.tv with thumbnails support that works right in your terminal.
Support of rendering images by the terminal is not required, ueberzugpp will handle that.\
You may ask -- **"Is this magic?"** -- Well **YES**, the black magic! Welcome to the club!
Since **v0.0.7** twitchez supports **ueberzugpp** -- this expands list of supported platforms:\
**linux / macOS / windows / freeBSD / X11 / Wayland /** any terminal with **SIXEL** support e.g.
[WezTerm](https://github.com/wez/wezterm)
### Leave a star to show interest in further development of the project ⭐️
### [CLICK TO WATCH DEMO VIDEO](https://user-images.githubusercontent.com/15724752/152787467-dc2a8871-43e5-4530-94b1-e14383c8b18e.mp4)
## Features
* Explore twitch without leaving your terminal
* Flexible configuration via user config (including custom cmd)
* Completely keyboard driven workflow
* Zero mouse interaction. `F1 / ?` for help about key mappings
* Redefine keys and hint chars for your keyboard layout
* Link hints similar as in (Vimium, Surfingkeys, etc.)
* Interactive select of one entry from all
([fzf](https://github.com/junegunn/fzf),
[dmenu](https://tools.suckless.org/dmenu/),
or any other program via custom cmd)
* Bookmarks & Tabs (add, delete, next/prev, jump to tab by name)
* Following live channels
* Streams per category
* Videos per channel (archive/past broadcasts, clips, highlights, uploads)
* Open video/stream url in external video player
([streamlink](https://github.com/streamlink/streamlink),
[mpv](https://github.com/mpv-player/mpv),
or any other program via custom cmd)
* Three independent user cmd and keys to open url as (stream, video, extra)
* Copy url to clipboard
* Open chat url in default browser or via custom cmd
* Thumbnails are drawn by the [ueberzugpp](https://github.com/jstkdng/ueberzugpp) (optional dependency)
## Configuration
Look inside `twitchez/config/` dir to see all available settings, those are defaults.\
**Do not change default config files**, create new in the user config dir: `config.conf`, `keys.conf`.\
The default user config dir is `$XDG_CONFIG_HOME/twitchez/`, or `$HOME/.config/twitchez/` by default.\
Settings from default config files are used as fallback for settings you haven't changed in your user config.
## Install
### Pip
Install [twitchez](https://pypi.org/project/twitchez/) via [pip](https://pip.pypa.io/en/stable/)
into user-wide environment:
```
$ pip3 install --user twitchez
```
or system-wide environment:
```
# pip3 install twitchez
```
To update, add the `--upgrade` or `-U` option.
#### Install ueberzugpp to display thumbnails (Optional)
If [ueberzugpp](https://github.com/jstkdng/ueberzugpp?tab=readme-ov-file#install)
is not installed **text mode without thumbnails** will be used.
You also can [build from source](https://github.com/jstkdng/ueberzugpp?tab=readme-ov-file#build-from-source)
and install **build dir** e.g. `# sudo cmake --install build`
## Troubleshooting
##### If you installed ueberzugpp but still not see thumbnails:
* override default ueberzugpp output **via twitchez user config** *(check **default.conf** it has example)*
* check available **output** options in **ueberzugpp** via `$ ueberzugpp layer --help`
* x11 and/or wayland (may not be available if disabled in compilation) -- build ueberzugpp from source
* if you want to draw via e.g. sixel, make sure that your terminal have such capability
* [WezTerm](https://github.com/wez/wezterm) has sixel support, try to launch twitchez in it
##### If thumbnails partially overlap underlying text (it is very font dependent):
* set width/height modifier in user config
* adjust your terminal font size by +1 etc
* try different terminal font
## License
[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)
Raw data
{
"_id": null,
"home_page": "https://github.com/WANDEX/twitchez",
"name": "twitchez",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "twitch TUI terminal curses ui client thumbnail image twitch.tv",
"author": "WANDEX",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/42/5c/70929cab9e505d3b92f8c31cc31e0f0225f235ff050936c2bd1a89ee9cb1/twitchez-0.1.0.tar.gz",
"platform": null,
"description": "# twitchez\n\n<a href=\"https://betterttv.com/emotes/shared/search?query=hackermans\">\n<img src=\"https://cdn.betterttv.net/emote/5b490e73cf46791f8491f6f4/3x\"\nalign=\"right\" title=\"HACKERMANS\" alt=\"The famous HACKERMANS twitch.tv emote\"\nstyle=\"width: 112px; height: 112px\">\n</a>\n\n\n\n\n<a href=\"https://pypistats.org/packages/twitchez\">\n\n</a>\n\ntwitchez - TUI client for twitch.tv with thumbnails support that works right in your terminal.\n\nSupport of rendering images by the terminal is not required, ueberzugpp will handle that.\\\nYou may ask -- **\"Is this magic?\"** -- Well **YES**, the black magic! Welcome to the club!\n\nSince **v0.0.7** twitchez supports **ueberzugpp** -- this expands list of supported platforms:\\\n**linux / macOS / windows / freeBSD / X11 / Wayland /** any terminal with **SIXEL** support e.g.\n[WezTerm](https://github.com/wez/wezterm)\n\n### Leave a star to show interest in further development of the project \u2b50\ufe0f\n\n### [CLICK TO WATCH DEMO VIDEO](https://user-images.githubusercontent.com/15724752/152787467-dc2a8871-43e5-4530-94b1-e14383c8b18e.mp4)\n\n## Features\n* Explore twitch without leaving your terminal\n* Flexible configuration via user config (including custom cmd)\n* Completely keyboard driven workflow\n * Zero mouse interaction. `F1 / ?` for help about key mappings\n * Redefine keys and hint chars for your keyboard layout\n * Link hints similar as in (Vimium, Surfingkeys, etc.)\n * Interactive select of one entry from all\n([fzf](https://github.com/junegunn/fzf),\n[dmenu](https://tools.suckless.org/dmenu/),\nor any other program via custom cmd)\n* Bookmarks & Tabs (add, delete, next/prev, jump to tab by name)\n * Following live channels\n * Streams per category\n * Videos per channel (archive/past broadcasts, clips, highlights, uploads)\n* Open video/stream url in external video player\n([streamlink](https://github.com/streamlink/streamlink),\n[mpv](https://github.com/mpv-player/mpv),\nor any other program via custom cmd)\n * Three independent user cmd and keys to open url as (stream, video, extra)\n * Copy url to clipboard\n * Open chat url in default browser or via custom cmd\n* Thumbnails are drawn by the [ueberzugpp](https://github.com/jstkdng/ueberzugpp) (optional dependency)\n\n## Configuration\nLook inside `twitchez/config/` dir to see all available settings, those are defaults.\\\n**Do not change default config files**, create new in the user config dir: `config.conf`, `keys.conf`.\\\nThe default user config dir is `$XDG_CONFIG_HOME/twitchez/`, or `$HOME/.config/twitchez/` by default.\\\nSettings from default config files are used as fallback for settings you haven't changed in your user config.\n\n## Install\n### Pip\nInstall [twitchez](https://pypi.org/project/twitchez/) via [pip](https://pip.pypa.io/en/stable/)\ninto user-wide environment:\n```\n$ pip3 install --user twitchez\n```\nor system-wide environment:\n```\n# pip3 install twitchez\n```\nTo update, add the `--upgrade` or `-U` option.\n\n#### Install ueberzugpp to display thumbnails (Optional)\nIf [ueberzugpp](https://github.com/jstkdng/ueberzugpp?tab=readme-ov-file#install)\nis not installed **text mode without thumbnails** will be used.\n\nYou also can [build from source](https://github.com/jstkdng/ueberzugpp?tab=readme-ov-file#build-from-source)\nand install **build dir** e.g. `# sudo cmake --install build`\n\n## Troubleshooting\n##### If you installed ueberzugpp but still not see thumbnails:\n* override default ueberzugpp output **via twitchez user config** *(check **default.conf** it has example)*\n* check available **output** options in **ueberzugpp** via `$ ueberzugpp layer --help`\n* x11 and/or wayland (may not be available if disabled in compilation) -- build ueberzugpp from source\n* if you want to draw via e.g. sixel, make sure that your terminal have such capability\n* [WezTerm](https://github.com/wez/wezterm) has sixel support, try to launch twitchez in it\n\n##### If thumbnails partially overlap underlying text (it is very font dependent):\n* set width/height modifier in user config\n* adjust your terminal font size by +1 etc\n* try different terminal font\n\n## License\n[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "twitchez - TUI client for twitch.tv with thumbnails support that works right in your terminal",
"version": "0.1.0",
"project_urls": {
"Bug Reports": "https://github.com/WANDEX/twitchez/issues",
"Homepage": "https://github.com/WANDEX/twitchez",
"Source": "https://github.com/WANDEX/twitchez"
},
"split_keywords": [
"twitch",
"tui",
"terminal",
"curses",
"ui",
"client",
"thumbnail",
"image",
"twitch.tv"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6285cc56d43db2d666b7f8b4c79198c7d392a50bc6887cb8b7e54ab8e1a6596",
"md5": "b90064826457174e21fbb574c17eaf2c",
"sha256": "03395321632b5dcab72f478c83878b41e04b76c539c18247f566cb278ee0c92e"
},
"downloads": -1,
"filename": "twitchez-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b90064826457174e21fbb574c17eaf2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 57789,
"upload_time": "2024-10-05T20:23:13",
"upload_time_iso_8601": "2024-10-05T20:23:13.058633Z",
"url": "https://files.pythonhosted.org/packages/b6/28/5cc56d43db2d666b7f8b4c79198c7d392a50bc6887cb8b7e54ab8e1a6596/twitchez-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "425c70929cab9e505d3b92f8c31cc31e0f0225f235ff050936c2bd1a89ee9cb1",
"md5": "1e9ee2e2ee7b74fdd856f5b92549084e",
"sha256": "5ad1d5c9a54654e412a2e3ddd926eaba54586fd5312178d2426dbec8fe887b86"
},
"downloads": -1,
"filename": "twitchez-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1e9ee2e2ee7b74fdd856f5b92549084e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 52412,
"upload_time": "2024-10-05T20:23:15",
"upload_time_iso_8601": "2024-10-05T20:23:15.036422Z",
"url": "https://files.pythonhosted.org/packages/42/5c/70929cab9e505d3b92f8c31cc31e0f0225f235ff050936c2bd1a89ee9cb1/twitchez-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-05 20:23:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WANDEX",
"github_project": "twitchez",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "twitchez"
}
JSON
