holado 0.13.22__py3-none-any.whl

holado/common/handlers/object.py

@@ -0,0 +1,175 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+from builtins import object
+import logging
+from holado.common.handlers.enums import ObjectStates
+
+logger = None
+
+def initialize_logger():
+    global logger
+    logger = logging.getLogger(__name__)
+
+
+class Object(object):
+    def __init__(self, name=None):
+        self.__name = name
+        self.__obj_state = ObjectStates.Created
+
+    @property
+    def name(self):
+        if self.__name:
+            return self.__name
+        else:
+            return str(self)
+
+    @property
+    def object_state(self):
+        return self.__obj_state
+    
+    @object_state.setter
+    def object_state(self, state):
+        from holado_core.common.tools.tools import Tools
+        from holado_python.standard_library.typing import Typing
+        
+        if Tools.do_log(logger, logging.TRACE):  # @UndefinedVariable
+            logger.trace(f"State changed for object '{self.name}' (type: {Typing.get_object_class_fullname(self)}): {self.__obj_state} -> {state}")
+        self.__obj_state = state
+
+
+class DeleteableObject(Object):
+    """
+    Add to a class deleting features:the possibility to be deleted
+        - Self deleting actions
+        - Register functions to call on delete
+    
+    Note: It is highly recommended to set garbage collector periodicity with GcManager.collect_periodically method (see method documentation)
+    """
+    
+    def __init__(self, name=None):
+        super().__init__(name)
+        
+        self.__on_delete_funcs = []
+        self.__on_delete_gc_collect = False
+        self.__is_deleteable = True
+    
+    @property
+    def _is_deleteable(self):
+        return self.__is_deleteable
+    
+    @_is_deleteable.setter
+    def _is_deleteable(self, is_deleteable):
+        self.__is_deleteable = is_deleteable
+    
+    def __del__(self):
+        try:
+            if not self._is_deleteable:
+                return
+            if self.object_state in [ObjectStates.Deleting, ObjectStates.Deleted]:
+                return
+            
+            if logger.isEnabledFor(logging.DEBUG):
+                logger.debug(f"Deleting object of ID {id(self)} and type {type(self)}")
+            if logger.isEnabledFor(logging.TRACE):  # @UndefinedVariable
+                import traceback
+                logger.trace("".join(traceback.format_list(traceback.extract_stack())))
+            
+            # Notes: 
+            #   - Garbage collector default mecanism is incompatible with custom object finalizers (cf GcManager.Method __del__ is called by garbage collector. This call can be done in any thread at any moment.
+            #   - When SessionContext is under deletion, delete any object by thread is not possible
+            from holado.common.context.session_context import SessionContext
+            from holado.common.tools.gc_manager import GcManager
+            if GcManager.is_collect_threaded() or isinstance(self, SessionContext.TSessionContext) or not SessionContext.has_instance():
+                self.__delete()
+            else:
+                from holado_multitask.multithreading.functionthreaded import FunctionThreaded
+                func = FunctionThreaded(self.__delete, name=f"delete object '{self.name}'", register_thread=False, do_log=False)
+                func._is_deleteable = False      # Deactivate deletion mechanism of DeleteableObject to avoid an infinite loop
+                func.start()
+                func.join(timeout=30, raise_if_still_alive=False)   # timeout of 30s to limit deadlock impact ; raise to False since exceptions are omitted in gc collect context
+        except AttributeError as exc:
+            if "'NoneType' object has no attribute" in str(exc):
+                # Simply return, this exception can appear when system in interrupting
+                return
+            else:
+                raise exc
+        except Exception as exc:
+            if "Python is likely shutting down" in str(exc):
+                # Simply return
+                return
+            else:
+                raise exc
+    
+    def __delete(self):
+        try:
+            self.delete_object()
+        except Exception as exc:
+            if "Python is likely shutting down" in str(exc):
+                # Simply return
+                return
+            else:
+                raise exc
+        
+    @property
+    def on_delete_call_gc_collect(self):
+        return self.__on_delete_gc_collect
+        
+    @on_delete_call_gc_collect.setter
+    def on_delete_call_gc_collect(self, do_call):
+        self.__on_delete_gc_collect = do_call
+        
+    def on_delete_call_func(self, func):
+        self.__on_delete_funcs.append(func)
+        
+    def delete_object(self):
+        from holado_core.common.tools.tools import Tools
+        from holado_python.standard_library.typing import Typing
+        
+        if not self._is_deleteable:
+            return
+        if self.object_state in [ObjectStates.Deleting, ObjectStates.Deleted]:
+            return False
+        
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Deleting object '{self.name}' (type: {Typing.get_object_class_fullname(self)})...")
+        self.object_state = ObjectStates.Deleting
+        
+        # Run on_delete functions
+        for func in self.__on_delete_funcs:
+            try:
+                func()
+            except:
+                logger.exception(f"[{self.name}] Error while running on delete function '{func}'")
+                
+        self._delete_object()
+        
+        # Call garbage collector
+        if self.__on_delete_gc_collect:
+            from holado.common.tools.gc_manager import GcManager
+            GcManager.collect()
+        
+        self.object_state = ObjectStates.Deleted
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Deleted object '{self.name}' (type: {Typing.get_object_class_fullname(self)})")
+        
+        return True
+
+    def _delete_object(self):
+        """
+        Implement this method for specific delete actions
+        """
+        pass
+    
+    
+    

holado/common/handlers/undefined.py

@@ -0,0 +1,55 @@
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado.common.handlers.object import Object
+
+logger = logging.getLogger(__name__)
+
+
+class Undefined(Object):
+    def __init__(self, name, undefined_value=0):
+        super().__init__(name)
+        self.__value = undefined_value
+    
+    def __str__(self)->str:
+        if self.name is not None:
+            return f"<{self.name}>"
+        else:
+            return super().__str__()
+
+def is_undefined(obj):
+    return isinstance(obj, Undefined)
+
+
+# Define specific undefined objects
+
+undefined_argument = Undefined("Undefined argument", 0)
+undefined_value = Undefined("Undefined value", 1)
+not_applicable = Undefined("Not Applicable", 2)
+to_be_defined = Undefined("To be defined", 3)               # Usage: initial variable value defining it is to be defined. It is useful when undefined_value can be a possible value.
+
+
+# Define specific default values
+# Note: Real value is defined by methods managing these values as argument.
+
+default = Undefined("Default", 10)
+default_value = Undefined("Default value", 11)
+default_context = Undefined("Default context", 12)      # Example of real value: for ThreadsManager it means "current ScenarioContext" if a scenario context exists else "SessionContext".
+
+
+# Define symbolic values
+
+any_value = Undefined("Any value", 20)
+not_defined_value = Undefined("Not defined value", 21)
+
+

holado/common/tools/__init__.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+
+def initialize_loggers():
+    import holado.common.tools.gc_manager
+    holado.common.tools.gc_manager.initialize_logger()
+    

holado/common/tools/gc_manager.py

@@ -0,0 +1,155 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from builtins import object
+import threading
+import gc
+from holado.common.handlers.undefined import default_value
+
+logger = None
+default_collect_periodicity = 10
+
+def initialize_logger():
+    global logger
+    logger = logging.getLogger(__name__)
+
+
+class GcManager(object):
+    """
+    Manage Garbage Collector
+        
+    Note: When working with HolAdo, it is highly recommended to call collect_periodically method at process start in order to avoid deadlocks.
+          This is done by default in holado.initialize method.
+    Explanation:
+        HolAdo is using object finalizers (define __del__ methods) to properly release objects resources.
+        But in current garbage collector default mecanism, objects are technically finalized (call of __del__) in any yielded thread.
+        Thus, depending on what thread is doing when an object is finalized, a deadlock can occur.
+        Example: current thread is logging a message, garbage collector is finalizing an object in this thread when logger flushes its stream,
+                 and object finalizer tries to log an other message => it results to a deadlock in logging library in its lock mecanism.
+    """
+    
+    # Manage running and pended collect
+    __collect_run_lock = threading.Lock()
+    __is_collect_running = False
+    __is_collect_pending = False
+    __duration_until_pended_collect = default_collect_periodicity
+    
+    # Manage scheduled collect as timer
+    __collect_timer_lock = threading.RLock()
+    __collect_periodicity = None
+    __collect_timer = None
+    __collect_timer_at = None
+    
+    @classmethod
+    def is_collect_threaded(cls):
+        return cls.__collect_periodicity is not None
+    
+    @classmethod
+    def get_collect_periodicity(cls):
+        return cls.__collect_periodicity
+    
+    @classmethod
+    def collect_periodically(cls, collect_periodicity=default_value):
+        """
+        Call this method to periodically process gargage collector collect.
+        By calling this method, default behaviour of garbage collector is disabled.
+        """
+        gc.disable()
+        with cls.__collect_timer_lock:
+            cls.__collect_periodicity = default_collect_periodicity if collect_periodicity is default_value else collect_periodicity
+        cls.__schedule_next_timer(cls.__collect_periodicity)
+    
+    @classmethod
+    def collect(cls, max_duration_until_next_collect_in_seconds=default_value):
+        max_duration = default_collect_periodicity if max_duration_until_next_collect_in_seconds is default_value else max_duration_until_next_collect_in_seconds
+        
+        with cls.__collect_run_lock:
+            # If a collect is already pended, update duration until pended collect
+            if cls.__is_collect_pending:
+                if max_duration < cls.__duration_until_pended_collect:
+                    cls.__duration_until_pended_collect = max_duration
+                return
+            # If a collect is already running, pend a collect
+            if cls.__is_collect_running:
+                cls.__is_collect_pending = True
+                cls.__duration_until_pended_collect = max_duration
+                return
+        
+        # Else schedule next collect
+        with cls.__collect_timer_lock:
+            if cls.__collect_timer is not None:
+                cls.__schedule_next_timer(max_duration_until_next_collect_in_seconds)
+            else:
+                cls.__schedule_next_timer(0)
+        
+    @classmethod
+    def __collect(cls):
+        # Start running
+        with cls.__collect_run_lock:
+            cls.__is_collect_running = True
+        
+        # Process collect
+        gc.collect()
+        
+        # Schedule next timer
+        duration_until_next_collect = None
+        with cls.__collect_run_lock:
+            if cls.__is_collect_pending:
+                duration_until_next_collect = cls.__duration_until_pended_collect
+        with cls.__collect_timer_lock:
+            if cls.__collect_periodicity is not None:
+                if duration_until_next_collect is None:
+                    duration_until_next_collect = cls.__collect_periodicity
+                else:
+                    duration_until_next_collect = min(duration_until_next_collect, cls.__collect_periodicity)
+            
+            cls.__schedule_next_timer(duration_until_next_collect)
+        
+        # Stop running
+        with cls.__collect_run_lock:
+            cls.__is_collect_running = False
+            # Reinitialize pending variables
+            cls.__is_collect_pending = False
+            cls.__duration_until_pended_collect = default_collect_periodicity
+            
+    @classmethod
+    def __schedule_next_timer(cls, duration_until_next_collect_seconds):
+        import holado_multitask.multithreading.timer as mmt
+        from holado_multitask.multitasking.multitask_manager import MultitaskManager
+        from holado_python.common.tools.datetime import DateTime, DurationUnit
+        from holado_python.common.enums import ArithmeticOperator
+        
+        if duration_until_next_collect_seconds is default_value:
+            duration_until_next_collect_seconds = default_collect_periodicity
+        
+        with cls.__collect_timer_lock:
+            if duration_until_next_collect_seconds is not None:
+                now = DateTime.now()
+                next_timer_at = DateTime.apply_delta_on_datetime(now, ArithmeticOperator.Addition, duration_until_next_collect_seconds, DurationUnit.Second)
+                
+                if cls.__collect_timer_at is not None and cls.__collect_timer_at > now and next_timer_at > cls.__collect_timer_at:
+                    # Current scheduled collect is not running and will occur before newly schedule, it is preserved
+                    return
+                elif cls.__collect_timer_at is not None:
+                    # Current scheduled collect is canceled and replaced
+                    cls.__collect_timer.cancel()
+                
+                # Schedule timer with given duration
+                cls.__collect_timer = mmt.Timer("GcManager-collect", duration_until_next_collect_seconds, cls.__collect, register_scope=MultitaskManager.SESSION_SCOPE_NAME)
+                cls.__collect_timer.start()
+                cls.__collect_timer_at = next_timer_at
+            else:
+                cls.__collect_timer = None
+                cls.__collect_timer_at = None
+

holado/holado_config.py

@@ -0,0 +1,45 @@
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+
+class Config(object):
+    """HolAdo project configuration"""
+    
+    # Application properties
+    application_group = None
+    
+    # Timeouts
+    session_timeout_seconds = 7 * 24 * 3600     # Session timeout is by default to 7 days
+    timeout_seconds = 240            # Default timeout
+    join_timeout_seconds = 1800      # Long timeout used when a join should stop without deadlock. When this timeout is reached, a TimeoutTechnicalException is raised
+
+    # Message
+    message_truncate_length = 500     # Length used to truncate a message when it is too long. When a message is truncated, it is suffixed by '...'
+
+    # Time analysis
+    threshold_warn_time_spent_s = 10    # Duration in seconds that triggers a warning on spent time
+
+    # Redo
+    redo_wait_process_min_interval_s = 0.001    # In redo, minimal duration to sleep between two verification of process thread end
+    redo_wait_process_max_interval_s = 0.1      # In redo, maximal duration to sleep between two verification of process thread end
+
+    # Unique values
+    unique_string_padding_length = 6    # Number of characters used to generate a unique text suffix
+     
+    # Symbols
+    DYNAMIC_SYMBOL = u"%"
+    THREAD_DYNAMIC_SYMBOL = u"@"
+    UNIQUE_SYMBOL = u"#"
+    NOT_APPLICABLE_SYMBOL = u"N/A"
+    NONE_SYMBOL = u"None"
+    
+

holado-0.13.22.dist-info/METADATA

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: holado
+Version: 0.13.22
+Summary: HolAdo framework
+Project-URL: Homepage, https://gitlab.com/holado_framework/python
+Project-URL: Issues, https://gitlab.com/holado_framework/python/-/issues
+Author-email: Eric Klumpp <eric.klumpp@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: AIS,BDD,Behavior Driver Development,Behaviour Driven Development,DB,Protobuf,REST,RabbitMQ,Redis,S3,Specification By Example,Web Services,XML,YAML,automation,docker,functional test,gRPC,logging,multitask,script,test,test automation
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: behave
+Requires-Dist: duration-parser
+Requires-Dist: psutil
+Requires-Dist: pypika
+Requires-Dist: python-dateutil
+Requires-Dist: sql-metadata
+Requires-Dist: xmltodict
+Provides-Extra: ais
+Requires-Dist: pyais; extra == 'ais'
+Provides-Extra: all
+Requires-Dist: boto3; extra == 'all'
+Requires-Dist: certifi; extra == 'all'
+Requires-Dist: connexion[flask,swagger-ui,uvicorn]; extra == 'all'
+Requires-Dist: docker; extra == 'all'
+Requires-Dist: flask; extra == 'all'
+Requires-Dist: flask-cors; extra == 'all'
+Requires-Dist: google; extra == 'all'
+Requires-Dist: google-api-core; extra == 'all'
+Requires-Dist: grpc-requests; extra == 'all'
+Requires-Dist: grpcio; extra == 'all'
+Requires-Dist: grpcio-reflection; extra == 'all'
+Requires-Dist: grpcio-tools; extra == 'all'
+Requires-Dist: minio; extra == 'all'
+Requires-Dist: moto; extra == 'all'
+Requires-Dist: paramiko<4.0.0; extra == 'all'
+Requires-Dist: pika; extra == 'all'
+Requires-Dist: prettytable; extra == 'all'
+Requires-Dist: protobuf; extra == 'all'
+Requires-Dist: psycopg; extra == 'all'
+Requires-Dist: psycopg-binary; extra == 'all'
+Requires-Dist: pyais; extra == 'all'
+Requires-Dist: pympler; extra == 'all'
+Requires-Dist: pyopenssl; extra == 'all'
+Requires-Dist: pysftp; extra == 'all'
+Requires-Dist: redis; extra == 'all'
+Requires-Dist: redis-om; extra == 'all'
+Requires-Dist: ruamel-yaml; extra == 'all'
+Requires-Dist: sftpserver; extra == 'all'
+Requires-Dist: truststore; extra == 'all'
+Requires-Dist: zeep; extra == 'all'
+Provides-Extra: api-connexion
+Requires-Dist: connexion[flask,swagger-ui,uvicorn]; extra == 'api-connexion'
+Provides-Extra: db-postgresql
+Requires-Dist: psycopg; extra == 'db-postgresql'
+Requires-Dist: psycopg-binary; extra == 'db-postgresql'
+Provides-Extra: docker
+Requires-Dist: docker; extra == 'docker'
+Requires-Dist: prettytable; extra == 'docker'
+Provides-Extra: grpc
+Requires-Dist: google; extra == 'grpc'
+Requires-Dist: google-api-core; extra == 'grpc'
+Requires-Dist: grpc-requests; extra == 'grpc'
+Requires-Dist: grpcio; extra == 'grpc'
+Requires-Dist: grpcio-reflection; extra == 'grpc'
+Requires-Dist: grpcio-tools; extra == 'grpc'
+Requires-Dist: protobuf; extra == 'grpc'
+Provides-Extra: helper-debug
+Requires-Dist: pympler; extra == 'helper-debug'
+Provides-Extra: protobuf
+Requires-Dist: google; extra == 'protobuf'
+Requires-Dist: google-api-core; extra == 'protobuf'
+Requires-Dist: protobuf; extra == 'protobuf'
+Provides-Extra: rabbitmq
+Requires-Dist: pika; extra == 'rabbitmq'
+Provides-Extra: redis
+Requires-Dist: redis; extra == 'redis'
+Requires-Dist: redis-om; extra == 'redis'
+Provides-Extra: s3
+Requires-Dist: boto3; extra == 's3'
+Requires-Dist: flask; extra == 's3'
+Requires-Dist: flask-cors; extra == 's3'
+Requires-Dist: minio; extra == 's3'
+Requires-Dist: moto; extra == 's3'
+Provides-Extra: sftp
+Requires-Dist: certifi; extra == 'sftp'
+Requires-Dist: paramiko<4.0.0; extra == 'sftp'
+Requires-Dist: pyopenssl; extra == 'sftp'
+Requires-Dist: pysftp; extra == 'sftp'
+Requires-Dist: sftpserver; extra == 'sftp'
+Requires-Dist: truststore; extra == 'sftp'
+Provides-Extra: ssl
+Requires-Dist: certifi; extra == 'ssl'
+Requires-Dist: pyopenssl; extra == 'ssl'
+Requires-Dist: truststore; extra == 'ssl'
+Provides-Extra: ws-suds
+Requires-Dist: suds; extra == 'ws-suds'
+Provides-Extra: ws-zeep
+Requires-Dist: zeep; extra == 'ws-zeep'
+Provides-Extra: yaml
+Requires-Dist: ruamel-yaml; extra == 'yaml'
+Description-Content-Type: text/markdown
+
+# HolAdo (Holistic Automation do)
+
+# HolAdo
+
+HolAdo, or Holistic Automation do, gives a road to holistic automation in software development.
+It's aim is to facilitate many actions by unifying in one framework all needed modules.
+Each module delivers a specific need, and it is generally internally using another framework focussed on this need.
+
+HolAdo framework makes it easy to build a solution with many capabilities.
+Historically, it was created to easily build powerful functional testing solutions.
+But it's conception allows to use it in any context, by integrating only needed HolAdo modules.
+
+In order to improve transparency and maintainability of built solution, 
+the Gherkin language is used as a meta-language humanly readable.
+Each module includes dedicated steps to easily write scenarios (for testing) or processes (for configuration, deployment,...).
+
+
+# Status
+
+HolAdo can be used as is, it is stable and maintained.
+
+Until v1.0.0, it is still considered under construction, it is regularly refactored with breaking changes.
+
+To facilitate it's use, each breaking change will result to a new middle version 0.X.0, so that you can update minor versions without problem.
+
+
+# Python
+
+HolAdo project for Python development.
+Python is currently the only one supported language.
+
+Currently, main available modules are:
+* ais: manage AIS data
+* binary: manipulate binary data, like bit series
+* db: manage DB actions (clients, query)
+* docker: manage Docker actions
+* grpc: manage gRPC clients
+* helper: many helpers to easily use HolAdo possibilities (ex: build script/executable using Gherkin language outside of testing context, like to write automatic processes with pseudo code)
+* json: manipulate JSON data
+* keycloak: a Keycloak client
+* logging: add logging capabilities
+* multitask: manage multithreading and multiprocessing
+* protobuf: manage Protobuf
+* python: some tools over python libraries
+* rabbitmq: manage RabbitMQ
+* redis: manage Redis clients
+* report: manage reporting
+* rest: manage REST clients
+* s3: manage S3 clients
+* scripting: add scripting capabilities in other modules
+* sftp: manage sFTP clients
+* system: manage system actions
+* test: core module for testing capability (currently, only BDD tool "behave" is supported)
+* value: manage values (like tables with scripting capabilities)
+* ws: manage Web Service clients
+
+Major upcomming capabilities:
+* WebUI interactions (with playright or selenium)
+* DB ORM
+
+
+# Community
+
+A community around HolAdo is under construction.
+
+For the moment you can contact me by email (eric.klumpp@gmail.com).
+
+For any support, please write scenarios (executable with 'behave') illustating your problem:
+* If you encounter a bug, scenarios reproducing the bug.
+* If you need an evolution, scenarios illustrating the expected behavior.
+
+If you have implemented a new module, please send it to me, and I will include it in HolAdo framework.
+
+<!-- 
+
+# Howto run HolAdo non-regression tests from docker image got from registry.gitlab.com
+
+Note: Read HolAdo non-regression tests is a good way to discover its capabilities.
+
+* docker login -u XXX registry.gitlab.com
+* docker pull registry.gitlab.com/holado_framework/python:main
+* docker run --rm -it registry.gitlab.com/holado_framework/python:main /bin/sh -c "cd /code/holado/python; ./run_test_nonreg.sh"
+
+-->
+