A bot for many things: aria2 management, torrent sites crawling, media organization with filebot and plex.
Project description
pawabot
A bot for many things: aria2 management, torrent sites crawling, media organization with filebot and plex.
This bot provides a command to search for torrents on the web, and let you select them for download. There is a basic permission system allowing to manage multiple users for one bot.
Requirements
pawabot requires Python 3.6 or above.
To install Python 3.6, I recommend using pyenv
.
# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv
# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"
# install Python 3.6
pyenv install 3.6.8
# make it available globally
pyenv global system 3.6.8
Installation
With pip
:
python3.6 -m pip install pawabot
With pipx
:
# install pipx with the recommended method
curl https://raw.githubusercontent.com/cs01/pipx/master/get-pipx.py | python3
pipx install --python python3.6 pawabot
Setup
- Create your Telegram bot account by talking to the
@godfather
bot. - Write your bot token in
~/.config/pawabot/bot_token.txt
, or set and export the environment variableBOT_TOKEN
. - Register your Telegram main account as administrator in the database with:
pawabot create-admin -i MY_TG_ID -u MY_TG_USERNAME
Usage
usage: pawabot [-h] [-L {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}]
...
optional arguments:
-h, --help show this help message and exit
Commands:
run Run the bot.
create-admin Create an administrator in the database.
create-user Create a user in the database.
list-users List registered users.
Global options:
-L {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}, --log-level {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}
Log level to use
Commands:
create-admin
usage: pawabot create-admin [-h] [-i UID] [-u USERNAME]
Create an administrator in the database.
optional arguments:
-h, --help Show this help message and exit.
-i UID, --uid UID Telegram user id.
-u USERNAME, --username USERNAME
Telegram user name.
create-user
usage: pawabot create-user [-h] [-i UID] [-u USERNAME] [-a]
Create a user in the database.
optional arguments:
-h, --help Show this help message and exit.
-i UID, --uid UID Telegram user id.
-u USERNAME, --username USERNAME
Telegram user name.
-a, --admin Give admin access.
list-users
usage: pawabot list-users [-h]
List registered users.
optional arguments:
-h, --help Show this help message and exit.
run
usage: pawabot run [-h]
Run the bot.
optional arguments:
-h, --help Show this help message and exit.
Screenshots
/start | /help | /search |
---|---|---|
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
pawabot-0.1.1.tar.gz
(13.5 kB
view details)
Built Distribution
pawabot-0.1.1-py3-none-any.whl
(15.7 kB
view details)
File details
Details for the file pawabot-0.1.1.tar.gz
.
File metadata
- Download URL: pawabot-0.1.1.tar.gz
- Upload date:
- Size: 13.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/0.12.17 CPython/3.6.8 Linux/5.3.7-arch1-1-ARCH
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 377f7ef6ca93bd5fa43983eba3ce4514e714cd0e2c5ff073cd5e75f68fb82f4e |
|
MD5 | e04e151bbdc0003961059e8f0ad6db6d |
|
BLAKE2b-256 | dee66e195ede1b4e698940cf730e552560ec2fc1a1d725edf9e51b76d2c14d40 |
File details
Details for the file pawabot-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: pawabot-0.1.1-py3-none-any.whl
- Upload date:
- Size: 15.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/0.12.17 CPython/3.6.8 Linux/5.3.7-arch1-1-ARCH
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c9189472d0e06c002ab4e3b0449a5d8a338b11d8bbb0f339eeb6acc2897ef6d |
|
MD5 | e5717326d9bdb684926c809cd22d9f52 |
|
BLAKE2b-256 | decea308f2eac4e80fee3936f384c34b9f9eaa8ede4acf6d4d588b1145b77ded |