Feature/rename repo (#3)

* feat: rename project * feat: github actions * feat: github actions * feat: github actions * feat: github actions * fix: healthcheck template fix * fix: readme
ExpressApp · Oct 19, 2021 · 1f970f7 · 1f970f7
1 parent 398945a
commit 1f970f7
Show file tree

Hide file tree

Showing 64 changed files with 211 additions and 203 deletions.
diff --git a/.github/workflows/actions.yml b/.github/workflows/actions.yml
@@ -0,0 +1,67 @@
+name: Python application
+on: push
+jobs:
+
+  test:
+    name: Test
+    runs-on: ubuntu-20.04
+
+    services:
+      redis:
+        image: redis:6
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+      - name: Setup
+        uses: ExpressApp/[email protected]
+        with:
+          python-version: "3.9.6"
+          poetry-version: "1.1.6"
+
+      - name: Run tests
+        run: |
+          source .venv/bin/activate
+          ./scripts/test --cov-report=xml
+        env:
+          REDIS_DSN: redis://localhost/0
+          POSTGRES_DSN: postgresql://postgres:postgres@localhost/postgres
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          fail_ci_if_error: false
+          files: ./coverage.xml
+          flags: unittests
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Setup
+        uses: ExpressApp/[email protected]
+        with:
+          python-version: "3.9.6"
+          poetry-version: "1.1.6"
+
+      - name: Run lint
+        run: |
+          source .venv/bin/activate
+          ./scripts/lint
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,4 @@ dist/
 .pytest_cache/
 .mypy_cache/
 .idea/
-
+coverage.xml
diff --git a/README.md b/README.md
@@ -1,24 +1,24 @@
-# Boxv2
+# Asyncbox Framework
 
 ## Установка 
 
 1. Установка
 
     Склонировать репозиторий с исходниками
     ```bash
-    git clone https://github.com/ExpressApp/boxv2.git
+    git clone https://github.com/ExpressApp/asyncbox-framework.git
     ```
     Собрать пакет и установить его
     ```bash
-    cd boxv2
+    cd asyncbox-framework
     poetry build
-    pip install --user dist/boxv2-0.4.0-py3-none-any.whl
+    pip install --user dist/asyncbox-0.4.0-py3-none-any.whl
     ```
 
 2. Создание проекта из шаблона
 
     ```bash
-    boxv2 -v -t http://path/to/template -p plugin1 -p plugin2 bot_project_name
+    asyncbox -v -t http://path/to/template -p plugin1 -p plugin2 bot_project_name
     cd bot_project_name
     ```
 
@@ -27,11 +27,11 @@
     ```bash
     poetry install
     ```
-    Важно: библиотека boxv2 в созданном проекте будет установлена той версии, которя
+    Важно: библиотека asyncbox в созданном проекте будет установлена той версии, которя
     указана в шаблоне файла pyproject.toml. При необходимости вы можете указать нужную
     версию или ветку репозитория следующим образом: 
     ```
-    boxv2 = { git = "https://github.com/ExpressApp/boxv2.git", branch = "master"}
+    asyncbox = { git = "https://github.com/ExpressApp/asyncbox.git", branch = "master"}
     ```    
 
 4. Обновление
@@ -59,11 +59,11 @@
    
     | Путь                             | Описание
     -----------------------------------|:-----------------------------------
-    | boxv2.plugins.logger             | расширенное логирование (Loguru)
-    | boxv2.plugins.tortoise           | БД (PostgreSQL)
-    | boxv2.plugins.redis              | Redis
-    | boxv2.plugins.sentry             | мониторинг ошибок (Sentry)
-    | boxv2.plugins.prometheus         | сбор метрик (Prometheus)
+    | asyncbox.plugins.logger          | расширенное логирование (Loguru)
+    | asyncbox.plugins.sqlalchemy      | БД (PostgreSQL)
+    | asyncbox.plugins.redis           | Redis
+    | asyncbox.plugins.sentry          | мониторинг ошибок (Sentry)
+    | asyncbox.plugins.prometheus      | сбор метрик (Prometheus)
 
     Каждый из плагинов может требовать наличия определённых настроек. В этом случае
     необходимо добавить соответствующую настройку в класс AppSettings

diff --git a/asyncbox/__init__.py b/asyncbox/__init__.py
@@ -0,0 +1,3 @@
+from asyncbox.application import get_application
+
+__all__ = ["get_application"]
diff --git a/boxv2/__main__.py → asyncbox/__main__.py b/boxv2/__main__.py → asyncbox/__main__.py
@@ -1,4 +1,4 @@
 """Module as an executable magic file."""
-from boxv2.main import main
+from asyncbox.main import main
 
 main()
diff --git a/boxv2/application.py → asyncbox/application.py b/boxv2/application.py → asyncbox/application.py
@@ -7,10 +7,10 @@
 from botx import Bot, Collector
 from fastapi import FastAPI
 
-from boxv2.endpoints import get_router
-from boxv2.plugin import get_plugin_by_path
-from boxv2.settings import BaseAppSettings
-from boxv2.utils.import_utils import import_object
+from asyncbox.endpoints import get_router
+from asyncbox.plugin import get_plugin_by_path
+from asyncbox.settings import BaseAppSettings
+from asyncbox.utils.import_utils import import_object
 
 
 def get_application(settings: Optional[BaseAppSettings] = None) -> FastAPI:

diff --git a/boxv2/dependencies/__init__.py → asyncbox/dependencies/__init__.py b/boxv2/dependencies/__init__.py → asyncbox/dependencies/__init__.py
diff --git a/boxv2/dependencies/status_recipient.py → asyncbox/dependencies/status_recipient.py b/boxv2/dependencies/status_recipient.py → asyncbox/dependencies/status_recipient.py
diff --git a/boxv2/endpoints.py → asyncbox/endpoints.py b/boxv2/endpoints.py → asyncbox/endpoints.py
@@ -5,7 +5,7 @@
 from fastapi import APIRouter, Depends
 from starlette.status import HTTP_202_ACCEPTED
 
-from boxv2.dependencies.status_recipient import get_status_recipient
+from asyncbox.dependencies.status_recipient import get_status_recipient
 
 
 def get_router(bot: Bot) -> APIRouter:

diff --git a/boxv2/main.py → asyncbox/main.py b/boxv2/main.py → asyncbox/main.py
@@ -11,7 +11,7 @@
 from cookiecutter.main import cookiecutter  # type: ignore
 from loguru import logger
 
-from boxv2.plugin import get_plugin_by_path
+from asyncbox.plugin import get_plugin_by_path
 
 
 @click.command()
@@ -43,7 +43,7 @@ def render_plugins_template(plugin: str, extra_content: dict[str, Any]) -> None:
     temp_dir = Path(mkdtemp())
 
     try:
-        plugin_class = get_plugin_by_path(f"boxv2.plugins.{plugin}")
+        plugin_class = get_plugin_by_path(f"asyncbox.plugins.{plugin}")
     except ImportError:
         logger.warning(f"Plugin `{plugin}` not found.")
         return

diff --git a/boxv2/plugin.py → asyncbox/plugin.py b/boxv2/plugin.py → asyncbox/plugin.py
@@ -9,7 +9,7 @@
 from fastapi import FastAPI
 from pydantic import BaseModel, BaseSettings
 
-from boxv2.utils.import_utils import import_object
+from asyncbox.utils.import_utils import import_object
 
 
 class BasePluginSettings(BaseSettings):
@@ -64,10 +64,9 @@ def get_name(cls) -> str:
         """Get plugin's lowercase name."""
         module = inspect.getmodule(cls)
         if module is not None:
-            #
-            # boxv2.plugins.sqlalchemy.plugin.SQLAlchemyPlugin
-            #               ^
-            #               this part is using as name
+            # asyncbox.plugins.sqlalchemy.plugin.SQLAlchemyPlugin
+            #                  ^
+            #                  this part is using as name
             return module.__name__.split(".")[-2]
         return cls.__name__.lower()
 

diff --git a/boxv2/plugins/__init__.py → asyncbox/plugins/__init__.py b/boxv2/plugins/__init__.py → asyncbox/plugins/__init__.py
diff --git a/boxv2/plugins/debug/__init__.py → asyncbox/plugins/debug/__init__.py b/boxv2/plugins/debug/__init__.py → asyncbox/plugins/debug/__init__.py
diff --git a/boxv2/plugins/debug/commands.py → asyncbox/plugins/debug/commands.py b/boxv2/plugins/debug/commands.py → asyncbox/plugins/debug/commands.py
@@ -20,7 +20,7 @@ async def plugins(message: Message, bot: Bot) -> None:
         (plugin.get_name(), (await plugin.healthcheck()).json(indent=2))
         for plugin in bot.state.plugins
     ]
