Renamed project

src/cpl_core/environment/__init__.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+
+"""
+sh_cpl-core sh-edraft Common Python library
+~~~~~~~~~~~~~~~~~~~
+
+sh-edraft Common Python library
+
+:copyright: (c) 2020 - 2021 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'cpl_core.environment'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
+__version__ = '2021.10.6'
+
+from collections import namedtuple
+
+# imports:
+from .application_environment_abc import ApplicationEnvironmentABC
+from .environment_name_enum import EnvironmentNameEnum
+from .application_environment import ApplicationEnvironment
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major='2021', minor='10', micro='6')

src/cpl_core/environment/application_environment.py

@@ -0,0 +1,96 @@
+import os
+from datetime import datetime
+from socket import gethostname
+from typing import Optional
+
+from cpl.environment.application_environment_abc import ApplicationEnvironmentABC
+from cpl.environment.environment_name_enum import EnvironmentNameEnum
+
+
+class ApplicationEnvironment(ApplicationEnvironmentABC):
+    r"""Represents environment of the application
+
+    Parameter
+    ---------
+        name: :class:`cpl.environment.environment_name_enum.EnvironmentNameEnum`
+    """
+
+    def __init__(self, name: EnvironmentNameEnum = EnvironmentNameEnum.production):
+        ApplicationEnvironmentABC.__init__(self)
+
+        self._environment_name: Optional[EnvironmentNameEnum] = name
+        self._app_name: Optional[str] = None
+        self._customer: Optional[str] = None
+
+        self._start_time: datetime = datetime.now()
+        self._end_time: datetime = datetime.now()
+        self._runtime_directory = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+        self._working_directory = os.getcwd()
+
+    @property
+    def environment_name(self) -> str:
+        return str(self._environment_name.value)
+
+    @environment_name.setter
+    def environment_name(self, environment_name: str):
+        self._environment_name = EnvironmentNameEnum(environment_name)
+
+    @property
+    def application_name(self) -> str:
+        return self._app_name if self._app_name is not None else ''
+
+    @application_name.setter
+    def application_name(self, application_name: str):
+        self._app_name = application_name
+
+    @property
+    def customer(self) -> str:
+        return self._customer if self._customer is not None else ''
+
+    @customer.setter
+    def customer(self, customer: str):
+        self._customer = customer
+
+    @property
+    def host_name(self):
+        return gethostname()
+
+    @property
+    def start_time(self) -> datetime:
+        return self._start_time
+
+    @property
+    def end_time(self) -> datetime:
+        return self._end_time
+
+    @end_time.setter
+    def end_time(self, end_time: datetime):
+        self._end_time = end_time
+
+    @property
+    def date_time_now(self) -> datetime:
+        return datetime.now()
+
+    @property
+    def working_directory(self) -> str:
+        return str(self._working_directory)
+
+    @property
+    def runtime_directory(self) -> str:
+        return str(self._runtime_directory)
+
+    def set_runtime_directory(self, runtime_directory: str):
+        if runtime_directory != '':
+            self._runtime_directory = runtime_directory
+            return
+
+        self._runtime_directory = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+    def set_working_directory(self, working_directory: str):
+        if working_directory != '':
+            self._working_directory = working_directory
+            os.chdir(self._working_directory)
+            return
+
+        self._working_directory = os.path.abspath('./')
+        os.chdir(self._working_directory)

src/cpl_core/environment/application_environment_abc.py

@@ -0,0 +1,88 @@
+from abc import ABC, abstractmethod
+from datetime import datetime
+
+
+class ApplicationEnvironmentABC(ABC):
+    r"""ABC of the class :class:`cpl.environment.application_environment.ApplicationEnvironment`"""
+
+    @abstractmethod
+    def __init__(self):
+        pass
+
+    @property
+    @abstractmethod
+    def environment_name(self) -> str: pass
+
+    @environment_name.setter
+    @abstractmethod
+    def environment_name(self, environment_name: str): pass
+
+    @property
+    @abstractmethod
+    def application_name(self) -> str: pass
+
+    @application_name.setter
+    @abstractmethod
+    def application_name(self, application_name: str): pass
+
+    @property
+    @abstractmethod
+    def customer(self) -> str: pass
+
+    @customer.setter
+    @abstractmethod
+    def customer(self, customer: str): pass
+
+    @property
+    @abstractmethod
+    def host_name(self) -> str: pass
+
+    @property
+    @abstractmethod
+    def start_time(self) -> datetime: pass
+
+    @start_time.setter
+    @abstractmethod
+    def start_time(self, start_time: datetime): pass
+
+    @property
+    @abstractmethod
+    def end_time(self): pass
+
+    @end_time.setter
+    @abstractmethod
+    def end_time(self, end_time: datetime): pass
+
+    @property
+    @abstractmethod
+    def date_time_now(self) -> datetime: pass
+
+    @property
+    @abstractmethod
+    def working_directory(self) -> str: pass
+
+    @property
+    @abstractmethod
+    def runtime_directory(self) -> str: pass
+
+    @abstractmethod
+    def set_runtime_directory(self, runtime_directory: str):
+        r"""Sets the current runtime directory
+
+        Parameter
+        ---------
+            runtime_directory: :class:`str`
+                Path of the runtime directory
+        """
+        pass
+
+    @abstractmethod
+    def set_working_directory(self, working_directory: str):
+        r"""Sets the current working directory
+
+        Parameter
+        ---------
+            working_directory: :class:`str`
+                Path of the current working directory
+        """
+        pass

src/cpl_core/environment/environment_name_enum.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class EnvironmentNameEnum(Enum):
+
+    production = 'production'
+    staging = 'staging'
+    testing = 'testing'
+    development = 'development'