| Name | bay-watch JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | |
| Summary | TUI for TPB + Peerflix + Transmission |
| upload_time | 2023-10-27 18:07:14 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2022 Hudson Bailey 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 |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
requests
textual
textual_inputs
ck-widgets
pyfiglet
transmission-rpc
pyperclip
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# baywatch
[baywatch](https://github.com/hdb/baywatch) is a TUI for The Pirate Bay built using [Textual](https://github.com/Textualize/textual). It uses [peerflix](https://github.com/mafintosh/peerflix) to stream torrents and [Transmission](https://transmissionbt.com/) to download torrents.
## Install
Optionally install peerflix:
```bash
npm install -g peerflix
```
Optionally install Transmission: [https://transmissionbt.com/download/](https://transmissionbt.com/download/)
Install baywatch via pip:
```bash
pip install bay-watch
```
## Demo
## Usage
Launch baywatch
```bash
baywatch
```
To open the configuration editor:
```bash
baywatch -c
```
To output the app log:
```bash
baywatch -l out.log
```
### Streaming Media
By default `play` uses [mpv](https://mpv.io) to handle peerflix streams and open a file selection dialog when multiple files are present in the torrent. To change this, open the config editor using `baywatch -c` and change `Play` and `Play Multifile`.
For instance, to set peerflix to use VLC and to play all files in a multifile torrent (e.g., like an album):
`Play`:
```bash
peerflix '{}' --vlc
```
`Play Multifile`:
```bash
peerflix '{}' --vlc -a
```
See [peerflix documentation](https://github.com/mafintosh/peerflix#usage) for more details.
### Transmission
On `download`, baywatch attempts to connect to Transmission or transmission-daemon. baywatch will try to open `transmission-gtk` if it is unable to find an running Transmission instance. This can be turned off or changed to another transmission interface by setting the `Command (Transmission)` or `Try Open (Transmission)` configuration variables.
## Disclaimer
baywatch is made for educational purposes for downloading legal torrents.
Raw data
{
"_id": null,
"home_page": "",
"name": "bay-watch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Hudson Bailey <hudsondiggsbailey@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f6/4c/be592e5a89d47741122c2a1489f1ec361e3fb3f40be811ebec8f5ba4207d/bay-watch-0.1.8.tar.gz",
"platform": null,
"description": "# baywatch\n\n[baywatch](https://github.com/hdb/baywatch) is a TUI for The Pirate Bay built using [Textual](https://github.com/Textualize/textual). It uses [peerflix](https://github.com/mafintosh/peerflix) to stream torrents and [Transmission](https://transmissionbt.com/) to download torrents.\n\n## Install\n\nOptionally install peerflix:\n\n```bash\nnpm install -g peerflix\n```\n\nOptionally install Transmission: [https://transmissionbt.com/download/](https://transmissionbt.com/download/)\n\nInstall baywatch via pip:\n\n```bash\npip install bay-watch\n```\n\n## Demo\n\n\n\n## Usage\n\nLaunch baywatch\n\n```bash\nbaywatch\n```\n\nTo open the configuration editor:\n\n```bash\nbaywatch -c\n```\n\nTo output the app log:\n\n```bash\nbaywatch -l out.log\n```\n\n### Streaming Media\n\nBy default `play` uses [mpv](https://mpv.io) to handle peerflix streams and open a file selection dialog when multiple files are present in the torrent. To change this, open the config editor using `baywatch -c` and change `Play` and `Play Multifile`.\n\nFor instance, to set peerflix to use VLC and to play all files in a multifile torrent (e.g., like an album):\n\n`Play`:\n\n```bash\npeerflix '{}' --vlc\n```\n\n`Play Multifile`:\n\n```bash\npeerflix '{}' --vlc -a\n```\n\nSee [peerflix documentation](https://github.com/mafintosh/peerflix#usage) for more details.\n\n### Transmission\n\nOn `download`, baywatch attempts to connect to Transmission or transmission-daemon. baywatch will try to open `transmission-gtk` if it is unable to find an running Transmission instance. This can be turned off or changed to another transmission interface by setting the `Command (Transmission)` or `Try Open (Transmission)` configuration variables.\n\n## Disclaimer\n\nbaywatch is made for educational purposes for downloading legal torrents.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Hudson Bailey 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": "TUI for TPB + Peerflix + Transmission",
"version": "0.1.8",
"project_urls": {
"Bug Tracker": "https://github.com/hdb/baywatch/issues",
"Homepage": "https://github.com/hdb/baywatch"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4759a7d42fd09b5c5952eb22edcec71c0231b694083e97e860e39d94fd9fc7fa",
"md5": "04d5030206019240d5a374bc87ab2d0c",
"sha256": "568d5738cf58b9d3c951b020110e2caf31b5addfe0abb791505fcf75a27fcd87"
},
"downloads": -1,
"filename": "bay_watch-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "04d5030206019240d5a374bc87ab2d0c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14636,
"upload_time": "2023-10-27T18:07:12",
"upload_time_iso_8601": "2023-10-27T18:07:12.639205Z",
"url": "https://files.pythonhosted.org/packages/47/59/a7d42fd09b5c5952eb22edcec71c0231b694083e97e860e39d94fd9fc7fa/bay_watch-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f64cbe592e5a89d47741122c2a1489f1ec361e3fb3f40be811ebec8f5ba4207d",
"md5": "7a8ff183407f2771f361d2986104d3f7",
"sha256": "fc36cc23635287c1b5dff83e7ea2537c9fcd2b7673ad384509bc6553609530f1"
},
"downloads": -1,
"filename": "bay-watch-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "7a8ff183407f2771f361d2986104d3f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14039,
"upload_time": "2023-10-27T18:07:14",
"upload_time_iso_8601": "2023-10-27T18:07:14.096678Z",
"url": "https://files.pythonhosted.org/packages/f6/4c/be592e5a89d47741122c2a1489f1ec361e3fb3f40be811ebec8f5ba4207d/bay-watch-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-27 18:07:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hdb",
"github_project": "baywatch",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.27.1"
]
]
},
{
"name": "textual",
"specs": [
[
"==",
"0.1.17"
]
]
},
{
"name": "textual_inputs",
"specs": [
[
"==",
"0.2.5"
]
]
},
{
"name": "ck-widgets",
"specs": [
[
"==",
"0.2.0"
]
]
},
{
"name": "pyfiglet",
"specs": [
[
">=",
"0.8.post1"
]
]
},
{
"name": "transmission-rpc",
"specs": [
[
"==",
"3.3.0"
]
]
},
{
"name": "pyperclip",
"specs": [
[
">=",
"1.8.2"
]
]
}
],
"lcname": "bay-watch"
}
