arpakitlib 1.7.103__py3-none-any.whl → 1.7.132__py3-none-any.whl

arpakitlib/_arpakit_project_template/README.md

@@ -1,6 +1,4 @@
-# {PROJECT_NAME}
-
-...
+# {{PROJECT_NAME}}
 
 ## ❤️ Made by ARPAKIT Company ❤️
 

arpakitlib/_arpakit_project_template/example.env

@@ -1,4 +1,6 @@
 # mode_type=
+# project_name=
+# sql_db_port=
 # sql_db_url=
 # sql_db_echo=
 # api_init_sql_db_at_start=
@@ -9,6 +11,8 @@
 # api_start_scheduled_operation_creator_worker=
 # api_port=
 # api_correct_api_key=
+# api_correct_token=
+# api_enable_admin1=
 # var_dirname=
 # var_dirpath=
 # log_filename=
@@ -20,3 +24,4 @@
 # dump_dirname=
 # dump_dirpath=
 # local_timezone=
+# admin1_secret_key=

arpakitlib/_arpakit_project_template/manage/docker_run_postgres_for_dev.sh

@@ -1,4 +1,4 @@
 cd ..
-docker rm {PROJECT_NAME}_postgres
-docker run --name {PROJECT_NAME}_postgres -d -p {SQL_DB_PORT}:5432 -e POSTGRES_USER={PROJECT_NAME} -e POSTGRES_PASSWORD={PROJECT_NAME} -e POSTGRES_DB={PROJECT_NAME} postgres:16 -c max_connections=100
-docker start {PROJECT_NAME}_postgres
+docker rm {{PROJECT_NAME}}_postgres
+docker run --name {{PROJECT_NAME}}_postgres -d -p {{SQL_DB_PORT}}:5432 -e POSTGRES_USER={{PROJECT_NAME}} -e POSTGRES_PASSWORD={{PROJECT_NAME}} -e POSTGRES_DB={{PROJECT_NAME}} postgres:16 -c max_connections=100
+docker start {{PROJECT_NAME}}_postgres

arpakitlib/_arpakit_project_template/manage/docker_start_postgres_for_dev.sh

@@ -1,2 +1,2 @@
 cd ..
-docker start {PROJECT_NAME}_postgres
+docker start {{PROJECT_NAME}}_postgres

arpakitlib/_arpakit_project_template/manage/docker_stop_postgres_for_dev.sh

@@ -1,2 +1,2 @@
 cd ..
-docker stop {PROJECT_NAME}_postgres
+docker stop {{PROJECT_NAME}}_postgres

arpakitlib/_arpakit_project_template/manage/git_set_arpakit_company_origin.sh

@@ -1,7 +1,7 @@
 cd ..
 
 git remote remove arpakit_company_github_1
-git remote add arpakit_company_github_1 git@github.com:ARPAKIT-Company/{PROJECT_NAME}.git
+git remote add arpakit_company_github_1 git@github.com:ARPAKIT-Company/{{PROJECT_NAME}}.git
 
 git remote remove arpakit_company_gitlab_1
-git remote add arpakit_company_gitlab_1 git@gitlab.com:ARPAKIT-Company/{PROJECT_NAME}.git
+git remote add arpakit_company_gitlab_1 git@gitlab.com:ARPAKIT-Company/{{PROJECT_NAME}}.git

arpakitlib/_arpakit_project_template/manage/git_set_arpakit_origin.sh

@@ -1,7 +1,7 @@
 cd ..
 
 git remote remove arpakit_github_1
-git remote add arpakit_github_1 git@github.com:arpakit/{PROJECT_NAME}.git
+git remote add arpakit_github_1 git@github.com:arpakit/{{PROJECT_NAME}}.git
 
 git remote remove arpakit_gitlab_1
-git remote add arpakit_gitlab_1 git@gitlab.com:arpakit/{PROJECT_NAME}.git
+git remote add arpakit_gitlab_1 git@gitlab.com:arpakit/{{PROJECT_NAME}}.git

arpakitlib/_arpakit_project_template/manage/hello_world.py

@@ -1,6 +1,6 @@
-def command():
+def __hello_world():
     print("Hello world")
 
 
 if __name__ == '__main__':
-    command()
+    __hello_world()

arpakitlib/_arpakit_project_template/manage/{json_beutify.py → json_beautify.py}

@@ -1,10 +1,10 @@
 from arpakitlib.ar_json_util import safely_transfer_str_to_json_obj_to_json_str
 
 
-def command():
+def __json_beautify():
     s = input("JSON:\n")
     print(safely_transfer_str_to_json_obj_to_json_str(s))
 
 
 if __name__ == '__main__':
-    command()
+    __json_beautify()

arpakitlib/_arpakit_project_template/manage/poetry_config.sh

@@ -0,0 +1,2 @@
+cd ..
+poetry config --list

arpakitlib/_arpakit_project_template/manage/poetry_self_add_plugin_export.sh

@@ -0,0 +1,2 @@
+cd ..
+poetry self add poetry-plugin-export

arpakitlib/_arpakit_project_template/manage/poetry_show_arpakitlib.sh

@@ -1,2 +1,2 @@
 cd ..
-poetry show arpakitlib --no-dev
+poetry show arpakitlib --latest

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_1.py

@@ -1,14 +1,14 @@
 import asyncio
 
 
-def command():
+def __sandbox():
     pass
 
 
-async def async_command():
+async def __async_sandbox():
     pass
 
 
 if __name__ == '__main__':
-    command()
-    asyncio.run(async_command())
+    __sandbox()
+    asyncio.run(__async_sandbox())

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_2.py

@@ -1,14 +1,14 @@
 import asyncio
 
 
-def command():
+def __sandbox():
     pass
 
 
-async def async_command():
+async def __async_sandbox():
     pass
 
 
 if __name__ == '__main__':
-    command()
-    asyncio.run(async_command())
+    __sandbox()
+    asyncio.run(__async_sandbox())

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_3.py

@@ -1,14 +1,14 @@
 import asyncio
 
 
-def command():
+def __sandbox():
     pass
 
 
-async def async_command():
+async def __async_sandbox():
     pass
 
 
 if __name__ == '__main__':
-    command()
-    asyncio.run(async_command())
+    __sandbox()
+    asyncio.run(__async_sandbox())

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_4.py

@@ -1,14 +1,14 @@
 import asyncio
 
 
-def command():
+def __sandbox():
     pass
 
 
-async def async_command():
+async def __async_sandbox():
     pass
 
 
 if __name__ == '__main__':
-    command()
-    asyncio.run(async_command())
+    __sandbox()
+    asyncio.run(__async_sandbox())

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_5.py

@@ -1,14 +1,14 @@
 import asyncio
 
 
-def command():
+def __sandbox():
     pass
 
 
-async def async_command():
+async def __async_sandbox():
     pass
 
 
 if __name__ == '__main__':
-    command()
-    asyncio.run(async_command())
+    __sandbox()
+    asyncio.run(__async_sandbox())

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_6.py

@@ -1,14 +1,14 @@
 import asyncio
 
 
-def command():
+def __sandbox():
     pass
 
 
-async def async_command():
+async def __async_sandbox():
     pass
 
 
 if __name__ == '__main__':
-    command()
-    asyncio.run(async_command())
+    __sandbox()
+    asyncio.run(__async_sandbox())

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_7.py

@@ -1,14 +1,14 @@
 import asyncio
 
 
-def command():
+def __sandbox():
     pass
 
 
-async def async_command():
+async def __async_sandbox():
     pass
 
 
 if __name__ == '__main__':
-    command()
-    asyncio.run(async_command())
+    __sandbox()
+    asyncio.run(__async_sandbox())

arpakitlib/_arpakit_project_template/src/admin1/add_admin_in_app.py

@@ -0,0 +1,26 @@
+from fastapi import FastAPI
+from sqladmin import Admin
+
+from src.admin1.admin_auth import AdminAuth
+from src.admin1.model_view import MODEL_VIEWS
+from src.api.transmitted_api_data import TransmittedAPIData
+from src.core.settings import get_cached_settings
+
+
+def add_admin1_in_app(*, app: FastAPI) -> FastAPI:
+    transmitted_api_data: TransmittedAPIData = app.state.transmitted_api_data
+
+    authentication_backend = AdminAuth()
+
+    admin = Admin(
+        app=app,
+        engine=transmitted_api_data.sqlalchemy_db.engine,
+        base_url="/admin1",
+        authentication_backend=authentication_backend,
+        title=get_cached_settings().project_name
+    )
+
+    for model_view in MODEL_VIEWS:
+        admin.add_model_view(model_view)
+
+    return app

arpakitlib/_arpakit_project_template/src/admin1/admin_auth.py

@@ -0,0 +1,29 @@
+import logging
+
+from sqladmin.authentication import AuthenticationBackend
+from starlette.requests import Request
+
+from src.core.settings import get_cached_settings
+
+
+class AdminAuth(AuthenticationBackend):
+    def __init__(self):
+        self._logger = logging.getLogger(self.__class__.__name__)
+        super().__init__(secret_key=get_cached_settings().admin1_secret_key)
+
+    async def login(self, request: Request) -> bool:
+        # ...
+        # form = await request.form()
+        # request.session.update(...)
+        # ...
+        return True
+
+    async def logout(self, request: Request) -> bool:
+        request.session.clear()
+        return True
+
+    async def authenticate(self, request: Request) -> bool:
+        # ...
+        # request.session.get("...")
+        # ...
+        return True

arpakitlib/_arpakit_project_template/src/admin1/model_view.py

@@ -0,0 +1,19 @@
+from sqladmin import ModelView
+
+
+class BaseModelView(ModelView):
+    can_create = True
+    can_edit = True
+    can_delete = True
+    can_view_details = True
+    can_export = True
+    page_size = 50
+    page_size_options = [25, 50, 100, 200]
+    save_as = True
+    save_as_continue = True
+    export_types = ["xlsx", "csv", "json"]
+
+
+MODEL_VIEWS = []
+
+# ...

arpakitlib/_arpakit_project_template/src/api/create_api_app.py

@@ -1,22 +1,17 @@
 from fastapi import FastAPI
 
-from arpakitlib.ar_base_worker_util import SafeRunInBackgroundModes
-from arpakitlib.ar_fastapi_util import create_fastapi_app, InitSqlalchemyDBStartupAPIEvent, InitFileStoragesInDir, \
-    create_handle_exception, create_story_log_before_response_in_handle_exception, DEFAULT_CONTACT, \
-    SafeRunWorkerStartupAPIEvent
-from arpakitlib.ar_operation_execution_util import OperationExecutorWorker, ScheduledOperationCreatorWorker
+from arpakitlib.ar_fastapi_util import create_fastapi_app, \
+    create_handle_exception, create_story_log_before_response_in_handle_exception
 from arpakitlib.ar_sqlalchemy_util import SQLAlchemyDB
 from arpakitlib.ar_type_util import raise_for_type
 from src.api.event import StartupAPIEvent, ShutdownAPIEvent
 from src.api.router.main_router import main_api_router
 from src.api.transmitted_api_data import TransmittedAPIData
-from src.core.const import STATIC_DIRPATH
+from src.core.const import ProjectPaths
 from src.core.settings import get_cached_settings
-from src.core.util import get_cached_media_file_storage_in_dir, \
-    get_cached_cache_file_storage_in_dir, get_cached_dump_file_storage_in_dir, setup_logging
+from src.core.util import setup_logging, get_cached_media_file_storage_in_dir, get_cached_cache_file_storage_in_dir, \
+    get_cached_dump_file_storage_in_dir
 from src.db.util import get_cached_sqlalchemy_db
-from src.operation_execution.operation_executor import OperationExecutor
-from src.operation_execution.scheduled_operations import ALL_SCHEDULED_OPERATIONS
 
 
 def create_api_app() -> FastAPI:
@@ -28,7 +23,10 @@ def create_api_app() -> FastAPI:
 
     transmitted_api_data = TransmittedAPIData(
         settings=settings,
-        sqlalchemy_db=sqlalchemy_db
+        sqlalchemy_db=sqlalchemy_db,
+        media_file_storage_in_dir=get_cached_media_file_storage_in_dir(),
+        cache_file_storage_in_dir=get_cached_cache_file_storage_in_dir(),
+        dump_file_storage_in_dir=get_cached_dump_file_storage_in_dir()
     )
 
     funcs_before_response = []
@@ -49,49 +47,8 @@ def create_api_app() -> FastAPI:
 
     startup_api_events = []
 
-    startup_api_events.append(InitFileStoragesInDir(
-        file_storages_in_dir=[
-            get_cached_media_file_storage_in_dir() if settings.media_dirpath is not None else None,
-            get_cached_cache_file_storage_in_dir() if settings.cache_dirpath is not None else None,
-            get_cached_dump_file_storage_in_dir() if settings.dump_dirpath is not None else None
-        ]
-    ))
-
-    if settings.api_init_sql_db_at_start:
-        raise_for_type(sqlalchemy_db, SQLAlchemyDB)
-        startup_api_events.append(InitSqlalchemyDBStartupAPIEvent(sqlalchemy_db=sqlalchemy_db))
-
     startup_api_events.append(StartupAPIEvent(transmitted_api_data=transmitted_api_data))
 
-    if settings.api_start_operation_executor_worker:
-        raise_for_type(sqlalchemy_db, SQLAlchemyDB)
-        startup_api_events.append(
-            SafeRunWorkerStartupAPIEvent(
-                workers=[
-                    OperationExecutorWorker(
-                        sqlalchemy_db=sqlalchemy_db,
-                        operation_executor=OperationExecutor(sqlalchemy_db=sqlalchemy_db),
-                        filter_operation_types=None
-                    )
-                ],
-                safe_run_in_background_mode=SafeRunInBackgroundModes.async_task
-            )
-        )
-
-    if settings.api_start_scheduled_operation_creator_worker:
-        raise_for_type(sqlalchemy_db, SQLAlchemyDB)
-        startup_api_events.append(
-            SafeRunWorkerStartupAPIEvent(
-                workers=[
-                    ScheduledOperationCreatorWorker(
-                        sqlalchemy_db=sqlalchemy_db,
-                        scheduled_operations=ALL_SCHEDULED_OPERATIONS
-                    )
-                ],
-                safe_run_in_background_mode=SafeRunInBackgroundModes.async_task
-            )
-        )
-
     shutdown_api_events = []
 
     shutdown_api_events.append(ShutdownAPIEvent(transmitted_api_data=transmitted_api_data))
@@ -105,11 +62,14 @@ def create_api_app() -> FastAPI:
         shutdown_api_events=shutdown_api_events,
         transmitted_api_data=transmitted_api_data,
         main_api_router=main_api_router,
-        contact=DEFAULT_CONTACT,
         media_dirpath=settings.media_dirpath,
-        static_dirpath=STATIC_DIRPATH
+        static_dirpath=ProjectPaths.static_dirpath
     )
 
+    if settings.api_enable_admin1:
+        from src.admin1.add_admin_in_app import add_admin1_in_app
+        add_admin1_in_app(app=api_app)
+
     return api_app
 
 

arpakitlib/_arpakit_project_template/src/api/event.py

@@ -1,5 +1,11 @@
+from arpakitlib.ar_base_worker_util import safe_run_worker_in_background, SafeRunInBackgroundModes
 from arpakitlib.ar_fastapi_util import BaseStartupAPIEvent, BaseShutdownAPIEvent
+from arpakitlib.ar_operation_execution_util import OperationExecutorWorker, ScheduledOperationCreatorWorker
+from arpakitlib.ar_sqlalchemy_util import SQLAlchemyDB
+from arpakitlib.ar_type_util import raise_for_type
 from src.api.transmitted_api_data import TransmittedAPIData
+from src.operation_execution.operation_executor import OperationExecutor
+from src.operation_execution.scheduled_operations import SCHEDULED_OPERATIONS
 
 
 class StartupAPIEvent(BaseStartupAPIEvent):
@@ -8,7 +14,49 @@ class StartupAPIEvent(BaseStartupAPIEvent):
         self.transmitted_api_data = transmitted_api_data
 
     async def async_on_startup(self, *args, **kwargs):
-        self._logger.info(self.__class__.__name__)
+        self._logger.info("start")
+
+        if self.transmitted_api_data.media_file_storage_in_dir is not None:
+            self.transmitted_api_data.media_file_storage_in_dir.init()
+
+        if self.transmitted_api_data.cache_file_storage_in_dir is not None:
+            self.transmitted_api_data.cache_file_storage_in_dir.init()
+
+        if self.transmitted_api_data.dump_file_storage_in_dir is not None:
+            self.transmitted_api_data.dump_file_storage_in_dir.init()
+
+        if self.transmitted_api_data.settings.api_init_sql_db_at_start:
+            raise_for_type(self.transmitted_api_data.sqlalchemy_db, SQLAlchemyDB)
+            self.transmitted_api_data.sqlalchemy_db.init()
+
+        if self.transmitted_api_data.settings.api_start_operation_executor_worker:
+            raise_for_type(self.transmitted_api_data.sqlalchemy_db, SQLAlchemyDB)
+            _ = safe_run_worker_in_background(
+                worker=OperationExecutorWorker(
+                    sqlalchemy_db=self.transmitted_api_data.sqlalchemy_db,
+                    operation_executor=OperationExecutor(sqlalchemy_db=self.transmitted_api_data.sqlalchemy_db),
+                    filter_operation_types=None,
+                    startup_funcs=[
+                        self.transmitted_api_data.sqlalchemy_db.init
+                    ]
+                ),
+                mode=SafeRunInBackgroundModes.thread
+            )
+
+        if self.transmitted_api_data.settings.api_start_scheduled_operation_creator_worker:
+            raise_for_type(self.transmitted_api_data.sqlalchemy_db, SQLAlchemyDB)
+            _ = safe_run_worker_in_background(
+                worker=ScheduledOperationCreatorWorker(
+                    sqlalchemy_db=self.transmitted_api_data.sqlalchemy_db,
+                    scheduled_operations=SCHEDULED_OPERATIONS,
+                    startup_funcs=[
+                        self.transmitted_api_data.sqlalchemy_db.init
+                    ]
+                ),
+                mode=SafeRunInBackgroundModes.async_task
+            )
+
+        self._logger.info("finish")
 
 
 class ShutdownAPIEvent(BaseShutdownAPIEvent):