-    template = "**{name}**\n ```json\n{status}\n``` \n\n"
+    template = "**{name}**\n ```json\n{status}\n```"
     text = "\n\n".join(
         [template.format(name=name, status=status) for name, status in names_and_status]
     )

diff --git a/boxv2/plugins/debug/plugin.py → asyncbox/plugins/debug/plugin.py b/boxv2/plugins/debug/plugin.py → asyncbox/plugins/debug/plugin.py
@@ -2,8 +2,8 @@
 
 from typing import Any
 
-from boxv2.plugin import BasePlugin
-from boxv2.plugins.debug.commands import collector
+from asyncbox.plugin import BasePlugin
+from asyncbox.plugins.debug.commands import collector
 
 
 class DebugPlugin(BasePlugin):

diff --git a/boxv2/plugins/logger/__init__.py → asyncbox/plugins/logger/__init__.py b/boxv2/plugins/logger/__init__.py → asyncbox/plugins/logger/__init__.py
diff --git a/boxv2/plugins/logger/plugin.py → asyncbox/plugins/logger/plugin.py b/boxv2/plugins/logger/plugin.py → asyncbox/plugins/logger/plugin.py
@@ -9,7 +9,7 @@
 from loguru import logger
 from loguru._defaults import LOGURU_FORMAT  # noqa: WPS436
 
