/green-py-bot

A friendly Telegram Python Bot to schedule and execute scripts, whenever the user wants it.

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

bot-banner

What is this?

repo-size open-issues last-commit license

This is a easy-to-use Telegram bot. Its main task is to execute trusted Python scripts by a schedule. Useful e.g. to fetch RSS feeds or monitor or... Just everything you can do with Python. You are missing a script? Just contribute and enjoy the community using it!

Official docker image

build-howto build-state build-pulls build-size

You want to use your own hardware and host it yourself? Then check the docker container out on https://hub.docker.com/r/realsimonmicro/green-py-bot. To use it, just download the docker-compose.yml file and start the bot with docker-compose up. Thats it!

Manual startup

You don't want to use docker? Okay, then make sure to have all packages from the requirements.txt installed and start the bot with python3 main.py

Add own repositories

You have a self-hosted instance and want to add some of your own (private) scripts? No problem! Just open the config/config.json and expand the repo section as needed. The key is the name, the value is e.g. the Git URL. Example? Here you go:

"repos": {
    "myownrepo": "https://github.com/user/goodstuff.git"
}

Your repo will be automatically cloned and regulary updated (every 24h). Its content will be directly stored into repo/[name], so make sure the scripts are stored inside the root of the repo!

Visit the bot over on Telegram!

A copy of this repo is running always reachable on https://t.me/green_py_bot. Just start a conversation and look where it goes... The bot has been taken offline at 2020-12-12 due not enough users 😢...

The emblem...

...has been composed from the following Pixabay images:

You can use it (of course) freely for your own bot-instance, but please preserve the original author information.