pyegeria 0.3.3__py3-none-any.whl → 0.3.5__py3-none-any.whl

pyegeria/core_omag_server_config.py

@@ -24,31 +24,24 @@ from pyegeria._validators import (
 class CoreServerConfig(Client):
     """
     CoreServerConfig is a class that extends the Client class. It provides methods to configure and interact with access
-     services in the OMAG server.
+    services in the OMAG server.
 
-    Methods:
+    Attributes:
 
-        - get_stored_configuration(server_name: str = None) -> dict:
-            Retrieves all the configuration documents for a server.
+        server_name: str
+            The name of the OMAG server to configure.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+        verify_flag: bool
+            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
+            Defaults to False.
 
-        - get_configured_access_services(server_name: str = None) -> dict:
-            Returns the list of access services that are configured for this server.
 
-        - configure_all_access_services(server_name: str = None) -> None:
-            Enables all access services that are registered with this server platform.
-
-        - configure_all_access_services_no_topics(server_name: str = None) -> None:
-            Configures all access services for the specified server with no cohort/Event Bus.
-
-        - clear_all_access_services(server_name: str = None) -> None:
-            Disables the access services. This removes all configuration for the access services and disables the
-            enterprise repository services.
-
-        - get_access_service_config(access_service_name: str, server_name: str = None) -> dict:
-            Retrieves the config for an access service.
-
-        - configure_access_service(access_service_name: str, server_name: str = None) -> None:
-            Enables a single access service.
      """
 
     def __init__(
@@ -1725,7 +1718,7 @@ class CoreServerConfig(Client):
 
         return response.json().get("services", "No view services found")
 
-    def config_all_view_services(self, mdr_server_name: str,
+    def __config_all_view_services(self, mdr_server_name: str,
                                  mdr_server_platform_root_url: str, server_name: str = None) -> None:
         """ Enable all view services that are registered with this OMAG server platform.
 

pyegeria/full_omag_server_config.py

@@ -601,7 +601,6 @@ class FullServerConfig(CoreServerConfig):
 
         self.make_request("POST", url, target_url_root)
 
-
     def get_event_bus(self, server_name: str = None) -> dict:
         """ Returns the event bus configuration for the specified server
 

pyegeria/glossary_omvs.py

@@ -26,8 +26,20 @@ class GlossaryBrowser(Client):
     GlossaryBrowser is a class that extends the Client class. It provides methods to search and retrieve glossaries,
     terms and categories.
 
-    Methods:
-
+    Attributes:
+
+        server_name: str
+            The name of the View Server to connect to.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+        verify_flag: bool
+            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
+            Defaults to False.
 
      """
 

pyegeria/gov_engine.py

@@ -33,7 +33,7 @@ class GovEng(Client):
 
        Attributes:
            server_name: str
-                Name of the server to configure.
+                Name of the server to use.
            platform_url : str
                URL of the server platform to connect to
            user_id : str
@@ -45,13 +45,6 @@ class GovEng(Client):
                 Set true for SSL verification to be enabled, false for disabled. Default behaviour set by the
                 enable_ssl_check attribute from _globals.py
 
-       Methods:
-           __init__(self,
-                    platform_url: str,
-                    end_user_id: str,
-                    )
-            Initializes the connection - throwing an exception if there is a problem
-
        """
 
     def __init__(

pyegeria/governance_author.py

@@ -22,6 +22,8 @@ class GovernanceAuthor(AutomatedCuration):
 
     Attributes:
 
+        server_name: str
+                Name of the server to use.
         platform_url : str
             URL of the server platform to connect to
         user_id : str

pyegeria/my_profile_omvs.py

@@ -20,7 +20,7 @@ class MyProfile(Client):
     Parameters
     ----------
     server_name : str
-        The name of the server to configure.
+        The name of the view server to configure.
     platform_url : str
         The URL of the platform.
     token : str, optional

pyegeria/platform_services.py

@@ -30,7 +30,8 @@ class Platform(Client):
     Client to operate Egeria Platforms - inherits from Server Ops
 
     Attributes:
-
+        server_name: str
+                Name of the server to use.
         platform_url : str
             URL of the server platform to connect to
         user_id : str
@@ -42,44 +43,6 @@ class Platform(Client):
             Flag to indicate if SSL Certificates should be verified in the HTTP requests.
             Defaults to False.
 
-    Methods:
-        __init__(self, platform_url: str, end_user_id: str)
-         Initializes the connection - throwing an exception if there is a problem
-
-
-
-        get_platform_origin() -> str
-
-        activate_server_stored_config(server: str = None, timeout: int = 30) -> None
-
-        activate_server_supplied_config(config_body: str, server: str = None, timeout: int = 30) -> None
-
-        get_active_server_instance_status(server: str = None)-> dict | str
-
-        get_known_servers() -> list[str] | str
-
-        is_server_known(server: str = None) -> bool
-
-        is_server_configured(server: str = None) -> bool
-
-        check_server_active(server: str = None)
-
-        get_active_server_list() -> dict | str
-
-        shutdown_platform() -> None:
-
-        shutdown_server(server: str = None) -> None:
-
-        shutdown_unregister_servers() -> None
-
-        shutdown_all_servers() -> None
-
-        activate_server_if_down(server: str) -> bool
-
-        activate_servers_on_platform(server_list: str) -> bool
-
-       activate_platform(self, platform_name: str, hosted_server_names: [str], timeout:int = 60) -> None
-
     """
 
     admin_command_root: str