| Name | doom-chan JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Turns 4chan threads into "doomscrollable" playlists |
| upload_time | 2024-06-06 20:33:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
4chan
video
cli
mpv
doom scroll
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Doom Chan
This CLI lets you browse 4chan from the terminal and make a playlist out of any thread, streamlining the experience and making it more doomscroll-able.
Although this was originally made to turn video-heavy threads from [/wsg/](https://4chan.org/wsg/catalog) into playlists (YGYL threads mostly), all threads on all boards on 4chan are now supported, including those with just images present.
The order of videos is also always shuffled to keep it fresh.
## Usage
Run `dc` to launch the cli
- `b` switches between boards and displays their threads
- `f` searches for a specific string in thread titles
- numbers are used to select boards and threads
- `Enter` and `Shift+Enter` can be used to go to the next and previous videos in the playlist and `Esc` quits the playlist
- `q` quits the CLI
All the mpv key bindings can also be used for this cli, so `[` and `]` can be used to change the speed of the video and the arrow keys can be used to seek within the video. If you're unfamiliar with mpv, here's a full list of all the [keyboard controls](https://mpv.io/manual/master/#keyboard-control).
## Requirements
- [Python](https://www.python.org/downloads/) (version 3.10 or above)
- [MPV](https://mpv.io/installation/)
##### Windows Only:
- [libmpv](https://sourceforge.net/projects/mpv-player-windows/files/libmpv/) (download and extract the folder, then place `libmpv-2.dll` wherever you download this library)
## Installation
Once you have the requirements set up, just run `pip install doom_chan` and everything will be installed.
-----------------------------------------------------
If you like installing things the _hard_ way, you can also just download and use `./doom_chan/doom_chan.py` since all the code is entirely contained there.
However, Windows users (and only Windows users) will also need to download and install [libmpv](https://sourceforge.net/projects/mpv-player-windows/files/libmpv/). After the download, extract the folder, then place `libmpv-2.dll` in the same folder as `doom_chan.py`.
You don't need to worry about any of this if you just install this project with `pip` though.
## Uninstallation
Run `pip uninstall doom_chan`
## Contributions
Pull requests are always welcome, but please do open an issue first if you plan on implementing major changes.
## Inspiration
This library was inspired by projects like [yewtube](https://github.com/mps-youtube/yewtube) and [ani-cli](https://github.com/pystardust/ani-cli) which scrape the internet and let you surf巡 platforms from a CLI.
This project would also not have been possible without [python-mpv](https://github.com/jaseg/python-mpv). If it weren't for this library, I would not have been able to connect to mpv with Python.
Raw data
{
"_id": null,
"home_page": null,
"name": "doom-chan",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "4chan, video, CLI, mpv, doom scroll",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/23/06/487c4608406d399ed586f119a2b21526d22614b6ca34c383b338ff8da1cb/doom_chan-1.0.0.tar.gz",
"platform": null,
"description": "# Doom Chan\r\n\r\nThis CLI lets you browse 4chan from the terminal and make a playlist out of any thread, streamlining the experience and making it more doomscroll-able. \r\n\r\n\r\n\r\nAlthough this was originally made to turn video-heavy threads from [/wsg/](https://4chan.org/wsg/catalog) into playlists (YGYL threads mostly), all threads on all boards on 4chan are now supported, including those with just images present.\r\n\r\nThe order of videos is also always shuffled to keep it fresh.\r\n\r\n## Usage\r\n\r\nRun `dc` to launch the cli\r\n\r\n- `b` switches between boards and displays their threads\r\n- `f` searches for a specific string in thread titles\r\n- numbers are used to select boards and threads\r\n- `Enter` and `Shift+Enter` can be used to go to the next and previous videos in the playlist and `Esc` quits the playlist\r\n- `q` quits the CLI\r\n\r\nAll the mpv key bindings can also be used for this cli, so `[` and `]` can be used to change the speed of the video and the arrow keys can be used to seek within the video. If you're unfamiliar with mpv, here's a full list of all the [keyboard controls](https://mpv.io/manual/master/#keyboard-control).\r\n\r\n\r\n\r\n## Requirements\r\n\r\n- [Python](https://www.python.org/downloads/) (version 3.10 or above)\r\n- [MPV](https://mpv.io/installation/)\r\n\r\n\r\n##### Windows Only:\r\n\r\n- [libmpv](https://sourceforge.net/projects/mpv-player-windows/files/libmpv/) (download and extract the folder, then place `libmpv-2.dll` wherever you download this library) \r\n\r\n## Installation\r\n\r\nOnce you have the requirements set up, just run `pip install doom_chan` and everything will be installed.\r\n\r\n-----------------------------------------------------\r\nIf you like installing things the _hard_ way, you can also just download and use `./doom_chan/doom_chan.py` since all the code is entirely contained there. \r\n\r\nHowever, Windows users (and only Windows users) will also need to download and install [libmpv](https://sourceforge.net/projects/mpv-player-windows/files/libmpv/). After the download, extract the folder, then place `libmpv-2.dll` in the same folder as `doom_chan.py`.\r\n\r\nYou don't need to worry about any of this if you just install this project with `pip` though.\r\n\r\n## Uninstallation\r\n\r\nRun `pip uninstall doom_chan`\r\n\r\n## Contributions\r\n\r\nPull requests are always welcome, but please do open an issue first if you plan on implementing major changes.\r\n\r\n## Inspiration\r\n\r\nThis library was inspired by projects like [yewtube](https://github.com/mps-youtube/yewtube) and [ani-cli](https://github.com/pystardust/ani-cli) which scrape the internet and let you surf\ue05e\u5de1 platforms from a CLI.\r\n\r\nThis project would also not have been possible without [python-mpv](https://github.com/jaseg/python-mpv). If it weren't for this library, I would not have been able to connect to mpv with Python.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Turns 4chan threads into \"doomscrollable\" playlists",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"4chan",
" video",
" cli",
" mpv",
" doom scroll"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "739f12114de265163558f0e0903afcc30eb92246a5a7665274412f209aaf8329",
"md5": "5af2d944c8b3a6b16b4dee0e6f703ae5",
"sha256": "099cabacf75903d422776d77b5dce5276ab5e1a8fb1015700546b67bc10af4f4"
},
"downloads": -1,
"filename": "doom_chan-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5af2d944c8b3a6b16b4dee0e6f703ae5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 41303947,
"upload_time": "2024-06-06T20:33:43",
"upload_time_iso_8601": "2024-06-06T20:33:43.683868Z",
"url": "https://files.pythonhosted.org/packages/73/9f/12114de265163558f0e0903afcc30eb92246a5a7665274412f209aaf8329/doom_chan-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2306487c4608406d399ed586f119a2b21526d22614b6ca34c383b338ff8da1cb",
"md5": "f75c5fd1aa6535611bda88fc12498bfb",
"sha256": "beaf49a2cec0cbd7108c1c7ce5033041f99bea05eee3498dc63843c58d6b475c"
},
"downloads": -1,
"filename": "doom_chan-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "f75c5fd1aa6535611bda88fc12498bfb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 41156197,
"upload_time": "2024-06-06T20:33:48",
"upload_time_iso_8601": "2024-06-06T20:33:48.479198Z",
"url": "https://files.pythonhosted.org/packages/23/06/487c4608406d399ed586f119a2b21526d22614b6ca34c383b338ff8da1cb/doom_chan-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-06 20:33:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "doom-chan"
}