@@ -17,4 +65,5 @@ class ShutdownAPIEvent(BaseShutdownAPIEvent):
         self.transmitted_api_data = transmitted_api_data
 
     async def async_on_shutdown(self, *args, **kwargs):
-        self._logger.info(self.__class__.__name__)
+        self._logger.info("start")
+        self._logger.info("finish")

arpakitlib/_arpakit_project_template/src/api/start_api_for_dev_with_reload.py

@@ -1,9 +1,17 @@
-from src.api.start_api_for_dev import start_api_for_dev
+import uvicorn
 
+from src.core.settings import get_cached_settings
 
-def command():
-    start_api_for_dev(reload=True)
+
+def __command():
+    uvicorn.run(
+        "src.api.asgi:app",
+        port=get_cached_settings().api_port,
+        host="localhost",
+        workers=1,
+        reload=True
+    )
 
 
 if __name__ == '__main__':
-    command()
+    __command()

arpakitlib/_arpakit_project_template/src/api/{start_api_for_dev.py → start_api_for_dev_without_reload.py}

@@ -3,15 +3,15 @@ import uvicorn
 from src.core.settings import get_cached_settings
 
 
-def start_api_for_dev(*, reload: bool = False):
+def __command():
     uvicorn.run(
         "src.api.asgi:app",
         port=get_cached_settings().api_port,
         host="localhost",
         workers=1,
-        reload=reload
+        reload=False
     )
 
 
 if __name__ == '__main__':
-    start_api_for_dev(reload=False)
+    __command()

arpakitlib/_arpakit_project_template/src/api/transmitted_api_data.py

@@ -1,4 +1,5 @@
 from arpakitlib.ar_fastapi_util import BaseTransmittedAPIData
+from arpakitlib.ar_file_storage_in_dir_util import FileStorageInDir
 from arpakitlib.ar_sqlalchemy_util import SQLAlchemyDB
 
 from src.core.settings import Settings
@@ -7,3 +8,6 @@ from src.core.settings import Settings
 class TransmittedAPIData(BaseTransmittedAPIData):
     settings: Settings
     sqlalchemy_db: SQLAlchemyDB | None = None
+    media_file_storage_in_dir: FileStorageInDir | None = None
+    cache_file_storage_in_dir: FileStorageInDir | None = None
+    dump_file_storage_in_dir: FileStorageInDir | None = None

arpakitlib/_arpakit_project_template/src/business_service/hello_world.py

@@ -0,0 +1,12 @@
+import logging
+
+_logger = logging.getLogger(__name__)
+
+
+def hello_world() -> str:
+    _logger.info("hello world")
+    return "Hello world"
+
+
+if __name__ == '__main__':
+    print(hello_world())

arpakitlib/_arpakit_project_template/{manage/logging_check.py → src/core/check_logging.py}

@@ -5,10 +5,10 @@ from src.core.util import setup_logging
 _logger = logging.getLogger(__name__)
 
 
-def command():
+def __check_logging():
     setup_logging()
-    _logger.info("checking logging")
+    _logger.info("logging is good")
 
 
 if __name__ == '__main__':
-    command()
+    __check_logging()

arpakitlib/_arpakit_project_template/{manage/settings_check.py → src/core/check_settings.py}

@@ -1,8 +1,10 @@
 from arpakitlib.ar_json_util import safely_transfer_obj_to_json_str
 from src.core.settings import get_cached_settings
+from src.core.util import setup_logging
 
 
 def command():
+    setup_logging()
     print(safely_transfer_obj_to_json_str(get_cached_settings().model_dump(mode="json")))