-from boxv2.plugin import BasePlugin, BasePluginSettings
+from asyncbox.plugin import BasePlugin, BasePluginSettings
 
 if TYPE_CHECKING:
     from loguru import Record  # noqa: WPS433  # pragma: no cover

diff --git a/boxv2/plugins/prometheus/__init__.py → asyncbox/plugins/prometheus/__init__.py b/boxv2/plugins/prometheus/__init__.py → asyncbox/plugins/prometheus/__init__.py
diff --git a/boxv2/plugins/prometheus/endpoint.py → asyncbox/plugins/prometheus/endpoint.py b/boxv2/plugins/prometheus/endpoint.py → asyncbox/plugins/prometheus/endpoint.py
diff --git a/boxv2/plugins/prometheus/middleware.py → asyncbox/plugins/prometheus/middleware.py b/boxv2/plugins/prometheus/middleware.py → asyncbox/plugins/prometheus/middleware.py
diff --git a/boxv2/plugins/prometheus/plugin.py → asyncbox/plugins/prometheus/plugin.py b/boxv2/plugins/prometheus/plugin.py → asyncbox/plugins/prometheus/plugin.py
@@ -2,9 +2,9 @@
 
 from typing import Any
 
-from boxv2.plugin import BasePlugin
-from boxv2.plugins.prometheus.endpoint import router
-from boxv2.plugins.prometheus.middleware import PrometheusMiddleware
+from asyncbox.plugin import BasePlugin
+from asyncbox.plugins.prometheus.endpoint import router
+from asyncbox.plugins.prometheus.middleware import PrometheusMiddleware
 
 
 class PrometheusPlugin(BasePlugin):

