arpakitlib 1.7.124__py3-none-any.whl → 1.7.207__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,5 +1,6 @@
 # mode_type=
 # project_name=
+# sql_db_port=
 # sql_db_url=
 # sql_db_echo=
 # api_init_sql_db_at_start=

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/{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_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 __sandbox():
+def _sandbox():
     pass
 
 
-async def __async_sandbox():
+async def _async_sandbox():
     pass
 
 
 if __name__ == '__main__':
-    __sandbox()
-    asyncio.run(__async_sandbox())
+    _sandbox()
+    asyncio.run(_async_sandbox())

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_2.py

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

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_3.py

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

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_4.py

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

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_5.py

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

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_6.py

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

arpakitlib/_arpakit_project_template/manage/sandbox/sandbox_7.py

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

arpakitlib/_arpakit_project_template/src/additional_model/additional_model.py

@@ -4,3 +4,5 @@ from arpakitlib.ar_additional_model_util import BaseAM
 class ExampleAM(BaseAM):
     name: str = "Name"
     surname: str = "Surname"
+
+# ...

arpakitlib/_arpakit_project_template/src/admin1/add_admin_in_app.py

@@ -1,9 +1,13 @@
+import importlib
+from contextlib import suppress
+
 from fastapi import FastAPI
 from sqladmin import Admin
 
+from arpakitlib.ar_sqladmin_util import SimpleModelView
 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:
@@ -16,10 +20,13 @@ def add_admin1_in_app(*, app: FastAPI) -> FastAPI:
         engine=transmitted_api_data.sqlalchemy_db.engine,
         base_url="/admin1",
         authentication_backend=authentication_backend,
-        title="{PROJECT_NAME}"
+        title=get_cached_settings().project_name
     )
 
-    for model_view in MODEL_VIEWS:
+    with suppress(Exception):
+        importlib.import_module("src.admin1.model_view")
+
+    for model_view in SimpleModelView.all_subclasses:
         admin.add_model_view(model_view)
 
     return app

arpakitlib/_arpakit_project_template/src/admin1/model_view.py

@@ -1,19 +1 @@
-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/{start_api_for_dev_with_reload.py → _start_api_with_reload.py}

@@ -3,7 +3,7 @@ import uvicorn
 from src.core.settings import get_cached_settings
 
 
-def __command():
+def _start_api_for_dev_with_reload():
     uvicorn.run(
         "src.api.asgi:app",
         port=get_cached_settings().api_port,
@@ -14,4 +14,4 @@ def __command():
 
 
 if __name__ == '__main__':
-    __command()
+    _start_api_for_dev_with_reload()

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

@@ -3,7 +3,7 @@ import uvicorn
 from src.core.settings import get_cached_settings
 
 
-def __command():
+def _start_api_for_dev_without_reload():
     uvicorn.run(
         "src.api.asgi:app",
         port=get_cached_settings().api_port,
@@ -14,4 +14,4 @@ def __command():
 
 
 if __name__ == '__main__':
-    __command()
+    _start_api_for_dev_without_reload()

arpakitlib/_arpakit_project_template/src/api/create_api_app.py

@@ -7,7 +7,7 @@ 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 setup_logging, get_cached_media_file_storage_in_dir, get_cached_cache_file_storage_in_dir, \
     get_cached_dump_file_storage_in_dir
@@ -63,7 +63,7 @@ def create_api_app() -> FastAPI:
         transmitted_api_data=transmitted_api_data,
         main_api_router=main_api_router,
         media_dirpath=settings.media_dirpath,
-        static_dirpath=STATIC_DIRPATH
+        static_dirpath=ProjectPaths.static_dirpath
     )
 
     if settings.api_enable_admin1:

arpakitlib/_arpakit_project_template/src/api/event.py

@@ -35,10 +35,7 @@ class StartupAPIEvent(BaseStartupAPIEvent):
                 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
-                    ]
+                    filter_operation_types=None
                 ),
                 mode=SafeRunInBackgroundModes.thread
             )
@@ -48,10 +45,7 @@ class StartupAPIEvent(BaseStartupAPIEvent):
             _ = 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
-                    ]
+                    scheduled_operations=SCHEDULED_OPERATIONS
                 ),
                 mode=SafeRunInBackgroundModes.async_task
             )

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

@@ -12,6 +12,7 @@ api_router = APIRouter()
 
 @api_router.get(
     "",
+    name="Get API Error info",
     response_model=APIErrorInfoSO | ErrorSO,
     status_code=status.HTTP_200_OK
 )

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

@@ -4,8 +4,12 @@ from src.api.router.v1 import get_api_error_info
 
 main_v1_api_router = APIRouter()
 
+# API Error Info
+
 main_v1_api_router.include_router(
     router=get_api_error_info.api_router,
     prefix="/get_api_error_info",
     tags=["API Error Info"]
 )
+
+# ...

arpakitlib/_arpakit_project_template/src/api/schema/v1/in_.py

@@ -0,0 +1 @@
+# ...

