bdsm_bot

Это крутой телеграм бот для управления проектами, который может работать как в Windows так и в Linux

Пример использования:

py -m pdm --venv --config --vscode

Минимальня версия python - 3.6

Если ты крутой разраб, то заходи на нашу wiki

---

Настройка проекта для работы

НИИ8 был разработан специальный скрипт pdm.py (project deploy manager), который призван облегчить жизнь программисту.

Так как есть некоторые различия между операционными системами, то для удобства дальше под py
будет пониматься интерпретатор python, который установлен в вашей системе

• В Windows это: py или python
• В *nix подобных системах лучше всегда писать python3

1. Виртуальное окружение:

Чтобы создать виртуальное окружение и установить в него все нужные библиотеки в папке проекта (bdsm_bot) выполните:

py -m pdm --venv

2. Персональные настройки:

Работает если вы выполнили пункт 1.
Врядли будет удобно работать нескольким программистам с одним ботом на всех. Для тестов и разработки лучше иметь отдельных ботов, после настройки которых локальный проект превратиться в обособленный, независящий от других.
Чтобы настроить бота нужно:

1. Прописать в config.py:
   • Токен бота
   • ID админа (разработчика)
2. Создать базу данных и добавить туда разработчика как админа
3. Сделать config.py невидимым для git, чтобы случайно не запушить на сервер персональные настройки, что просто не безопасно

Все эти пункты выполняет:

py -m pdm --config YOUR_TOKEN

Если вы например забыли ввести токен, то вам будет предложено ввести его,
то есть комманда py -m pdm --config - коректна
Кстати, строка токена может быть указана:

• без кавычек - YOUR_TOKEN
• в кавычках - "YOUR_TOKEN" или 'YOUR_TOKEN'
• по ошибке содержать кавычки в любом месте:
  • "YOUR_TOKEN
  • YOU"R_TOKEN
  • YOUR_TOKEN"

И во всех случаях pdm.py правильно извлечёт строку токена.

Если вы случайно испортили config.py, то комманда ниже загружает старую версию config.py с сервера (ветка master):

py -m pdm --config reset

Если вам нужно внести изменения в config.py и запушить их на сервер, то комманда ниже делает этот файл видимым для git

py -m pdm --config visible

3. Настройка IDE:

Если вы работаете в Visual Studio Code, то все нужные настройки для него можно установить при помощи комманды:

py -m pdm --vscode

Если вы работает в PyCharm то нужно в настройках указать виртуальное окружение, где установлены нужные бибилиотеки:

Заходим в настройки

Ищем интерпретатор из виртуального окружения
Он расположен в зависимости от платформы внутри где-то (bdsm_bot/venv/.../python)
Или нам Pycharm сразу найдёт его

Не забываем нажать ОК или Apply

4. Запуск бота

Различается от IDE, главное помнить, что нужно запускать файл bot.py

Дополнительно

Пункты 1-3 можно объединить в одну комманду:
Создать виртуальное окружение и настроить бота и его config.py

py -m pdm --venv --config YOUR_TOKEN

Причём порядок следования аргументов не имеет значения. Можно писать как хочешь

py -m pdm --config --venv YOUR_TOKEN

py -m pdm --config YOUR_TOKEN --venv

py -m pdm YOUR_TOKEN --config --venv

Или в комманде просто не указывать токен, его потом предложат ввести

py -m pdm --config --venv

py -m pdm --venv --config