Merge pull request #34 from alexeyqu/dev

v1.0 release

Author: alexeyqu

.env

@@ -0,0 +1,2 @@
+TELEGRAM_TOKEN=
+TELEGRAM_ERROR_CHAT_ID=

.github/workflows/formatting_testing.yml

@@ -0,0 +1,31 @@
+name: Formatting check on pull requests
+
+on:
+  pull_request:
+    branches:
+      - dev
+
+jobs:
+  pre_commit:
+    runs-on: ubuntu-latest
+    environment: 
+      name: testing
+
+    steps:
+    - name: checkout repository
+      uses: actions/checkout@v2
+
+    - name: set up Python
+      uses: actions/setup-python@v2
+
+    - name: install pre-commit
+      run: python -m pip install pre-commit
+      shell: bash
+
+    - name: pip freeze
+      run: python -m pip freeze --local
+      shell: bash
+
+    - name: run pre-commit 
+      run: pre-commit run --color=always --show-diff-on-failure
+      shell: bash

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+    -   id: black
+        exclude: ^(.+)/migrations/.*\.py
+        

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.6
+FROM python:3.9
 
 RUN pip install "setuptools<46" && pip install pipenv
 
@@ -10,4 +10,4 @@ RUN pipenv install --system
 COPY . /app
 WORKDIR /app
 
-CMD alembic upgrade head && python wachter/bot.py
+CMD alembic upgrade head && python -m app

Pipfile

@@ -5,12 +5,16 @@ name = "pypi"
 
 [packages]
 "psycopg2-binary" = "*"
-python-telegram-bot = "*"
+python-telegram-bot = {version = "~=13.11"}
 sqlalchemy = "*"
 alembic = "*"
+pre-commit = "*"
+pylint = "*"
+black = "*"
+pyTelegramLogger = "*"
 
 [dev-packages]
 "autopep8" = "*"
 
 [requires]
-python_version = "3.6"
+python_version = "3.9"

Pipfile.lock

@@ -1,16 +1,37 @@
 # Wachter Telegram bot
 