arpakitlib/_arpakit_project_template/src/api/schema/v1/out.py

@@ -4,3 +4,5 @@ from arpakitlib.ar_fastapi_util import BaseSO
 class APIErrorInfoSO(BaseSO):
     api_error_codes: list[str] = []
     api_error_specification_codes: list[str] = []
+
+# ...

arpakitlib/_arpakit_project_template/src/api/transmitted_api_data.py

@@ -11,3 +11,5 @@ class TransmittedAPIData(BaseTransmittedAPIData):
     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

@@ -1,5 +1,7 @@
 import logging
 
+from src.core.util import setup_logging
+
 _logger = logging.getLogger(__name__)
 
 
@@ -9,4 +11,5 @@ def hello_world() -> str:
 
 
 if __name__ == '__main__':
-    print(hello_world())
+    setup_logging()
+    hello_world()

arpakitlib/_arpakit_project_template/src/core/{check_logging.py → _check_logging.py}

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

arpakitlib/_arpakit_project_template/src/core/{check_settings.py → _check_settings.py}

@@ -1,12 +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()
+def _check_settings():
     print(safely_transfer_obj_to_json_str(get_cached_settings().model_dump(mode="json")))
 
 
 if __name__ == '__main__':
-    command()
+    _check_settings()

arpakitlib/_arpakit_project_template/src/core/{generate_settings_env_example.py → _generate_settings_env_example.py}

@@ -1,16 +1,14 @@
 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.const import ProjectPaths
 from src.core.settings import Settings, get_cached_settings
-from src.core.util import setup_logging
 
 
-def command():
-    setup_logging()
+def _generate_settings_env_example():
     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"))
+    Settings.save_env_example_to_file(filepath=os.path.join(ProjectPaths.base_dirpath, "example.env"))
 
 
 if __name__ == '__main__':
-    command()
+    _generate_settings_env_example()

arpakitlib/_arpakit_project_template/src/core/const.py

@@ -2,41 +2,34 @@ import asyncio
 import os
 import pathlib
 
-BASE_DIRPATH: str = str(pathlib.Path(__file__).parent.parent.parent)
+from arpakitlib.ar_enumeration_util import Enumeration
+from arpakitlib.ar_json_util import safely_transfer_obj_to_json_str
 
-ENV_FILENAME: str = ".env"
 
-ENV_FILEPATH: str = os.path.join(BASE_DIRPATH, ENV_FILENAME)
+class ProjectPaths(Enumeration):
+    base_dirpath: str = str(pathlib.Path(__file__).parent.parent.parent)
 
-SRC_DIRNAME: str = "src"
+    env_filename: str = ".env"
+    env_filepath: str = os.path.join(base_dirpath, env_filename)
 
-SRC_DIRPATH: str = os.path.join(BASE_DIRPATH, SRC_DIRNAME)
+    src_dirname: str = "src"
+    src_dirpath: str = os.path.join(base_dirpath, src_dirname)
 
-MANAGE_DIRNAME: str = "manage"
+    manage_dirname: str = "manage"
+    manage_dirpath: str = os.path.join(base_dirpath, manage_dirname)
 
-MANAGE_DIRPATH: str = os.path.join(BASE_DIRPATH, MANAGE_DIRNAME)
+    resource_dirname: str = "resource"
+    resource_dirpath: str = os.path.join(base_dirpath, resource_dirname)
 
-RESOURCE_DIRNAME: str = "resource"
+    static_dirname: str = "static"
+    static_dirpath: str = os.path.join(resource_dirpath, static_dirname)
 
-RESOURCE_DIRPATH: str = os.path.join(BASE_DIRPATH, RESOURCE_DIRNAME)
 
-STATIC_DIRNAME: str = "static"
-
-STATIC_DIRPATH: str = os.path.join(RESOURCE_DIRPATH, STATIC_DIRNAME)
+# ...
 
 
 def __example():
-    print(f"BASE_DIRPATH: {BASE_DIRPATH}")
-    print(f"ENV_FILENAME: {ENV_FILENAME}")
-    print(f"ENV_FILEPATH: {ENV_FILEPATH}")
-    print(f"SRC_DIRNAME: {SRC_DIRNAME}")
-    print(f"SRC_DIRPATH: {SRC_DIRPATH}")
-    print(f"MANAGE_DIRNAME: {MANAGE_DIRNAME}")
-    print(f"MANAGE_DIRPATH: {MANAGE_DIRPATH}")
-    print(f"RESOURCE_DIRNAME: {RESOURCE_DIRNAME}")
-    print(f"RESOURCE_DIRPATH: {RESOURCE_DIRPATH}")
-    print(f"STATIC_DIRNAME: {STATIC_DIRNAME}")
-    print(f"STATIC_DIRPATH: {STATIC_DIRPATH}")
+    print(safely_transfer_obj_to_json_str(ProjectPaths.key_to_value()))
 
 
 async def __async_example():

arpakitlib/_arpakit_project_template/src/core/settings.py

