Merge branch 'develop' into feature/logic_bot

.github/workflows/codestyle_linters.yml

@@ -0,0 +1,36 @@
+name: Python linters
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  lint:
+    name: Check the code with python linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          pip install isort black flake8 flake8-docstrings
+
+      - name: Check with isort
+        run: isort . --check --profile black --skip migrations --skip-glob "*settings*"
+
+      - name: Check with black
+        run: black . --check --line-length 79 --exclude migrations --exclude "settings"
+
+      - name: Check with flake8
+        run: flake8 .

.gitignore

@@ -157,4 +157,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

.pre-commit-config.yaml

@@ -25,4 +25,4 @@ repos:
     hooks:
       - id: black
         args: ['--line-length=79']
-        exclude: ^(migrations/|.*settings(\.py|/)?)
+        exclude: ^(migrations/|.*settings(\.py|/)?)

README.md

@@ -4,11 +4,11 @@ Random Coffee bot for the Telegram
 # Содержание
 
 
-1. [БРИФ]()
+1. [БРИФ](#brief)
 
    1.1 [Инструкции и ритуалы на проекте]()
 
-   1.2 [ER - диаграмма сущностей]()
+   1.2 [ER - диаграмма сущностей](#er)
 
 2. [Структура проекта](#structure)
 3. [Подготовка к запуску](#start)
@@ -31,6 +31,12 @@ Random Coffee bot for the Telegram
 
 <br><br>
 
+# 1. БРИФ <a id="brief"></a>
+
+## 1.2. ER - диаграмма сущностей<a id="er"></a>:
+ER диаграммы расположены в директории /docs в двух удобных форматах [.drowio, .jpg]
+![ER Диаграмма](/docs/RandomCoffeeER.jpg)
+
 # 2. Структура проекта <a id="structure"></a>
 
 | Имя  | Описание |
@@ -303,12 +309,6 @@ make filldb
 самостоятельно основные функции бота, функции отправки и получения сообщений,
 функции перенаправления на сторонние или внутренние ресурсы.
 
-
-
-
-
-
-
 #### Рекомендации к написанию кода [Codestyle](https://github.com/Studio-Yandex-Practicum/RandomCoffeeBotTelegram/tree/develop/docs/codestyle.md)
 
 #### Диаграмма логики работы бота [Diagram](https://github.com/Studio-Yandex-Practicum/RandomCoffeeBotTelegram/tree/develop/docs/Diagram_of_logic_bot.jpg)

docs/codestyle.md

@@ -6,13 +6,13 @@
 
 + Имена переменных должны быть snake_case и в нижнем регистре `first_name`
 
-+ Используйте информативные описательные имена, которые легко читаются. 
++ Используйте информативные описательные имена, которые легко читаются.
 
     ```python
     # Не рекомендуется
     au = 105
 
-    # Рекомендуется 
+    # Рекомендуется
     active_users = 105
     ```
 
@@ -23,10 +23,10 @@
     # Не рекомендуется
     def roll_dice():
         return random.randint(0, 4)  # what is 4 supposed to represent?
-    
+
     # Рекомендуется
     DICE_SIDES = 4
-    
+
     def roll_dice():
         return random.randint(0, DICE_SIDES)
     ```
@@ -41,8 +41,8 @@ DICE_SIDES = 4
 
 # Не рекомендуется
 def roll_dice_using_randint():
-    return random.randint(0, DICE_SIDES)  
-    
+    return random.randint(0, DICE_SIDES)
+
 # Рекомендуется
 def roll_dice():
     return random.randint(0, DICE_SIDES)
@@ -51,7 +51,7 @@ def roll_dice():
 
  Максимальная длина строки. Постарайтесь ограничить свои строки примерно 79 символами, что является рекомендацией, приведенной в руководстве по стилю [PEP 8](https://pythonworld.ru/osnovy/pep-8-rukovodstvo-po-napisaniyu-koda-na-python.html?ysclid=lmajzjrf9x736916353#section-5)
 
-### Аннотация типов 
+### Аннотация типов
 
 Чтобы держать типизацию под контролем — применяют аннотации типов данных `Type Hints`. Это явное указание типа ожидаемых данных при объявлении переменных, классов и функций.
 
@@ -109,10 +109,10 @@ def send_email(subject: str, body: str, recipients: List[str], cache: Dict[str,s
           """Можно перенести
           так.
           """
-      
+
       def muddy_func():
           """
-          А можно - 
+          А можно -
           так.
           """
     ```
@@ -124,7 +124,7 @@ def send_email(subject: str, body: str, recipients: List[str], cache: Dict[str,s
 
 ### F строка
 + f-строки должны использовать только простой доступ к переменным и свойствам с предварительным назначением локальной переменной для более сложных случаев:
-    
+
 ```python
 # Разрешено
 f'hello {user}'
@@ -185,4 +185,4 @@ from django.views import View
 вместо:
 ```python
 from django.views.generic.base import View
-```
+```