-## Как запустить
+[![Docker prod](https://github.com/alexeyqu/wachter_bot/actions/workflows/publish_production.yml/badge.svg)](https://github.com/alexeyqu/wachter_bot/actions/workflows/publish_production.yml) [![Docker testing](https://github.com/alexeyqu/wachter_bot/actions/workflows/publish_testing.yml/badge.svg)](https://github.com/alexeyqu/wachter_bot/actions/workflows/publish_testing.yml)
 
-В корне есть Dockerfile
+<img src="https://github.com/alexeyqu/wachter_bot/assets/7394728/75869909-59fa-4d1b-a829-7737613adf87" alt="telegram logo" height="18px"/> [Вахтёр Бот](https://t.me/wachter_bot)
+
+
+![photo_2023-10-28_15-36-58](https://github.com/alexeyqu/wachter_bot/assets/7394728/dac59c1b-0868-4bcc-aa07-48944c9a15b8)
+
+
+## Как добавить в свою группу
+
+1. Добавить в группу.
+2. Сделать администратором.
+3. Опционально, настроить бота в личном чате.
+
+## Local Development
+
+### Prerequisites 
+
+We are using black to keep our code looking nice and tidy. To make things easier, there's a pre-commit hook which ensures that files to commit are properly formatted. You need to install and initialize pre-commit. Any installation should suffice, one can find pipenv good choice since we use it in this project. After installation run:
 
 ```bash
-$ docker build -t wachter_bot .
-$ docker run -e TELEGRAM_TOKEN=<token> wachter_bot
+pre-commit install
 ```
 
-## Как добавить в свой чат
+Then will be executed black against changed files in commits.
+
+### Running
+
+1) Set `TELEGRAM_TOKEN` and `TELEGRAM_ERROR_CHAT_ID` environment variable;
 
-1. Добавить в чат
-2. Написать whois (минимальная длина 20 символов)
-3. Написать боту в лс /start - бот заработает и появятся настройки чата
+2) Run:
+
+```bash
+docker-compose -f docker-compose.dev.yml build && docker-compose -f docker-compose.dev.yml up
+```

README.md

@@ -0,0 +1,63 @@
+from telegram.ext import (
+    Updater,
+    CommandHandler,
+    Filters,
+    MessageHandler,
+    CallbackQueryHandler,
+    ChatMemberHandler,
+)
+from src.custom_filters import filter_bot_added
+from src.logging import tg_logger
+from src import handlers
+import os
+
+
+def main():
+    updater = Updater(os.environ["TELEGRAM_TOKEN"])
+    dp = updater.dispatcher
+
+    dp.add_handler(CommandHandler("help", handlers.help_handler))
+
+    # group UX
+    dp.add_handler(
+        ChatMemberHandler(
+            handlers.my_chat_member_handler,
+            ChatMemberHandler.MY_CHAT_MEMBER,
+        )
+    )
+    dp.add_handler(
+        MessageHandler(
+            Filters.entity("hashtag") & Filters.chat_type.groups,
+            handlers.on_hashtag_message,
+            pass_job_queue=True,
+            pass_user_data=True,
+        )
+    )
+    dp.add_handler(
+        MessageHandler(
+            Filters.status_update.new_chat_members & filter_bot_added,
+            handlers.on_new_chat_members,
+            pass_job_queue=True,
+        )
+    )
+
+    # admin UX
+    dp.add_handler(CommandHandler("start", handlers.start_handler, pass_user_data=True))
+    dp.add_handler(CallbackQueryHandler(handlers.button_handler, pass_user_data=True))
+    dp.add_handler(
+        MessageHandler(
+            (Filters.text | Filters.entity),
+            handlers.message_handler,
+            pass_user_data=True,
+            pass_job_queue=True,
+        )
+    )
+    dp.add_error_handler(handlers.error_handler)
+
+    updater.start_polling()
+    tg_logger.info("Bot has started successfully")
+    updater.idle()
+
+
+if __name__ == "__main__":
+    main()

app.py

@@ -0,0 +1,44 @@
+version: "3.9"
+
+services:
+  wachter-db:
+    container_name: wachter-db-dev
+    image: postgres:alpine
+    restart: always
+    ports:
+      - 5433:5432
+    environment:
+      POSTGRES_DB:       db
+      POSTGRES_HOST:     wachter-db
+      POSTGRES_USER:     user
+      POSTGRES_PASSWORD: password
+    volumes:
+      - volume-db:/data/db
+      - postgres-data:/var/lib/postgresql/data
+      - ./share/sql:/docker-entrypoint-initdb.d
+    healthcheck:
+      test: pg_isready -U user -d db
+      interval: 5s
+      timeout: 2s
+      retries: 3
+
+  wachter:
+    container_name: wachter-dev
+    build:
+      context: .
+    environment:
+      - TELEGRAM_TOKEN=${TELEGRAM_TOKEN}
+      - TELEGRAM_ERROR_CHAT_ID=${TELEGRAM_ERROR_CHAT_ID}
+      - DATABASE_URL=postgresql://user:password@wachter-db/db
+    restart: unless-stopped
+    depends_on:
+      wachter-db:
+        condition: service_healthy
+
+volumes:
+  volume-db:
+  postgres-data:
+
+networks:
+  default:
+    name: network-wachter-dev

docker-compose.dev.yml

@@ -4,7 +4,8 @@
 from logging.config import fileConfig
 
 import os, sys
-sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__), '..')))
+
+sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__), "..")))
 
 
 # this is the Alembic Config object, which provides
@@ -19,16 +20,19 @@
 # for 'autogenerate' support
 # from myapp import mymodel
 # target_metadata = mymodel.Base.metadata
-from wachter import model
+from src import model
+
 target_metadata = model.Base.metadata
 
 # other values from the config, defined by the needs of env.py,
 # can be acquired:
 # my_important_option = config.get_main_option("my_important_option")
 # ... etc.
 
+
 def get_uri():
-    return os.environ.get('DATABASE_URL', config.get_main_option("sqlalchemy.url")) 
+    return os.environ.get("DATABASE_URL", config.get_main_option("sqlalchemy.url"))
+
 
 def run_migrations_offline():
     """Run migrations in 'offline' mode.
@@ -43,7 +47,8 @@ def run_migrations_offline():
 
     """
     context.configure(
-        url=get_uri(), target_metadata=target_metadata, literal_binds=True)
+        url=get_uri(), target_metadata=target_metadata, literal_binds=True
+    )
 
     with context.begin_transaction():
         context.run_migrations()
@@ -59,14 +64,12 @@ def run_migrations_online():
     connectable = create_engine(get_uri())
 
     with connectable.connect() as connection:
-        context.configure(
-            connection=connection,
-            target_metadata=target_metadata
-        )
+        context.configure(connection=connection, target_metadata=target_metadata)
 
         with context.begin_transaction():
             context.run_migrations()
 
+
 if context.is_offline_mode():
     run_migrations_offline()
 else: