Merge pull request #6 from DACCS-Climate/rebranding

Changing DACCS name to Marble

Author: dchandan

daccs_client/__init__.py

@@ -0,0 +1,4 @@
+from .client import MarbleClient
+from .exceptions import MarbleBaseError, ServiceNotAvailableError, UnknownNodeError
+from .node import MarbleNode
+from .services import MarbleService

daccs_client/exceptions.py

@@ -9,14 +9,14 @@
 import dateutil.parser
 import requests
 
-from daccs_client.constants import CACHE_FNAME, CACHE_META_FNAME, NODE_REGISTRY_URL
-from daccs_client.exceptions import UnknownNodeError
-from daccs_client.node import DACCSNode
+from marble_client.constants import CACHE_FNAME, CACHE_META_FNAME, NODE_REGISTRY_URL
+from marble_client.exceptions import UnknownNodeError
+from marble_client.node import MarbleNode
 
-__all__ = ["DACCSClient"]
+__all__ = ["MarbleClient"]
 
 
-class DACCSClient:
+class MarbleClient:
     def __init__(self, fallback: Optional[bool] = True) -> None:
         """Constructor method
 
@@ -30,7 +30,7 @@ def __init__(self, fallback: Optional[bool] = True) -> None:
         :raise RuntimeError: If cached registry needs to be read but there is no cache
         """
         self._fallback = fallback
-        self._nodes: dict[str, DACCSNode] = {}
+        self._nodes: dict[str, MarbleNode] = {}
         self._registry: dict = {}
         try:
             registry = requests.get(NODE_REGISTRY_URL)
@@ -45,17 +45,17 @@ def __init__(self, fallback: Optional[bool] = True) -> None:
             self._load_registry_from_cloud(registry)
 
         for node, node_details in self._registry.items():
-            self._nodes[node] = DACCSNode(node, node_details)
+            self._nodes[node] = MarbleNode(node, node_details)
 
     @property
-    def nodes(self) -> dict[str, DACCSNode]:
+    def nodes(self) -> dict[str, MarbleNode]:
         return self._nodes
 
-    def __getitem__(self, node: str) -> DACCSNode:
+    def __getitem__(self, node: str) -> MarbleNode:
         try:
             return self.nodes[node]
         except KeyError:
-            raise UnknownNodeError(f"No node named '{node}' in the DACCS network.") from None
+            raise UnknownNodeError(f"No node named '{node}' in the Marble network.") from None
 
     def _load_registry_from_cloud(self, registry_response: requests.Response) -> None:
         try:
@@ -122,5 +122,5 @@ def _save_registry_as_cache(self):
 
 
 if __name__ == "__main__":
-    d = DACCSClient()
+    d = MarbleClient()
     print(d.nodes)

marble_client/__init__.py

@@ -4,13 +4,13 @@
 
 __all__ = ("NODE_REGISTRY_URL", "CACHE_FNAME", "CACHE_META_FNAME")
 
-# DACCS node registry URL
+# Marble node registry URL
 NODE_REGISTRY_URL: str = os.getenv(
-    "DACCS_NODE_REGISTRY_URL",
+    "MARBLE_NODE_REGISTRY_URL",
     "https://raw.githubusercontent.com/DACCS-Climate/DACCS-node-registry/current-registry/node_registry.json",
 )
 
-_CACHE_DIR: str = os.getenv("DACCS_CACHE_DIR", user_cache_dir("daccs_client_python"))
+_CACHE_DIR: str = os.getenv("MARBLE_CACHE_DIR", user_cache_dir("marble_client_python"))
 
 # location to write registry cache
 CACHE_FNAME: str = os.path.join(_CACHE_DIR, "registry.cached.json")

daccs_client/client.py marble_client/client.pydaccs_client/client.py renamed to marble_client/client.py

@@ -0,0 +1,10 @@
+class MarbleBaseError(Exception):
+    pass
+
+
+class ServiceNotAvailableError(MarbleBaseError):
+    pass
+
+
+class UnknownNodeError(MarbleBaseError):
+    pass

daccs_client/constants.py marble_client/constants.pydaccs_client/constants.py renamed to marble_client/constants.py

