Added readme for devs

Reviewed-on: #199

.gitea/workflows/build-dev.yaml

@@ -16,61 +16,68 @@ jobs:
     uses: ./.gitea/workflows/package.yaml
     needs: [ prepare, application, auth, core, dependency ]
     with:
-      working_directory: src/cpl-api
+      working_directory: src/api
     secrets: inherit
 
   application:
     uses: ./.gitea/workflows/package.yaml
     needs: [ prepare, core, dependency ]
     with:
-      working_directory: src/cpl-application
+      working_directory: src/application
     secrets: inherit
 
   auth:
     uses: ./.gitea/workflows/package.yaml
     needs: [ prepare, core, dependency,  database ]
     with:
-      working_directory: src/cpl-auth
+      working_directory: src/auth
+    secrets: inherit
+
+  cli:
+    uses: ./.gitea/workflows/package.yaml
+    needs: [ prepare, core ]
+    with:
+      working_directory: src/cli
     secrets: inherit
 
   core:
     uses: ./.gitea/workflows/package.yaml
     needs: [prepare]
     with:
-      working_directory: src/cpl-core
+      working_directory: src/core
     secrets: inherit
 
   database:
     uses: ./.gitea/workflows/package.yaml
     needs: [ prepare, core, dependency ]
     with:
-      working_directory: src/cpl-database
+      working_directory: src/database
     secrets: inherit
 
   dependency:
     uses: ./.gitea/workflows/package.yaml
     needs: [ prepare, core ]
     with:
-      working_directory: src/cpl-dependency
+      working_directory: src/dependency
     secrets: inherit
 
   mail:
     uses: ./.gitea/workflows/package.yaml
     needs: [ prepare, core, dependency ]
     with:
-      working_directory: src/cpl-mail
+      working_directory: src/mail
     secrets: inherit
 
   query:
     uses: ./.gitea/workflows/package.yaml
     needs: [prepare]
     with:
-      working_directory: src/cpl-query
+      working_directory: src/query
     secrets: inherit
 
   translation:
     uses: ./.gitea/workflows/package.yaml
     needs: [ prepare, core, dependency ]
     with:
-      working_directory: src/cpl-translation
+      working_directory: src/translation
     secrets: inherit

.gitea/workflows/package.yaml

@@ -36,6 +36,12 @@ jobs:
           echo "Set version to $(cat /workspace/sh-edraft.de/cpl/version.txt)"
           cat pyproject.toml
 
+      - name: Set package version
+        run: |
+          sed -i -E "s/^__version__ = \".*\"/__version__ = \"$(cat /workspace/sh-edraft.de/cpl/version.txt)\"/" cpl/*/__init__.py
+          echo "Set version to $(cat /workspace/sh-edraft.de/cpl/version.txt)"
+          cat cpl/*/__init__.py
+
       - name: Set pip conf
         run: |
           cat > .pip.conf <<'EOF'

README.md

