{"id":24350965,"url":"https://github.com/nomilkinmyhome/vkbottle_bot_architecture_example","last_synced_at":"2025-04-09T23:13:05.766Z","repository":{"id":48856421,"uuid":"329095211","full_name":"nomilkinmyhome/vkbottle_bot_architecture_example","owner":"nomilkinmyhome","description":"Пример архитектуры проектов на VKBottle 3.0","archived":false,"fork":false,"pushed_at":"2021-07-08T12:37:55.000Z","size":38,"stargazers_count":27,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T23:12:58.147Z","etag":null,"topics":["bot","example","vkbottle"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nomilkinmyhome.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-12T19:48:16.000Z","updated_at":"2025-02-28T12:31:29.000Z","dependencies_parsed_at":"2022-09-03T15:10:51.329Z","dependency_job_id":null,"html_url":"https://github.com/nomilkinmyhome/vkbottle_bot_architecture_example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nomilkinmyhome%2Fvkbottle_bot_architecture_example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nomilkinmyhome%2Fvkbottle_bot_architecture_example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nomilkinmyhome%2Fvkbottle_bot_architecture_example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nomilkinmyhome%2Fvkbottle_bot_architecture_example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nomilkinmyhome","download_url":"https://codeload.github.com/nomilkinmyhome/vkbottle_bot_architecture_example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248125589,"owners_count":21051770,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","example","vkbottle"],"created_at":"2025-01-18T14:44:55.111Z","updated_at":"2025-04-09T23:13:05.747Z","avatar_url":"https://github.com/nomilkinmyhome.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## VKBottle bot architecture example\r\n\r\nПример приемлемой на мой взгляд архитектуры проекта с использованием VKBottle 3.0\r\n\r\nПоскольку это всего лишь пример, а не реальный проект, местами я использую громоздкие конструкции для маленьких вещей (use_cases, repositories). \r\nВ реальных проектах в этих местах будет значительно больше кода, так что применение именно такого стиля будет оправдано. \r\n\r\n---\r\n\r\n### Навигация:\r\n\r\nВ пакете src основной код проекта. Его содержимое:\r\n\r\n- \\_\\_main\\_\\_.py - точка входа. Содержит только экземпляр бота и его запуск.\r\n- app.py - модуль, в котором происходит сборка приложения. \r\n- config.py - конфигурация проекта, которая берется из переменных окружения. Рядом с .env.example нужно обязательно создать .env-файл с перечнем необходимых констант.\r\n- models - пакет с моделями и всем, что относится к работе с базой данных.\r\n- blueprints - разделение кода на логические части.\r\n- repositories - реализация паттерна Repository.\r\n- use_cases - бизнес-логика.\r\n- initialize.py - подготовка БД к первому запуску проекта.\r\n\r\nВ tests содержатся тесты. В этом примере они больше формальные, у меня не было цели что-то и правда протестировать.\r\nМне хотелось показать как в принципе в подобном проекте должны выглядеть тесты и где они должны лежать.\r\nПро архитектуру самих тестов можно прочитать в \"Python Testing with Pytest: Simple, Rapid, Effective, and Scalable\".\r\n\r\n### Запуск:\r\n\r\n1. Запуск бота вместе с БД через `docker-compose` \r\n```bash\r\n# Сборка и запуск контейнеров\r\ndocker-compose up --build\r\n# Сборка и запуск контейнеров в фоновом режиме\r\ndocker-compose up --build -d\r\n# Остановить контейнеры поле запуска в фоновом режиме\r\ndocker-compose down\r\n```\r\n2. Сборка и запуск контейнера через Docker\r\n```bash\r\ndocker build -t vkbottle-example .\r\ndocker run vkbottle-example\r\n# Или\r\ndocker run -d vkbottle-example\r\n# Для запуска в фоновом режиме\r\n```\r\n3. Ручной запуск через `python -m src`\r\n\r\nPR, код-ревью и любая критика приветствуются.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnomilkinmyhome%2Fvkbottle_bot_architecture_example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnomilkinmyhome%2Fvkbottle_bot_architecture_example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnomilkinmyhome%2Fvkbottle_bot_architecture_example/lists"}