@@ -4,13 +4,13 @@
 import dateutil.parser
 import requests
 
-from daccs_client.exceptions import ServiceNotAvailableError
-from daccs_client.services import DACCSService
+from marble_client.exceptions import ServiceNotAvailableError
+from marble_client.services import MarbleService
 
-__all__ = ["DACCSNode"]
+__all__ = ["MarbleNode"]
 
 
-class DACCSNode:
+class MarbleNode:
     def __init__(self, nodename: str, jsondata: dict[str]) -> None:
         self._nodedata = jsondata
         self._name = nodename
@@ -21,7 +21,7 @@ def __init__(self, nodename: str, jsondata: dict[str]) -> None:
         self._services: list[str] = []
 
         for service in jsondata["services"]:
-            s = DACCSService(service)
+            s = MarbleService(service)
             setattr(self, s.name, s)
             self._services.append(s.name)
 
@@ -74,21 +74,21 @@ def last_updated(self) -> datetime:
         return dateutil.parser.isoparse(self._nodedata["last_updated"])
 
     @property
-    def daccs_version(self) -> str:
+    def marble_version(self) -> str:
         return self._nodedata["version"]
 
     @property
     def services(self) -> list[str]:
         return self._services
 
-    def __getitem__(self, service: str) -> DACCSService:
+    def __getitem__(self, service: str) -> MarbleService:
         """Get a service at a node by specifying its name.
 
-        :param service: Name of the DACCS service
+        :param service: Name of the Marble service
         :type service: str
         :raises ServiceNotAvailable: This exception is raised if the service is not available at the node
         :return: _description_
-        :rtype: DACCSservice
+        :rtype: Marbleservice
         """
         try:
             s = getattr(self, service)
@@ -99,7 +99,7 @@ def __getitem__(self, service: str) -> DACCSService:
     def __contains__(self, service: str) -> bool:
         """Check if a service is available at a node
 
-        :param service: Name of the DACCS service
+        :param service: Name of the Marble service
         :type service: str
         :return: True if the service is available, False otherwise
         :rtype: bool

marble_client/exceptions.py

@@ -1,13 +1,13 @@
 from typing import Any
 
-__all__ = ["DACCSService"]
+__all__ = ["MarbleService"]
 
 
-class DACCSService:
+class MarbleService:
     def __init__(self, servicejson: dict[str, Any]) -> None:
         """Constructor method
 
-        :param servicejson: A JSON representing the service according to the schema defined for the DACCS node registry
+        :param servicejson: A JSON representing the service according to the schema defined for the Marble node registry
         :type servicejson: dict[str, Any]
         """
         self._name = servicejson["name"]
@@ -50,11 +50,11 @@ def description(self) -> str:
     @property
     def url(self) -> str:
         """Access the URL for the service itself. Note: the preferred approach to access the service
-        URL is via just using the name of the DACCSService object.
+        URL is via just using the name of the MarbleService object.
 
         E.g.::
 
-            s = DACCSService(jsondata)
+            s = MarbleService(jsondata)
             s  # this prints http://url-of-service
 
         :return: Service URL
@@ -67,7 +67,7 @@ def doc_url(self) -> str:
         return self._service_doc
 
     def __str__(self) -> str:
-        return f"DACCS service: {self.name}\n"
+        return f"Marble service: {self.name}\n"
 
     def __repr__(self) -> str:
         return self._service

daccs_client/node.py marble_client/node.pydaccs_client/node.py renamed to marble_client/node.py

@@ -1,16 +1,16 @@
 [build-system]
-requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
+requires = ["setuptools>=61.0"]
 
 [project]
-name = "daccs_client"
 authors = [{name = "Deepak Chandan", email = "[email protected]"}]
-description = "A python client to access information about the DACCS network"
-version = "0.0.1"
+description = "A python client to access information about the Marble climate infomatics network"
+name = "marble_client"
 requires-python = ">=3.9"
+version = "0.0.1"
 
 [tool.setuptools]
-packages = ["daccs_client"]
+packages = ["marble_client"]
 
 [tool.black]
 line-length = 120