beets based mitm of your torrent client and music player
Project description
beets.io based man-in-the-middle of your torrent client and music player
workflow
notifiers
betanin uses apprise for notifications. so anything supported there will work. but some include
- discord
- telegram
- emby
installation
pip install --user betanin
usage
# start server
betanin
# a config file will be created, add your credentials to it
# start again
betanin [--host=<host>] [--port=<port>]
# ui will be available at port
# you may also use env vars instead, eg
BETANIN_HOST=0.0.0.0 betanin
BETANIN_PORT=4030 betanin
# optionally start cli (for db operations, debugging)
betanin-shell
# or if docker
docker exec -it <container_id> betanin-shell
screenshots
docker
image
docker pull sentriz/betanin
volumes /b/.local/share/betanin/
for a persistent database
/b/.config/betanin/
for a persistent betanin config
/b/.config/beets/
for a persistent beets home (point this to your
current beets home if you have one)
/music/
so beets can access your music
/downloads/
so beets can access your downloads
compose
betanin:
image: sentriz/betanin
ports:
- 9393:9393
restart: unless-stopped
environment:
- UID=1000 # (optionally) set user id
- GID=1000 # (optionally) set group id
volumes:
- ${DATA}/betanin/data:/b/.local/share/betanin/
- ${DATA}/betanin/config:/b/.config/betanin/
- ${DATA}/betanin/beets:/b/.config/beets/
- ${MEDIA}/music:/music/
- ${MEDIA}/downloads:/downloads/
transmission
create a script named done.sh
or anything you like, and make it
executable:
chmod +x done.sh
settings.json (example excerpt)
...
"script-torrent-done-enabled": true,
"script-torrent-done-filename": "/scripts/done.sh",
...
done script
#!/bin/sh
curl \
--request POST \
--data-urlencode "path=<path_to_transmission_downloads>" \
--data-urlencode "name=$TR_TORRENT_NAME" \
--header "X-API-Key: <your_api_key>" \
"https://betanin.example.com/api/torrents"
transmission docker compose (excerpt)
volumes:
- ${DATA}/transmission/config:/config
- ${DATA}/transmission/scripts:/scripts
- ${MEDIA}/download:/downloads
deluge
create a script named done.sh
or anything you like, and make it
executable:
chmod +x done.sh
you must also be using the
Execute plugin,
set to the Torrent Complete
event
done script
#!/bin/sh
curl \
--request POST \
--data-urlencode "path=<path_to_deluge_downloads>" \
--data-urlencode "name=$2" \
--header "X-API-Key: <your_api_key>" \
"https://betanin.example.com/api/torrents"
qbittorrent
create a script named done.sh
or anything you like, and make it
executable:
chmod +x done.sh
open qbittorrent Tools
> Options
> check Run external program on torrent completion
set the path to the above done.sh
and arguments such as
/path/to/done.sh "%L" "%R"
done script
#!/bin/sh
echo "category: $1"
echo "path: $2"
[ "$1" != "music" ] && exit
curl \
--request POST \
--data-urlencode "both=$2" \
--header "X-API-Key: <your_api_key>" \
"https://betanin.example.com/api/torrents"
now any music downloaded to the music category will be imported by betanin
developing
working on the backend
there is not much else to do, write your code,
python -m betanin.entry.betanin
, kill it, write your code, etc. the
webserver will be available at http://localhost:9393/. the static
frontend is served at /
, and the api is served at /api
. (there is a
swagger ui there too) also see python -m betanin.entry.shell
.
if you need to do a manual migration do
env FLASK_APP='betanin.application:create' flask db migrate --directory betanin_migrations/
(then upgrades are automatically done on betanin start)
working on the frontend
start the backend with python -m betanin.entry.betanin
, but don’t use
the static frontend served at http://localhost:9393/. Instead, in a
new shell, do npm --prefix betanin_client/ run serve
and use the
frontend served at http://localhost:8081/. it will look for a backend
listening on port 9393 locally. after that you can edit anything in
betanin_client/src
, it will be linted and automatically reflected in
your web browser.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file betanin-0.5.6.tar.gz
.
File metadata
- Download URL: betanin-0.5.6.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a9003ffcc54a85c16847d6a9947f4d80090cf88af201137baffb902f34d82f5 |
|
MD5 | 807a28410aa825a61151748272206ccb |
|
BLAKE2b-256 | f8500bbd943eda92b5aafe54b49a69719f1b5a2d136ee1a82613f75cd986e12e |
File details
Details for the file betanin-0.5.6-py3-none-any.whl
.
File metadata
- Download URL: betanin-0.5.6-py3-none-any.whl
- Upload date:
- Size: 2.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95afa8b34f8d4a6e026349320acb9272323fc30e91cc0fa5f00a813516f149fd |
|
MD5 | d6b81da45fe9502f6ae75d59f8e7d019 |
|
BLAKE2b-256 | b6db01a73f2528d482d5628475308b96f1d14188be51aec46672427f830eba0d |