Update documentation

src/pyrdfrules/__init__.py

@@ -1,3 +1,9 @@
 # SPDX-FileCopyrightText: 2023-present Karel Douda <[email protected]>
 #
 # SPDX-License-Identifier: MIT
+
+"""
+
+PyRDFRules is a Python library for working with RDFRules. It provides a simple interface for creating and managing RDFRules pipelines.
+
+"""

src/pyrdfrules/api/__init__.py

@@ -0,0 +1,6 @@
+"""
+API module contains the classes that are used to interact with RDFRules, mainly using the HTTP interface.
+
+Each API domain contains a base class and concrete implementations (e.g. `CacheApi` and `CacheHttpApi`).
+This allows for mocking and testing, but also future changes in the API without changing the client code.
+"""

src/pyrdfrules/api/cache/__init__.py

@@ -0,0 +1,3 @@
+"""
+Entities for interacting with the cache API of RDFRules.
+"""

src/pyrdfrules/api/cache/cache_api.py

@@ -9,18 +9,38 @@ def __init__(self, context: RDFRulesApiContext) -> None:
         self.context = context
         pass
 
-    def get_memory_info(self):
+    def get_memory_info(self) -> dict:
         """Gets memory info.
+        
+        Returns:
+            dict: Memory info.
+        
         """
 
-    def clear(self):
+    def clear(self) -> None:
         """Clears the cache.
+        
+        Returns:
+            None
         """
 
-    def delete(self, key: str):
+    def delete(self, key: str) -> None:
         """Deletes a key from the cache.
+        
+        Args:
+            key (str): Key to delete.
+            
+        Throws:
+            Exception: If the key does not exist.
         """
 
     def alias(self, key: str, alias: str):
         """Creates an alias for a key.
+        
+        Args:
+            key (str): Key to alias.
+            alias (str): Alias to create.
+            
+        Throws:
+            Exception: If the key does not exist.
         """

src/pyrdfrules/api/cache/cache_http_api.py

@@ -5,30 +5,20 @@
 
 class CacheHttpApi(CacheApi):
 
+    __doc__ = CacheApi.__doc__
+
     def __init__(self, context: HTTPRDFRulesApiContext) -> None:
         super().__init__(context)
         pass
 
     def get_memory_info(self) -> dict:
-        """Gets memory info.
-        """
-
         return self.context.get_http_client().get(CACHE_MEMORY_URL).json()
 
     def clear(self) -> None:
-        """Clears the cache.
-        """
-
         self.context.get_http_client().get(CACHE_CLEAR_URL)
 
-    def delete(self, key: str):
-        """Deletes a key from the cache.
-        """
-
+    def delete(self, key: str) -> None:
         self.context.get_http_client().delete(CACHE_DELETE_URL.format(key = key))
 
-    def alias(self, key: str, alias: str):
-        """Creates an alias for a key.
-        """
-
+    def alias(self, key: str, alias: str) -> None:
         pass

src/pyrdfrules/api/http_rdfrules_api_context.py

@@ -7,6 +7,9 @@
 from pyrdfrules.config import Config
 
 class HTTPRDFRulesApiContext(RDFRulesApiContext):
+    """
+    Context class for the RDFRules API, passed around for HTTP API clients.
+    """
 
     url: Url
     """URL of the RDFRules API server.

src/pyrdfrules/api/rdfrules_api_context.py

@@ -1,2 +1,5 @@
 class RDFRulesApiContext():
+    """Base context class passed around the API classes.
+    """
+
     pass

src/pyrdfrules/api/task/exception/task_not_found_exception.py

@@ -1,5 +1,8 @@
 from pyrdfrules.common.exception.pyrdfrules_exception import PyRDFRulesException
 
 class TaskNotFoundException(PyRDFRulesException):
-    def __init__(self, task_id):
+    """Thrown when a task is not found in the RDFRules instance.
+    """
+
+    def __init__(self, task_id: str):
         super(TaskNotFoundException, self).__init__(f'Task with id {task_id} not found')

src/pyrdfrules/api/task/task_http_api.py

@@ -12,6 +12,8 @@
 
 class TaskHttpApi(TaskApi):
 
+    __doc__ = TaskApi.__doc__
+
     context: HTTPRDFRulesApiContext
 
     def __init__(self, context: HTTPRDFRulesApiContext) -> None:

src/pyrdfrules/api/workspace/workspace_api.py

@@ -2,7 +2,7 @@
 
 
 class WorkspaceApi():
-
+        
     context: RDFRulesApiContext
 
     def __init__(self, context: RDFRulesApiContext) -> None:

src/pyrdfrules/api/workspace/workspace_http_api.py

@@ -6,6 +6,8 @@
 
 class WorkspaceHttpApi(WorkspaceApi):
 
+    __doc__ = WorkspaceApi.__doc__
+
     context: HTTPRDFRulesApiContext
 
     def __init__(self, context: HTTPRDFRulesApiContext) -> None: