SpinEverydayBot v2
Telegram bot for everyday raffles. HIGHLY EXPERIMENTAL! WORK IN PROGRESS!
Setting up
Requirements
- Python 3.9+
- PostgreSQL 13+
Older versions might work, but not tested. If they do work, submit an issue.
Steps
- (Optional.) Create and set up new virtualenv for the project.
- Install requirements from
requirements.txtby runningpip install -Ur requirements.txt. - Create
config.yamlin current directory or in~/.config/spin_everyday_bot/2.x/. - Open your
config.yamland edit it to match your setup.telegram: token: ... superuser_id: ... db: host: 127.0.0.1 port: 5432 user: ... database: ... password: ...
- Migrate database by running
alembic upgrade head
Running
Polling
It's as easy as python -m spin_everyday_bot
Webhooks
- Make sure you've got HTTPS certificate. Please note that self-signed ones are not yet supported, go and create one with Let's Encrypt. If you don't have a domain name, but you have static IP, use nip.io to create "fake" domain.
- Set up a reverse-proxy like nginx with above certificate and pointing to
http://localhost:8880/. - Install additional requirements:
pip install -U "FastAPI~=0.68.0" uvicorn. - Run
python -m spin_everyday_bot webhook -u "<WEBHOOK_URL>", where<WEBHOOK_URL>is the URL for Telegram to make requests to.
Updating
Before you run a new version after updating, make sure your database is up-to-date by running migrations and check whether your config matches (see Setting up section for more info).
Contributing
Oh, you wanna contribute? That's nice!
- Make sure the project is set up and up-to-date.
- Install additional requirements from
dev-requirements.txt. - Make changes to the code.
- If you made any changes to db, make sure you created a migration by running
alembic revision --autogenerate -m '<description>'and verified it. - If you made any changes which require translation changes, make sure you generated a new translation template by running
pybabel extract \ --msgid-bugs-address="[email protected]" \ --copyright-holder="Evgeniy Filimonov <[email protected]>" \ --project=spin_everyday_bot --version=2.0.0-alpha.0 \ -o spin_everyday_bot/lang/spin_everyday_bot.pot -w 99 \ spin_everyday_bot
- Run some tools to make code style better
isort --py 39 -p spin_everyday_bot --profile black -l 100 --tc --gitignore spin_everyday_bot black -l 100 -t py39 spin_everyday_bot
- Commit and push changes to your branch/fork.
- Create a pull request.
License
Licensed under GNU AGPL v3, see LICENSE.
6 Jun 22, 2022
3 Nov 27, 2021
5 Jul 31, 2022
6 Jun 20, 2022
8 Oct 28, 2022
5 Jan 26, 2022
4 Apr 2, 2022
1 Feb 5, 2022
2 Jul 14, 2022
![[Feature request] Возможность создания алиасов для команды /spin](https://avatars.githubusercontent.com/u/10137?v=4)
3 Dec 25, 2022
13 May 24, 2021
3 Dec 16, 2021
52 Dec 29, 2022
20 Oct 28, 2022
84 Jan 04, 2023
3 Aug 26, 2022
162 Dec 21, 2022
3 Mar 07, 2022
254 Jan 05, 2023
14.8k Jan 04, 2023
27 Dec 29, 2022
15 Jan 03, 2023
32 Aug 24, 2022
3 Feb 20, 2022
1 Feb 08, 2022
6 Dec 25, 2022
103 Dec 19, 2022
16 Dec 23, 2021
6 Dec 07, 2021