diff --git a/boxv2/plugins/redis/__init__.py → asyncbox/plugins/redis/__init__.py b/boxv2/plugins/redis/__init__.py → asyncbox/plugins/redis/__init__.py
diff --git a/boxv2/plugins/redis/plugin.py → asyncbox/plugins/redis/plugin.py b/boxv2/plugins/redis/plugin.py → asyncbox/plugins/redis/plugin.py
@@ -4,8 +4,8 @@
 
 from pydantic import RedisDsn
 
-from boxv2.plugin import BasePlugin, BasePluginSettings, HealtCheckData
-from boxv2.plugins.redis.repo import RedisRepo
+from asyncbox.plugin import BasePlugin, BasePluginSettings, HealtCheckData
+from asyncbox.plugins.redis.repo import RedisRepo
 
 
 class Settings(BasePluginSettings):

diff --git a/boxv2/plugins/redis/repo.py → asyncbox/plugins/redis/repo.py b/boxv2/plugins/redis/repo.py → asyncbox/plugins/redis/repo.py
diff --git a/boxv2/plugins/sentry/__init__.py → asyncbox/plugins/sentry/__init__.py b/boxv2/plugins/sentry/__init__.py → asyncbox/plugins/sentry/__init__.py
diff --git a/boxv2/plugins/sentry/middleware.py → asyncbox/plugins/sentry/middleware.py b/boxv2/plugins/sentry/middleware.py → asyncbox/plugins/sentry/middleware.py
diff --git a/boxv2/plugins/sentry/plugin.py → asyncbox/plugins/sentry/plugin.py b/boxv2/plugins/sentry/plugin.py → asyncbox/plugins/sentry/plugin.py
@@ -6,8 +6,8 @@
 from pydantic import AnyHttpUrl
 from sentry_sdk.integrations.asgi import SentryAsgiMiddleware  # type: ignore
 
-from boxv2.plugin import BasePlugin, BasePluginSettings
-from boxv2.plugins.sentry.middleware import SentryMiddleware
+from asyncbox.plugin import BasePlugin, BasePluginSettings
+from asyncbox.plugins.sentry.middleware import SentryMiddleware
 
 
 class Settings(BasePluginSettings):

diff --git a/boxv2/plugins/sqlalchemy/__init__.py → asyncbox/plugins/sqlalchemy/__init__.py b/boxv2/plugins/sqlalchemy/__init__.py → asyncbox/plugins/sqlalchemy/__init__.py
diff --git a/boxv2/plugins/sqlalchemy/plugin.py → asyncbox/plugins/sqlalchemy/plugin.py b/boxv2/plugins/sqlalchemy/plugin.py → asyncbox/plugins/sqlalchemy/plugin.py
@@ -5,8 +5,8 @@
 from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, create_async_engine
 from sqlalchemy.orm import sessionmaker
 
-from boxv2.plugin import BasePlugin, BasePluginSettings, HealtCheckData
-from boxv2.plugins.sqlalchemy.url_scheme_utils import make_url_async
+from asyncbox.plugin import BasePlugin, BasePluginSettings, HealtCheckData
+from asyncbox.plugins.sqlalchemy.url_scheme_utils import make_url_async
 
 
 class Settings(BasePluginSettings):
