2024-07-05 13:17:20 +00:00
# 🐘 Welcome Bot pro Mastodon
2024-07-05 07:40:58 +00:00
2024-07-05 13:17:20 +00:00
Tento bot slouží k automatickému zasílání uvítacích zpráv novým uživatelům na Mastodon instanci.
2024-07-05 07:40:58 +00:00
## Požadavky
2024-07-05 13:17:20 +00:00
- Python 3.12
- Knihovny: Mastodon.py, python-dotenv
2024-07-05 07:40:58 +00:00
## Instalace
2024-07-05 13:17:20 +00:00
1. Naklonujte repozitář:
```bash
git clone https://your-repo-url.git
cd welcome_bot
```
2. Vytvořte virtuální prostředí a aktivujte ho:
2024-07-05 07:42:06 +00:00
```bash
2024-07-05 13:17:20 +00:00
python3 -m venv venv
source venv/bin/activate
2024-07-05 07:40:58 +00:00
```
2024-07-05 13:17:20 +00:00
3. Nainstalujte potřebné balíčky:
2024-07-05 07:40:58 +00:00
```bash
pip install -r requirements.txt
```
2024-07-05 13:17:20 +00:00
Vytvořte konfigurační soubory:
- config.toml:
```bash
[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í:
```bash
source venv/bin/activate
```
2. Spusťte bota:
2024-07-05 07:40:58 +00:00
```bash
2024-07-05 13:17:20 +00:00
python3 welcome_bot.py
2024-07-05 07:40:58 +00:00
```
2024-07-05 13:17:20 +00:00
2. stěte se, že je aktivováno vaše virtuální prostředí:
```bash
source venv/bin/activate
```
Spusťte bota:
2024-07-05 07:40:58 +00:00
```bash
python3 welcome_bot.py
```
2024-07-05 13:22:38 +00:00
Příspěvky
2024-07-05 13:30:09 +00:00
Příspěvky jsou vítány! Pro více informací viz [CONTRIBUTING.md ](CONTRIBUTING.md )
2024-07-05 07:40:58 +00:00
2024-07-05 13:17:20 +00:00
### Licence
Tento projekt je licencován pod MIT licencí - viz LICENSE soubor pro detaily.
Acknowledgements
2024-07-05 06:06:58 +00:00
2024-07-05 13:17:20 +00:00
Tento projekt je založen na [isosphere/mastodon-welcome ](https://github.com/isosphere/mastodon-welcome ) projektu. Děkujeme autorům za jejich skvělou práci.