diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b422198 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +users.db +config.py +venv +myvenv +.env +.idea +__pycache__ +config.cpython-313.pyc \ No newline at end of file diff --git a/README.md b/README.md index a6c6d3f..457859b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,75 @@ -#python 3.10 +# simple_sql_tg_bot -1. пропишите pip install -r req.txt +### Клонирование проекта ### -2. перед запуском вставьте токен в файле config.py +```commandline +git clone https://git.itguild.info/sementodrik/simple_sql_tg_bot.git +cd simple_sql_tg_bot +``` +Клонируем проект и переходим в нужную директорию. -3. для запуска бота запустите файл bot.py +
+ +### Создание виртуального окружения (venv) ### + +```commandline +python3 -m venv myenv +``` + +```myenv``` - это имя вашего виртуального окружения, можно выбрать любое. + +Если вы используете **windows(CMD)** то используйте команды с написание ```python``` вместо ```python3``` + +```commandline +python -m venv myenv +``` + +
+ +### Активация виртуального окружения ### + +#### Windows (CMD): #### + +```commandline +myenv\Scripts\activate +``` + +если команда выше выдаёт ошибку, то попробуйте вариант ниже + +```commandline +.\myenv\Scripts\activate.bat +``` + +#### Windows (PowerShell): #### + +```commandline +.\myenv\Scripts\Activate.ps1 +``` + +#### Linux/macOS: #### + +```commandline +source myenv/bin/activate +``` + +
+ +### Установка зависимостей ### + +```commandline +python3 -m pip install -r req.txt +``` + +
+ +После того как вы установите зависимости необходимо будет настроить конфигурационный файл. +Для этого вам нужно зайти в ```config.py``` и вписать токен своего бота + +``` +TOKEN='XXX:YYY' +``` + +Теперь нам осталось только запустить бот: +``` +python3 bot.py +``` \ No newline at end of file