@@ -1,4 +1,3 @@
-import asyncio
 import os
 from functools import lru_cache
 from typing import Any
@@ -7,23 +6,36 @@ import pytz
 
 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
+from src.core.const import ProjectPaths
 
 
 class Settings(SimpleSettings):
-    project_name: str = "{PROJECT_NAME}"
+    project_name: str = "{{PROJECT_NAME}}"
+
+    sql_db_user: str | None = project_name
+
+    sql_db_password: str | None = project_name
+
+    sql_db_port: int | None = int("{{SQL_DB_PORT}}") if "{{SQL_DB_PORT}}".strip().isdigit() else None
+
+    sql_db_database: str | None = 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
+        f"postgresql://{sql_db_user}:{sql_db_password}@127.0.0.1:{sql_db_port}/{sql_db_database}"
+    ) if (
+            sql_db_user is not None
+            and sql_db_password is not None
+            and sql_db_port is not None
+            and sql_db_database is not None
+    ) else None
 
     sql_db_echo: bool = False
 
     api_init_sql_db_at_start: bool = True
 
-    api_title: str = "{PROJECT_NAME}"
+    api_title: str = project_name
 
-    api_description: str = "{PROJECT_NAME} (arpakitlib)"
+    api_description: str = f"{project_name} (arpakitlib)"
 
     api_create_story_log_before_response_in_handle_exception: bool = True
 
@@ -31,7 +43,7 @@ class Settings(SimpleSettings):
 
     api_start_scheduled_operation_creator_worker: bool = False
 
-    api_port: int | None = int("{API_PORT}") if "{API_PORT}".strip().isdigit() else None
+    api_port: int | None = int("{{API_PORT}}") if "{{API_PORT}}".strip().isdigit() else None
 
     api_correct_api_key: str | None = "1"
 
@@ -41,7 +53,7 @@ class Settings(SimpleSettings):
 
     var_dirname: str | None = "var"
 
-    var_dirpath: str | None = os.path.join(BASE_DIRPATH, var_dirname)
+    var_dirpath: str | None = os.path.join(ProjectPaths.base_dirpath, var_dirname)
 
     log_filename: str | None = "story.log"
 
@@ -72,19 +84,10 @@ class Settings(SimpleSettings):
 
 @lru_cache()
 def get_cached_settings() -> Settings:
-    if os.path.exists(ENV_FILEPATH):
-        return Settings(_env_file=ENV_FILEPATH, _env_file_encoding="utf-8")
+    if os.path.exists(ProjectPaths.env_filepath):
+        return Settings(_env_file=ProjectPaths.env_filepath, _env_file_encoding="utf-8")
     return Settings()
 
 
-def __example():
-    print(safely_transfer_obj_to_json_str(get_cached_settings().model_dump(mode="json")))
-
-
-async def __async_example():
-    pass
-
-
 if __name__ == '__main__':
-    __example()
-    asyncio.run(__async_example())
+    print(safely_transfer_obj_to_json_str(get_cached_settings().model_dump(mode="json")))

arpakitlib/_arpakit_project_template/src/core/util.py

@@ -45,6 +45,9 @@ def now_local_dt() -> datetime:
     return now_dt(tz=get_cached_settings().local_timezone_as_pytz)
 
 
+# ...
+
+
 def __example():
     pass
 

arpakitlib/_arpakit_project_template/src/db/{check_conn_sqlalchemy_db.py → _check_conn_sqlalchemy_db.py}

@@ -2,10 +2,10 @@ from src.core.util import setup_logging
 from src.db.util import get_cached_sqlalchemy_db
 
 
-def command():
+def _check_conn_sqlalchemy_db():
     setup_logging()
     get_cached_sqlalchemy_db().check_conn()
 
 
 if __name__ == '__main__':
-    command()
+    _check_conn_sqlalchemy_db()

arpakitlib/_arpakit_project_template/src/db/{init_sqlalchemy_db.py → _init_sqlalchemy_db.py}

@@ -2,10 +2,10 @@ from src.core.util import setup_logging
 from src.db.util import get_cached_sqlalchemy_db
 
 
-def __init_sqlalchemy_db():
+def _init_sqlalchemy_db():
     setup_logging()
     get_cached_sqlalchemy_db().init()
 
 
 if __name__ == '__main__':
-    __init_sqlalchemy_db()
+    _init_sqlalchemy_db()

arpakitlib/_arpakit_project_template/src/db/{reinit_sqlalchemy_db.py → _reinit_sqlalchemy_db.py}

@@ -3,11 +3,11 @@ from src.core.util import setup_logging
 from src.db.util import get_cached_sqlalchemy_db
 
 
-def __reinit_sqlalchemy_db():
+def _reinit_sqlalchemy_db():
     setup_logging()
-    get_cached_settings().raise_if_mode_type_not_prod()
+    get_cached_settings().raise_if_mode_type_prod()
     get_cached_sqlalchemy_db().reinit()
 
 
 if __name__ == '__main__':
-    __reinit_sqlalchemy_db()
+    _reinit_sqlalchemy_db()