@@ -48,7 +48,7 @@ async def healthcheck(self) -> HealtCheckData:
             return HealtCheckData(healthy=False, information={"error": str(exc)})
         return HealtCheckData(
             healthy=True,
-            info={
+            information={
                 "server_version": rows.scalars().one(),
                 "dsn": self.settings.POSTGRES_DSN,
             },

diff --git a/...ins/sqlalchemy/template/cookiecutter.json → ...ins/sqlalchemy/template/cookiecutter.json b/...ins/sqlalchemy/template/cookiecutter.json → ...ins/sqlalchemy/template/cookiecutter.json
@@ -1,6 +1,6 @@
 {
-  "bot_name": "boxv2-bot",
-  "bot_display_name": "boxv2 bot",
+  "bot_name": "asyncbox-bot",
+  "bot_display_name": "asyncbox bot",
   "bot_short_description": "TODO",
   "bot_docs_link": "TODO",
   "test_cov": 0,

diff --git a/...ate/{{cookiecutter.bot_name}}/alembic.ini → ...ate/{{cookiecutter.bot_name}}/alembic.ini b/...ate/{{cookiecutter.bot_name}}/alembic.ini → ...ate/{{cookiecutter.bot_name}}/alembic.ini
diff --git a/...ookiecutter.bot_name}}/app/db/__init__.py → ...ookiecutter.bot_name}}/app/db/__init__.py b/...ookiecutter.bot_name}}/app/db/__init__.py → ...ookiecutter.bot_name}}/app/db/__init__.py
diff --git a/....bot_name}}/app/db/migrations/__init__.py → ....bot_name}}/app/db/migrations/__init__.py b/....bot_name}}/app/db/migrations/__init__.py → ....bot_name}}/app/db/migrations/__init__.py
diff --git a/...utter.bot_name}}/app/db/migrations/env.py → ...utter.bot_name}}/app/db/migrations/env.py b/...utter.bot_name}}/app/db/migrations/env.py → ...utter.bot_name}}/app/db/migrations/env.py
@@ -8,8 +8,8 @@
 # init config
 sys.path.append(str(pathlib.Path(__file__).resolve().parents[3]))
 
-from boxv2.application import get_app_settings  # isort:skip
-from boxv2.plugins.sqlalchemy.url_scheme_utils import make_url_sync  # isort:skip
+from asyncbox.application import get_app_settings  # isort:skip
+from asyncbox.plugins.sqlalchemy.url_scheme_utils import make_url_sync  # isort:skip
 from app.db.models import Base  # isort:skip
 
 postgres_dsn = make_url_sync(get_app_settings().POSTGRES_DSN)

diff --git a/...t_name}}/app/db/migrations/script.py.mako → ...t_name}}/app/db/migrations/script.py.mako b/...t_name}}/app/db/migrations/script.py.mako → ...t_name}}/app/db/migrations/script.py.mako
diff --git a/...}}/app/db/migrations/versions/__init__.py → ...}}/app/db/migrations/versions/__init__.py b/...}}/app/db/migrations/versions/__init__.py → ...}}/app/db/migrations/versions/__init__.py
diff --git a/...{cookiecutter.bot_name}}/app/db/models.py → ...{cookiecutter.bot_name}}/app/db/models.py b/...{cookiecutter.bot_name}}/app/db/models.py → ...{cookiecutter.bot_name}}/app/db/models.py
diff --git a/boxv2/plugins/sqlalchemy/url_scheme_utils.py → ...ox/plugins/sqlalchemy/url_scheme_utils.py b/boxv2/plugins/sqlalchemy/url_scheme_utils.py → ...ox/plugins/sqlalchemy/url_scheme_utils.py
diff --git a/boxv2/py.typed → asyncbox/py.typed b/boxv2/py.typed → asyncbox/py.typed
diff --git a/boxv2/settings.py → asyncbox/settings.py b/boxv2/settings.py → asyncbox/settings.py
@@ -13,9 +13,9 @@ class Config:  # noqa: WPS431
         env_file = ".env"
         json_loads = lambda x: x  # noqa: E731,WPS111
 
-    NAME = "boxv2"
+    NAME = "asyncbox"
 
-    PLUGINS = ["boxv2.plugins.tortoise"]
+    PLUGINS = ["asyncbox.plugins.tortoise"]
     COLLECTORS: List[str] = []
 
     # base kwargs

