| Name | gucken JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | Gucken is a Terminal User Interface which allows you to browse and watch your favorite anime's with style. |
| upload_time | 2024-06-12 18:12:32 |
| maintainer | Commandcracker |
| docs_url | None |
| author | Commandcracker |
| requires_python | None |
| license | MIT License Copyright (c) 2024 Commandcracker 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. |
| keywords |
anime
gucken
serien
series
tui
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Gucken
Project state: **Pre-Alpha**
## Description
Gucken is a Terminal User Interface which allows you to browse and watch your favorite anime's with style.
## Usage
<img alt="Search" src="https://github.com/Commandcracker/gucken/assets/49335821/d91de2af-c086-485c-8aec-1e68cdb02aa3"/>
<img alt="Watch" src="https://github.com/Commandcracker/gucken/assets/49335821/7354eeff-bd97-4226-91b9-317939128a81"/>
## Installation
<details><summary><b>Windows</b></summary>
Install [Python] and if you are **on Windows 10** [Windows Terminal] for a better experience.
```
pip install gucken
gucken
```
</details>
<details><summary><b>Linux</b></summary>
Install [Python] and then
```
pip install gucken
gucken
```
</details>
<details><summary><b>Android</b></summary>
Install [Termux](https://termux.dev/en/) and run:
```
yes|pkg update
pkg install python ffmpeg -y
pip install gucken
gucken
```
#### Shortcut
Install [Termux:Widget](https://github.com/termux/termux-widget?tab=readme-ov-file#Installation).
```
mkdir ~/.shortcuts
```
##### Lunch shortcut
```
echo gucken>~/.shortcuts/Gucken
```
##### Update shortcut
```
echo pip install -U gucken>~/.shortcuts/Update\ Gucken
```
#### Custom Font
If you want a custom font then just pace the ttf in `~/.termux/font.ttf`. Recommended fonts: [Nerd fonts](https://www.nerdfonts.com/font-downloads) (**Only use Mono fonts!**)
#### Downloads
Setup storage for downloads. (Default download location: `/data/data/com.termux/files/home/storage/movies`)
```
termux-setup-storage
```
</details>
## Features
- [x] Update checker
- [x] Language priority list
- [x] Hoster priority list
- [x] Automatically use working hoster
- [x] Browsing
- [x] Descriptions
- [x] Watching
- [ ] Trailer
- [x] Automatically start next episode
- [x] Discord Presence **Very WIP**
- [MPV] only
- [X] [ani-skip](https://github.com/synacktraa/ani-skip) support
- [x] [Syncplay](https://github.com/Syncplay/syncplay) support (almost out of WIP)
- [ ] Remember watch time **WIP**
- [ ] Remember completed Episodes (and series)
- [ ] Tracker support
- [ ] [MyAnimeList](https://myanimelist.net/)
- [ ] [AniList](https://anilist.co/)
- [ ] [AniWorld.to] & [SerienStream.to]
- [ ] Downloading
- [ ] Watch from download
## Provider
List of supported Anime sites
- [x] [AniWorld.to] & [SerienStream.to]
- [ ] Filme
- [ ] [bs.to](https://bs.to/)
- [ ] [www3.streamcloud.info](https://www3.streamcloud.info/)
- [ ] [www.crunchyroll.com](https://www.crunchyroll.com)
- [ ] Add some from [International Piracy Sites German](https://fmhy.net/non-english#german-deutsch)
## Hoster
List of supported video hoster.
- [x] Streamtape
- [x] VEO
- [x] Vidoza
- [x] Doodstream
## Player
List of supported video players
- [x] [MPV] (most features, recommended)
- [x] [VLC]
- [x] [ffplay](https://www.ffmpeg.org/ffplay.html)
- [ ] Custom
- Windows
- [x] [mpv.net](https://github.com/mpvnet-player/mpv.net)
- [x] wmplayer.exe (fallback on Windows)
- Android
- [x] [mpv-android](https://github.com/mpv-android/mpv-android)
- [x] [VLC]
- [x] Choose
- Linux (Flatpack)
- [x] [MPV](https://flathub.org/apps/io.mpv.Mpv)
- [x] [VLC](https://flathub.org/apps/org.videolan.VLC)
- [x] [Celluloid](https://flathub.org/apps/io.github.celluloid_player.Celluloid)
- Linux
- [x] [Celluloid](https://celluloid-player.github.io/)
- MacOS
- [ ] [IINA](https://iina.io/)
## Custom CSS
**For power users only**
Place your custom CSS in `user_config_path("gucken").joinpath("custom.css")` and it will be automatically loaded by Gucken.
- [Textual CSS Guide](https://textual.textualize.io/guide/CSS/)
- [Textual CSS Reference](https://textual.textualize.io/css_types/)
## Optional dependencies
- `speedups` (with: `gucken[speedups]`)
- Faster fuzzy sort/search. (`levenshtein`)
- Faster json parsing. (`orjson`)
- `socks` - SOCKS proxy support. (with: `gucken[socks]`)
## Todo
### Privacy
- [ ] Proxy support
```
Proxies can easiely be implented
for the http client in python
AsyncClient(proxy="http://...")
for the player mpv Note: mpv dos not support socks5
--http-proxy=<proxy>
FFmpeg: env.http_proxy
ytdl: --ytdl-raw-options=proxy=
yt-dlp
--proxy URL
```
- [ ] [Tor](https://www.torproject.org/) as proxy
```
AniWorld.to need Cloudflare captcha and JS challange
SerienStream.to can be bypassed by using diract ip
Cloudflare captcha and JS challange can be solved by using something like
selenium or playwright
```
- [ ] DoH support
- [ ] Reverse proxy for player
- [ ] DoH
- [ ] proxy
### UX
- [ ] Add hotkey to clear cache (F5)
- [ ] Translation DE, EN
- [ ] Improve settings design
- [ ] Merge SerienStream.to and AniWorld.to search results
- [ ] Focus window on autoplay popup
- [ ] Utilize next and previous buttons in mpv
- [ ] Chapters for VLC
- [ ] Window in settings menu to show where files are located (data, logs, config, downloads)
- [ ] s.to, aniworld.to scrape episode description
- [ ] Search in episodes
- [ ] Next and Cancel hotkeys
- [ ] Show hotkeys in Footer
- [ ] Create shortcut Windows & Linux
- [ ] Installation helper
- [ ] [MPV]
- [ ] [Anime4k]
- [ ] [VLC]
- [ ] Colors themes
### Speedups
- [ ] Pre-fetching
- [ ] More threads and asyncio.gather to make everything faster
- [ ] More Caching
- [ ] Reuse Client
### Code
- [ ] Do unescape and stripe only on render
- [ ] Dont coppy code from SerienStream.to to AniWorld.to
- [ ] BIG CODE CLEANUP
### Features
- [ ] Update checker option to perform update
- [ ] Watchlist
- [ ] New anime/series Notifications
- [ ] Image preview (Kitty protocol, iterm protocol, Sixel, textual-web)
- [ ] Use something like opencv to time match a sub from aniworld with a high quality video form another site.
- [ ] Nix package
- [ ] Docker image
- [ ] Flatpack package
- [ ] Detect existing chapters and use them for skip
- [ ] Reverse proxy for players that do not support headers
- [ ] Up-scaling (after download)
- [ ] [video2x](https://github.com/k4yt3x/video2x)
- [ ] [waifu2x](https://github.com/nagadomi/waifu2x)
- [ ] [Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN)
- [ ] [FSRCNN](https://github.com/igv/FSRCNN-TensorFlow)
- [ ] [Anime4k]
- [ ] Modular (Custom extractors/players, open API)
- [ ] More CLI args
- [ ] [MPV] Screen selection
- [ ] Custom player args
- [ ] Custom player
- [ ] [Anime4k] options
#### Support
- [ ] Mac support
- [ ] IOS support
- [ ] Support textual-web
- [ ] Syncplay on Android
- [ ] Improve Flatpack support
- [ ] Improve Snap support
### Bugs & DX
- [ ] Proper error handling
- [ ] Logging and Crash reports
- [ ] Blacklist detection & bypass
- [ ] 404 detection inside Hoster and don't crash whole program on http error + crash reports/logs
- [ ] CI Testing (Windows, Linux)
[Anime4k]: https://github.com/bloc97/Anime4K
[MPV]: https://mpv.io/
[VLC]: https://www.videolan.org/vlc/
[AniWorld.to]: https://aniworld.to
[SerienStream.to]: https://186.2.175.5
[Python]: https://www.python.org/downloads/
[Windows Terminal]: https://apps.microsoft.com/detail/9n0dx20hk701
Raw data
{
"_id": null,
"home_page": null,
"name": "gucken",
"maintainer": "Commandcracker",
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "anime, gucken, serien, series, tui",
"author": "Commandcracker",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/bb/e2/5c3828f3301c9d1b97832c1d4f1296df42ed9e82e555394fcb1f16c5a9e6/gucken-0.2.3.tar.gz",
"platform": null,
"description": "# Gucken\n\nProject state: **Pre-Alpha**\n\n## Description\n\nGucken is a Terminal User Interface which allows you to browse and watch your favorite anime's with style. \n\n## Usage\n\n<img alt=\"Search\" src=\"https://github.com/Commandcracker/gucken/assets/49335821/d91de2af-c086-485c-8aec-1e68cdb02aa3\"/>\n<img alt=\"Watch\" src=\"https://github.com/Commandcracker/gucken/assets/49335821/7354eeff-bd97-4226-91b9-317939128a81\"/> \n\n## Installation\n\n<details><summary><b>Windows</b></summary>\n\nInstall [Python] and if you are **on Windows 10** [Windows Terminal] for a better experience.\n\n```\npip install gucken\ngucken\n```\n\n</details>\n\n<details><summary><b>Linux</b></summary>\n\nInstall [Python] and then\n\n```\npip install gucken\ngucken\n```\n\n</details>\n\n<details><summary><b>Android</b></summary>\n\nInstall [Termux](https://termux.dev/en/) and run:\n\n```\nyes|pkg update\npkg install python ffmpeg -y\npip install gucken\ngucken\n```\n\n#### Shortcut\n\nInstall [Termux:Widget](https://github.com/termux/termux-widget?tab=readme-ov-file#Installation).\n\n```\nmkdir ~/.shortcuts\n```\n\n##### Lunch shortcut\n\n```\necho gucken>~/.shortcuts/Gucken\n```\n\n##### Update shortcut\n\n```\necho pip install -U gucken>~/.shortcuts/Update\\ Gucken\n```\n\n#### Custom Font\n\nIf you want a custom font then just pace the ttf in `~/.termux/font.ttf`. Recommended fonts: [Nerd fonts](https://www.nerdfonts.com/font-downloads) (**Only use Mono fonts!**)\n\n#### Downloads\n\nSetup storage for downloads. (Default download location: `/data/data/com.termux/files/home/storage/movies`)\n\n```\ntermux-setup-storage\n```\n\n</details>\n\n## Features\n\n- [x] Update checker\n- [x] Language priority list\n- [x] Hoster priority list\n- [x] Automatically use working hoster\n- [x] Browsing\n - [x] Descriptions\n- [x] Watching\n - [ ] Trailer\n - [x] Automatically start next episode\n - [x] Discord Presence **Very WIP**\n - [MPV] only\n - [X] [ani-skip](https://github.com/synacktraa/ani-skip) support\n - [x] [Syncplay](https://github.com/Syncplay/syncplay) support (almost out of WIP)\n - [ ] Remember watch time **WIP**\n - [ ] Remember completed Episodes (and series)\n - [ ] Tracker support\n - [ ] [MyAnimeList](https://myanimelist.net/)\n - [ ] [AniList](https://anilist.co/)\n - [ ] [AniWorld.to] & [SerienStream.to]\n- [ ] Downloading\n - [ ] Watch from download\n\n## Provider\n\nList of supported Anime sites\n\n- [x] [AniWorld.to] & [SerienStream.to]\n - [ ] Filme\n- [ ] [bs.to](https://bs.to/)\n- [ ] [www3.streamcloud.info](https://www3.streamcloud.info/)\n- [ ] [www.crunchyroll.com](https://www.crunchyroll.com)\n- [ ] Add some from [International Piracy Sites German](https://fmhy.net/non-english#german-deutsch)\n\n## Hoster\n\nList of supported video hoster.\n\n- [x] Streamtape\n- [x] VEO\n- [x] Vidoza\n- [x] Doodstream\n\n## Player\n\nList of supported video players\n\n- [x] [MPV] (most features, recommended)\n- [x] [VLC]\n- [x] [ffplay](https://www.ffmpeg.org/ffplay.html)\n- [ ] Custom\n- Windows\n - [x] [mpv.net](https://github.com/mpvnet-player/mpv.net)\n - [x] wmplayer.exe (fallback on Windows)\n- Android\n - [x] [mpv-android](https://github.com/mpv-android/mpv-android)\n - [x] [VLC]\n - [x] Choose\n- Linux (Flatpack)\n - [x] [MPV](https://flathub.org/apps/io.mpv.Mpv)\n - [x] [VLC](https://flathub.org/apps/org.videolan.VLC)\n - [x] [Celluloid](https://flathub.org/apps/io.github.celluloid_player.Celluloid)\n- Linux\n - [x] [Celluloid](https://celluloid-player.github.io/)\n- MacOS\n - [ ] [IINA](https://iina.io/)\n\n## Custom CSS\n\n**For power users only**\n\nPlace your custom CSS in `user_config_path(\"gucken\").joinpath(\"custom.css\")` and it will be automatically loaded by Gucken.\n\n- [Textual CSS Guide](https://textual.textualize.io/guide/CSS/)\n- [Textual CSS Reference](https://textual.textualize.io/css_types/)\n\n## Optional dependencies\n\n- `speedups` (with: `gucken[speedups]`)\n - Faster fuzzy sort/search. (`levenshtein`)\n - Faster json parsing. (`orjson`)\n- `socks` - SOCKS proxy support. (with: `gucken[socks]`)\n\n## Todo\n\n### Privacy\n\n- [ ] Proxy support\n```\nProxies can easiely be implented\n\nfor the http client in python\nAsyncClient(proxy=\"http://...\")\n \nfor the player mpv Note: mpv dos not support socks5\n--http-proxy=<proxy>\nFFmpeg: env.http_proxy\nytdl: --ytdl-raw-options=proxy=\n \nyt-dlp\n--proxy URL\n```\n- [ ] [Tor](https://www.torproject.org/) as proxy\n```\nAniWorld.to need Cloudflare captcha and JS challange\nSerienStream.to can be bypassed by using diract ip\n \nCloudflare captcha and JS challange can be solved by using something like\nselenium or playwright\n```\n- [ ] DoH support\n- [ ] Reverse proxy for player\n - [ ] DoH\n - [ ] proxy\n\n### UX\n\n- [ ] Add hotkey to clear cache (F5)\n- [ ] Translation DE, EN\n- [ ] Improve settings design\n- [ ] Merge SerienStream.to and AniWorld.to search results\n- [ ] Focus window on autoplay popup\n- [ ] Utilize next and previous buttons in mpv\n- [ ] Chapters for VLC\n- [ ] Window in settings menu to show where files are located (data, logs, config, downloads)\n- [ ] s.to, aniworld.to scrape episode description\n- [ ] Search in episodes\n- [ ] Next and Cancel hotkeys\n- [ ] Show hotkeys in Footer\n- [ ] Create shortcut Windows & Linux\n- [ ] Installation helper\n - [ ] [MPV]\n - [ ] [Anime4k]\n - [ ] [VLC]\n- [ ] Colors themes\n\n### Speedups\n\n- [ ] Pre-fetching\n- [ ] More threads and asyncio.gather to make everything faster\n- [ ] More Caching\n- [ ] Reuse Client\n\n### Code\n\n- [ ] Do unescape and stripe only on render\n- [ ] Dont coppy code from SerienStream.to to AniWorld.to\n- [ ] BIG CODE CLEANUP\n\n### Features\n\n- [ ] Update checker option to perform update\n- [ ] Watchlist\n- [ ] New anime/series Notifications\n- [ ] Image preview (Kitty protocol, iterm protocol, Sixel, textual-web)\n- [ ] Use something like opencv to time match a sub from aniworld with a high quality video form another site.\n- [ ] Nix package\n- [ ] Docker image\n- [ ] Flatpack package\n- [ ] Detect existing chapters and use them for skip\n- [ ] Reverse proxy for players that do not support headers\n- [ ] Up-scaling (after download)\n - [ ] [video2x](https://github.com/k4yt3x/video2x)\n - [ ] [waifu2x](https://github.com/nagadomi/waifu2x)\n - [ ] [Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN)\n - [ ] [FSRCNN](https://github.com/igv/FSRCNN-TensorFlow)\n - [ ] [Anime4k]\n- [ ] Modular (Custom extractors/players, open API)\n- [ ] More CLI args\n- [ ] [MPV] Screen selection\n- [ ] Custom player args\n- [ ] Custom player\n- [ ] [Anime4k] options\n\n#### Support\n\n- [ ] Mac support\n- [ ] IOS support\n- [ ] Support textual-web\n- [ ] Syncplay on Android\n- [ ] Improve Flatpack support\n- [ ] Improve Snap support\n\n### Bugs & DX\n\n- [ ] Proper error handling\n- [ ] Logging and Crash reports\n- [ ] Blacklist detection & bypass\n- [ ] 404 detection inside Hoster and don't crash whole program on http error + crash reports/logs\n- [ ] CI Testing (Windows, Linux)\n\n[Anime4k]: https://github.com/bloc97/Anime4K\n[MPV]: https://mpv.io/\n[VLC]: https://www.videolan.org/vlc/\n[AniWorld.to]: https://aniworld.to\n[SerienStream.to]: https://186.2.175.5\n[Python]: https://www.python.org/downloads/\n[Windows Terminal]: https://apps.microsoft.com/detail/9n0dx20hk701\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Commandcracker 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.",
"summary": "Gucken is a Terminal User Interface which allows you to browse and watch your favorite anime's with style.",
"version": "0.2.3",
"project_urls": {
"Repository": "https://github.com/Commandcracker/gucken"
},
"split_keywords": [
"anime",
" gucken",
" serien",
" series",
" tui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2f38f17c606fb967c230e3053adf0d75aedcf63120c8970d60624068940bd88",
"md5": "9f9d3763d3496e2ef91a7d946e243ee0",
"sha256": "7f1b95113055c88dff33a408f3f133e7b69074864da417077f68e0d117a75681"
},
"downloads": -1,
"filename": "gucken-0.2.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "9f9d3763d3496e2ef91a7d946e243ee0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 42981,
"upload_time": "2024-06-12T18:12:31",
"upload_time_iso_8601": "2024-06-12T18:12:31.379407Z",
"url": "https://files.pythonhosted.org/packages/f2/f3/8f17c606fb967c230e3053adf0d75aedcf63120c8970d60624068940bd88/gucken-0.2.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bbe25c3828f3301c9d1b97832c1d4f1296df42ed9e82e555394fcb1f16c5a9e6",
"md5": "114425905d5a683d659b220856c31307",
"sha256": "295016a636426594d692458aa53473670510c63f68ebe5fa01bf09d7b63d9818"
},
"downloads": -1,
"filename": "gucken-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "114425905d5a683d659b220856c31307",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28900,
"upload_time": "2024-06-12T18:12:32",
"upload_time_iso_8601": "2024-06-12T18:12:32.918658Z",
"url": "https://files.pythonhosted.org/packages/bb/e2/5c3828f3301c9d1b97832c1d4f1296df42ed9e82e555394fcb1f16c5a9e6/gucken-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-12 18:12:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Commandcracker",
"github_project": "gucken",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gucken"
}
