arpakitlib 1.7.66__py3-none-any.whl → 1.7.124__py3-none-any.whl

arpakitlib/_arpakit_project_template/example.env

@@ -1,4 +1,5 @@
 # mode_type=
+# project_name=
 # sql_db_url=
 # sql_db_echo=
 # api_init_sql_db_at_start=
@@ -9,6 +10,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 +23,4 @@
 # dump_dirname=
 # dump_dirpath=
 # local_timezone=
+# admin1_secret_key=

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

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

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/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/resource/static/healthcheck

@@ -0,0 +1 @@
+Healthcheck

arpakitlib/_arpakit_project_template/src/admin1/add_admin_in_app.py

@@ -0,0 +1,25 @@
+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
+
+
+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="{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/auth.py

@@ -1,6 +1 @@
-from arpakitlib.ar_fastapi_util import is_api_key_correct_api_auth
-from src.core.settings import get_cached_settings
-
-check_with_settings_is_api_key_correct_api_auth = is_api_key_correct_api_auth(
-    correct_api_key=get_cached_settings().api_correct_api_key
-)
+# ...

arpakitlib/_arpakit_project_template/src/api/create_api_app.py

@@ -1,10 +1,7 @@
 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
@@ -12,10 +9,9 @@ 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.settings import get_cached_settings
-from src.core.util import get_cached_sqlalchemy_db, 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.operation_execution.operation_executor import OperationExecutor
-from src.operation_execution.scheduled_operations import ALL_SCHEDULED_OPERATIONS
+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
 
 
 def create_api_app() -> FastAPI:
@@ -27,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 = []
@@ -48,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))
@@ -104,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
     )
 
+    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/router/main_router.py

@@ -3,6 +3,9 @@ from fastapi import APIRouter
 from src.api.router.v1.main_router import main_v1_api_router
 
 main_api_router = APIRouter()
+
+# API Error Info
+
 main_api_router.include_router(
     router=main_v1_api_router,
     prefix="/api/v1"

arpakitlib/_arpakit_project_template/src/api/router/v1/get_api_error_info.py

@@ -1,23 +1,25 @@
 import fastapi.requests
-from fastapi import APIRouter
+from fastapi import APIRouter, Depends
 from starlette import status
 
-from arpakitlib.ar_fastapi_util import ErrorSO
+from arpakitlib.ar_fastapi_util import ErrorSO, get_transmitted_api_data
 from src.api.const import APIErrorCodes, APIErrorSpecificationCodes
 from src.api.schema.v1.out import APIErrorInfoSO
+from src.api.transmitted_api_data import TransmittedAPIData
 
 api_router = APIRouter()
 
 
 @api_router.get(
-    "/",
+    "",
     response_model=APIErrorInfoSO | ErrorSO,
     status_code=status.HTTP_200_OK
 )
 async def _(
         *,
         request: fastapi.requests.Request,
-        response: fastapi.responses.Response
+        response: fastapi.responses.Response,
+        transmitted_api_data: TransmittedAPIData = Depends(get_transmitted_api_data)
 ):
     return APIErrorInfoSO(
         api_error_codes=APIErrorCodes.values_list(),

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/src/core/check_settings.py

@@ -0,0 +1,12 @@
+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")))
+
+
+if __name__ == '__main__':
+    command()

arpakitlib/_arpakit_project_template/src/core/generate_settings_env_example.py

@@ -0,0 +1,16 @@
+import os.path
+
+from arpakitlib.ar_json_util import safely_transfer_obj_to_json_str
+from src.core.const import BASE_DIRPATH
+from src.core.settings import Settings, 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")))
+    Settings.save_env_example_to_file(filepath=os.path.join(BASE_DIRPATH, "example.env"))
+
+
+if __name__ == '__main__':
+    command()

arpakitlib/_arpakit_project_template/src/core/settings.py

@@ -5,15 +5,17 @@ from typing import Any
 
 import pytz
 
-from arpakitlib.ar_json_util import safely_transfer_to_json_str
+from arpakitlib.ar_json_util import safely_transfer_obj_to_json_str
 from arpakitlib.ar_settings_util import SimpleSettings
 from src.core.const import BASE_DIRPATH, ENV_FILEPATH
 
 
 class Settings(SimpleSettings):
+    project_name: str = "{PROJECT_NAME}"
+
     sql_db_url: str | None = (
         "postgresql://{PROJECT_NAME}:{PROJECT_NAME}@127.0.0.1:{SQL_DB_PORT}/{PROJECT_NAME}"
-    )
+    ) if (str("{PROJECT_NAME}") and str("{SQL_DB_PORT}").strip().isdigit()) else None
 
     sql_db_echo: bool = False
 
@@ -29,9 +31,13 @@ class Settings(SimpleSettings):
 
     api_start_scheduled_operation_creator_worker: bool = False
 
-    api_port: int | None = int("{API_PORT}") if "{API_PORT}".isdigit() else None
+    api_port: int | None = int("{API_PORT}") if "{API_PORT}".strip().isdigit() else None
+
+    api_correct_api_key: str | None = "1"
 
-    api_correct_api_key: str | None = None
+    api_correct_token: str | None = "1"
+
+    api_enable_admin1: bool = True
 
     var_dirname: str | None = "var"
 
@@ -59,6 +65,8 @@ class Settings(SimpleSettings):
     def local_timezone_as_pytz(self) -> Any:
         return pytz.timezone(self.local_timezone)
 
+    admin1_secret_key: str | None = "85a9583cb91c4de7a78d7eb1e5306a04418c9c43014c447ea8ec8dd5deb4cf71"
+
     # ...
 
 
@@ -70,7 +78,7 @@ def get_cached_settings() -> Settings:
 
 
 def __example():
-    print(safely_transfer_to_json_str(get_cached_settings().model_dump(mode="json")))
+    print(safely_transfer_obj_to_json_str(get_cached_settings().model_dump(mode="json")))
 
 
 async def __async_example():