diff --git a/boxv2/template/cookiecutter.json → asyncbox/template/cookiecutter.json b/boxv2/template/cookiecutter.json → asyncbox/template/cookiecutter.json
@@ -1,6 +1,6 @@
 {
-  "bot_name": "boxv2-bot",
-  "bot_display_name": "boxv2 bot",
+  "bot_name": "asyncbox-bot",
+  "bot_display_name": "asyncbox bot",
   "bot_short_description": "TODO",
   "bot_docs_link": "TODO",
   "test_cov": 0,

diff --git a/...{{cookiecutter.bot_name}}/app/__init__.py → ...{{cookiecutter.bot_name}}/app/__init__.py b/...{{cookiecutter.bot_name}}/app/__init__.py → ...{{cookiecutter.bot_name}}/app/__init__.py
diff --git a/...{{cookiecutter.bot_name}}/app/commands.py → ...{{cookiecutter.bot_name}}/app/commands.py b/...{{cookiecutter.bot_name}}/app/commands.py → ...{{cookiecutter.bot_name}}/app/commands.py
diff --git a/...ate/{{cookiecutter.bot_name}}/app/main.py → ...ate/{{cookiecutter.bot_name}}/app/main.py b/...ate/{{cookiecutter.bot_name}}/app/main.py → ...ate/{{cookiecutter.bot_name}}/app/main.py
@@ -1,5 +1,5 @@
 """Main module."""
 
-from boxv2 import get_application  # pragma: no cover
+from asyncbox import get_application  # pragma: no cover
 
 app = get_application()  # pragma: no cover
diff --git a/...{{cookiecutter.bot_name}}/app/settings.py → ...{{cookiecutter.bot_name}}/app/settings.py b/...{{cookiecutter.bot_name}}/app/settings.py → ...{{cookiecutter.bot_name}}/app/settings.py
@@ -2,7 +2,7 @@
 
 from typing import List
 
-from boxv2.settings import BaseAppSettings
+from asyncbox.settings import BaseAppSettings
 
 
 class AppSettings(BaseAppSettings):
@@ -11,7 +11,7 @@ class AppSettings(BaseAppSettings):
     NAME = "{{cookiecutter.bot_name}}"
     PLUGINS: List[str] = [
         {% for plugin in cookiecutter.plugins.plugins_list %}
-        "boxv2.plugins.{{ plugin }}",
+        "asyncbox.plugins.{{ plugin }}",
         {% endfor %}
     ]
     COLLECTORS: List[str] = [

diff --git a/.../{{cookiecutter.bot_name}}/pyproject.toml → .../{{cookiecutter.bot_name}}/pyproject.toml b/.../{{cookiecutter.bot_name}}/pyproject.toml → .../{{cookiecutter.bot_name}}/pyproject.toml
@@ -8,7 +8,7 @@ authors = []
 
 [tool.poetry.dependencies]
 python = ">=3.9,<3.10"
-boxv2 = { git = "https://github.com/ExpressApp/boxv2.git", tag = "0.4.0"}
+asyncbox = { git = "https://github.com/ExpressApp/asyncbox-framework.git", tag = "0.4.0"}
 
 [tool.poetry.dev-dependencies]
 black = "~20.8b1"

diff --git a/boxv2/tests/__init__.py → asyncbox/tests/__init__.py b/boxv2/tests/__init__.py → asyncbox/tests/__init__.py
diff --git a/boxv2/tests/fixtures.py → asyncbox/tests/fixtures.py b/boxv2/tests/fixtures.py → asyncbox/tests/fixtures.py
@@ -14,7 +14,7 @@
 from fastapi import FastAPI
 from pytest_cov.plugin import StoreReport
 
-from boxv2 import get_application
+from asyncbox import get_application
 
 
 @pytest.fixture(scope="session")

diff --git a/boxv2/utils/__init__.py → asyncbox/utils/__init__.py b/boxv2/utils/__init__.py → asyncbox/utils/__init__.py
diff --git a/boxv2/utils/import_utils.py → asyncbox/utils/import_utils.py b/boxv2/utils/import_utils.py → asyncbox/utils/import_utils.py
diff --git a/boxv2/utils/mako.py → asyncbox/utils/mako.py b/boxv2/utils/mako.py → asyncbox/utils/mako.py
diff --git a/boxv2/__init__.py b/boxv2/__init__.py
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		from asyncbox.application import get_application

		__all__ = ["get_application"]