Go to file
2024-07-05 15:22:38 +02:00
LICENSE Add MIT license 2024-07-05 08:09:44 +02:00
README.md aktualizace README souboru 2024-07-05 15:22:38 +02:00

🐘 Welcome Bot pro Mastodon

Tento bot slouží k automatickému zasílání uvítacích zpráv novým uživatelům na Mastodon instanci.

Požadavky

  • Python 3.12
  • Knihovny: Mastodon.py, python-dotenv

Instalace

  1. Naklonujte repozitář:
 git clone https://your-repo-url.git
 cd welcome_bot
  1. Vytvořte virtuální prostředí a aktivujte ho:
python3 -m venv venv
source venv/bin/activate
  1. Nainstalujte potřebné balíčky:
pip install -r requirements.txt

Vytvořte konfigurační soubory:

  • config.toml:
[mastodon]
base_url = "url_instance_mastodon"
client_id = "client_id.secret"
secret_storage = "secret_storage.secret"
credential_storage = "credential_storage.secret"

[database]
sqlite_path = "welcome_bot.db"

[[messages]]
content = "Vítej na naší instanci Mastodon!"
content_warning = "Upozornění"

[[messages]]
content = "Jsme rádi, že jsi tady!"

[[messages]]
content = "Doufáme, že si užiješ pobyt na naší platformě!"
  • client_id.secret: Vložte svůj client ID.

  • secret_storage.secret: Vložte svůj client secret.

  • credential_storage.secret: Vložte svůj access token.

Použití

  1. Ujistěte se, že je aktivováno vaše virtuální prostředí:
source venv/bin/activate
  1. Spusťte bota:
python3 welcome_bot.py
  1. stěte se, že je aktivováno vaše virtuální prostředí:
source venv/bin/activate

Spusťte bota:

python3 welcome_bot.py

Příspěvky

Příspěvky jsou vítány! Pro více informací viz CONTRIBUTING.md.

Licence

Tento projekt je licencován pod MIT licencí - viz LICENSE soubor pro detaily. Acknowledgements

Tento projekt je založen na isosphere/mastodon-welcome projektu. Děkujeme autorům za jejich skvělou práci.