@@ -0,0 +1,18 @@
+## Prepare for development
+
+After cloning the repository, run the following commands to set up your development environment:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate  # On Windows use `.venv\Scripts\activate`
+bash install.sh
+```
+
+Install cpl-cli as a development package:
+
+```bash
+pip install -e src/core
+pip install -e src/cli
+```
+
+When using Pycharm, mark all directories under `src/` as "Sources Root" and `exa` to ensure proper module resolution.

cpl.workspace.json

@@ -0,0 +1,12 @@
+{
+  "name": "cpl",
+  "projects": [
+    "src/cli/cpl.project.json",
+    "src/core/cpl.project.json",
+    "test/cpl.project.json"
+  ],
+  "defaultProject": "cpl-cli",
+  "scripts": {
+    "format": "black src"
+  }
+}

example/general/src/hosted_service.py

@@ -3,8 +3,8 @@ from datetime import datetime
 
 from cpl.core.console import Console
 from cpl.core.time.cron import Cron
-from cpl.dependency.hosted.cronjob import CronjobABC
-from cpl.dependency.hosted.hosted_service import HostedService
+from cpl.core.service.cronjob import CronjobABC
+from cpl.core.service.hosted_service import HostedService
 
 
 class Hosted(HostedService):

src/api/cpl/api/__init__.py

@@ -2,3 +2,5 @@ from .error import APIError, AlreadyExists, EndpointNotImplemented, Forbidden, N
 from .logger import APILogger
 from .settings import ApiSettings
 from .api_module import ApiModule
+
+__version__ = "1.0.0"

src/application/cpl/application/__init__.py

@@ -1,2 +1,4 @@
 from .application_builder import ApplicationBuilder
 from .host import Host
+
+__version__ = "1.0.0"

src/application/cpl/application/application_builder.py

@@ -14,7 +14,7 @@ TApp = TypeVar("TApp", bound=ApplicationABC)
 
 class ApplicationBuilder(Generic[TApp]):
 
-    def __init__(self, app: Type[ApplicationABC]):
+    def __init__(self, app: Type[TApp]):
         assert app is not None, "app must not be None"
         assert issubclass(app, ApplicationABC), "app must be an subclass of ApplicationABC or its subclass"
 

src/application/cpl/application/host.py

@@ -1,7 +1,9 @@
 import asyncio
 from typing import Callable
 
-from cpl.dependency import get_provider
+from cpl.core.property import classproperty
+from cpl.dependency.context import get_provider, use_root_provider
+from cpl.dependency.service_collection import ServiceCollection
 from cpl.dependency.hosted.startup_task import StartupTask
 
 
@@ -9,6 +11,24 @@ class Host:
     _loop: asyncio.AbstractEventLoop | None = None
     _tasks: dict = {}
 
+    _service_collection: ServiceCollection | None = None
+
+    @classproperty
+    def services(cls) -> ServiceCollection:
+        if cls._service_collection is None:
+            cls._service_collection = ServiceCollection()
+
+        return cls._service_collection
+
+    @classmethod
+    def get_provider(cls):
+        provider = get_provider()
+        if provider is None:
+            provider = cls.services.build()
+            use_root_provider(provider)
+
+        return provider
+
     @classmethod
     def get_loop(cls) -> asyncio.AbstractEventLoop:
         if cls._loop is None:
@@ -18,7 +38,7 @@ class Host:
 
     @classmethod
     def run_start_tasks(cls):
-        provider = get_provider()
+        provider = cls.get_provider()
         tasks = provider.get_services(StartupTask)
         loop = cls.get_loop()
 
@@ -30,7 +50,7 @@ class Host:
 
     @classmethod
     def run_hosted_services(cls):
-        provider = get_provider()
+        provider = cls.get_provider()
         services = provider.get_hosted_services()
         loop = cls.get_loop()
 
@@ -49,6 +69,10 @@ class Host:
 
         cls._tasks.clear()
 
+    @classmethod
+    async def wait_for_all(cls):
+        await asyncio.gather(*cls._tasks.values())
+
     @classmethod
     def run_app(cls, func: Callable, *args, **kwargs):
         cls.run_start_tasks()

src/auth/cpl/auth/__init__.py

@@ -4,3 +4,5 @@ from cpl.auth.keycloak.keycloak_client import KeycloakClient as _KeycloakClient
 from .auth_module import AuthModule
 from .keycloak_settings import KeycloakSettings
 from .logger import AuthLogger
+
+__version__ = "1.0.0"

src/cli/cpl.project.json

@@ -0,0 +1,29 @@
+{
+  "name": "cpl-cli",
+  "version": "0.1.0",
+  "type": "console",
+  "license": "MIT",
+  "author": "Sven Heidemann",
+  "description": "CLI for the CPL library",
+  "homepage": "",
+  "keywords": [],
+  "dependencies": {
+    "click": "~8.3.0"
+  },
+  "devDependencies": {
+    "black": "~25.9"
+  },
+  "references": [],
+  "main": "cpl/cli/main.py",
+  "directory": "cpl/cli",
+  "build": {
+    "include": [
+      "_templates/"
+    ],
+    "exclude": [
+      "**/__pycache__",
+      "**/logs",
+      "**/tests"
+    ]
+  }
+}

src/cli/cpl/cli/.cpl/generate/abc.py.schematic

@@ -0,0 +1,9 @@
+from abc import ABC
+
+
+class <Name>ABC(ABC):
+
+    def __init__(self):
+        ABC.__init__(self)
+
+        print("<schematic> <multi_camelName> initialized")

src/cli/cpl/cli/.cpl/generate/app.py.schematic

@@ -0,0 +1,16 @@
+from cpl.application.abc import ApplicationABC
+from cpl.core.environment import Environment
+from cpl.core.log import LoggerABC
+from cpl.dependency import ServiceProvider
+from cpl.dependency.typing import Modules
+
+
+class <Name>(ApplicationABC):
+    def __init__(self, services: ServiceProvider, modules: Modules):
+        ApplicationABC.__init__(self, services, modules)
+
+        self._logger = services.get_service(LoggerABC)
+
+    async def main(self):
+        self._logger.debug(f"Host: {Environment.get_host_name()}")
+        self._logger.debug(f"Environment: {Environment.get_environment()}")

src/cli/cpl/cli/.cpl/generate/config.py.schematic

@@ -0,0 +1,10 @@
+from cpl.core.configuration import ConfigurationModelABC
+
+
+class <Name>Config(ConfigurationModelABC):
+
+    def __init__(
+        self,
+        src: dict = None,
+    ):
+        ConfigurationModelABC.__init__(self, src)

src/cli/cpl/cli/.cpl/generate/cron_job.py.schematic

@@ -0,0 +1,9 @@
+from cpl.core.console import Console
+from cpl.core.service import CronjobABC
+
+class CronJob(CronjobABC):
+    def __init__(self):
+        CronjobABC.__init__(self, Cron("*/1 * * * *"))
+
+    async def loop(self):
+        Console.write_line(f"[{datetime.now()}] Hello, World!")

src/cli/cpl/cli/.cpl/generate/data_access_object.py.schematic

@@ -0,0 +1,9 @@
+from cpl.database.abc import DbModelDaoABC
+
+
+class <Name>Dao(DbModelDaoABC[<Name>]):
+
+    def __init__(self):
+        DbModelDaoABC.__init__(self, <Name>, "<multi_name>")
+
+        self.attribute(<Name>.name, str)

src/cli/cpl/cli/.cpl/generate/db_model.py.schematic

@@ -0,0 +1,23 @@
+from datetime import datetime
+from typing import Self
+
+from cpl.core.typing import SerialId
+from cpl.database.abc import DbModelABC
+
+
+class <Name>(DbModelABC[Self]):
+    def __init__(
+        self,
+        id: SerialId,
+        name: str,
+        deleted: bool = False,
+        editor_id: SerialId | None = None,
+        created: datetime | None = None,
+        updated: datetime | None = None,
+    ):
+        DbModelABC.__init__(self, id, deleted, editor_id, created, updated)
+        self._name = name
+
+    @property
+    def name(self) -> str:
+        return self._name

src/cli/cpl/cli/.cpl/generate/db_model_join.py.schematic

@@ -0,0 +1,29 @@
+from datetime import datetime
+from typing import Self
+
+from cpl.core.typing import SerialId
+from cpl.database.abc import DbJoinModelABC
+
+
+class <Name>Join(DbJoinModelABC[Self]):
+    def __init__(
+            self,
+            id: SerialId,
+            source_id: SerialId,
+            reference_id: SerialId,
+            deleted: bool = False,
+            editor_id: SerialId | None = None,
+            created: datetime | None = None,
+            updated: datetime | None = None,
+    ):
+        DbJoinModelABC.__init__(self, source_id, reference_id, id, deleted, editor_id, created, updated)
+        self._source_id = source_id
+        self._reference_id = reference_id
+
+    @property
+    def source_id(self) -> int:
+        return self._source_id
+
+    @property
+    def reference(self) -> int:
+        return self._reference_id

src/cli/cpl/cli/.cpl/generate/enum.py.schematic

@@ -0,0 +1,5 @@
+from enum import Enum
+
+
+class <Name>Enum(Enum):
+    KEY = "value"

src/cli/cpl/cli/.cpl/generate/hosted_service.py.schematic

@@ -0,0 +1,13 @@
+from cpl.core.console import Console
+from cpl.core.service import HostedService
+
+
+class <Name>(HostedService):
+    def __init__(self):
+        HostedService.__init__(self)
+
+    async def start(self):
+        Console.write_line("Hello, World!")
+
+    async def stop(self):
+        Console.write_line("Goodbye, World!")

src/cli/cpl/cli/.cpl/generate/logger.py.schematic

@@ -0,0 +1,7 @@
+from cpl.core.log.wrapped_logger import WrappedLogger
+
+
+class <Name>Logger(WrappedLogger):
+
+    def __init__(self):
+        WrappedLogger.__init__(self, "<name>")

src/cli/cpl/cli/.cpl/generate/module.py.schematic

@@ -0,0 +1,17 @@
+from cpl.dependency import ServiceCollection, ServiceProvider
+from cpl.dependency.module import Module
+
+
+class <Name>Module(Module):
+    dependencies = []
+    configuration = []
+    singleton = []
+    scoped = []
+    transient = []
+    hosted = []
+
+    @staticmethod
+    def register(collection: ServiceCollection): ...
+
+    @staticmethod
+    def configure(provider: ServiceProvider): ...

src/cli/cpl/cli/.cpl/generate/multiprocess.py.schematic

@@ -0,0 +1,9 @@
+import multiprocessing
+
+
+class <Name>(multiprocessing.Process):
+
+    def __init__(self):
+        multiprocessing.Process.__init__(self)
+
+    def run(self): ...

src/cli/cpl/cli/.cpl/generate/pipe.py.schematic

@@ -0,0 +1,11 @@
+from cpl.core.pipes import PipeABC
+from cpl.core.typing import T
+
+
+class <Name>Pipe(PipeABC):
+
+    @staticmethod
+    def to_str(value: T, *args) -> str: ...
+
+    @staticmethod
+    def from_str(value: str, *args) -> T: ...