ds docstrings

Author: ea-rus

minds/datasources/datasources.py

@@ -21,6 +21,18 @@ def __init__(self, client):
         self.api = client.api
 
     def create(self, ds_config: DatabaseConfig, replace=False):
+        """
+        Create new datasource and return it
+
+        :param ds_config: datasource configuration, properties:
+           - name: str, name of datatasource
+           - engine: str, type of database handler, for example 'postgres', 'mysql', ...
+           - description: str, description of the database. Used by mind to know what data can be got from it.
+           - connection_data: dict, optional, credentials to connect to database
+           - tables: list of str, optional, list of allowed tables
+        :return: datasource object
+        """
+
         name = ds_config.name
 
         if replace:
@@ -34,6 +46,12 @@ def create(self, ds_config: DatabaseConfig, replace=False):
         return self.get(name)
 
     def list(self) -> List[Datasource]:
+        """
+        Returns list of datasources
+
+        :return: iterable datasources
+        """
+
         data = self.api.get('/datasources').json()
         ds_list = []
         for item in data:
@@ -44,6 +62,13 @@ def list(self) -> List[Datasource]:
         return ds_list
 
     def get(self, name: str) -> Datasource:
+        """
+        Get datasource by name
+
+        :param name: name of datasource
+        :return: datasource object
+        """
+
         data = self.api.get(f'/datasources/{name}').json()
 
         # TODO skip not sql skills
@@ -52,4 +77,10 @@ def get(self, name: str) -> Datasource:
         return Datasource(**data)
 
     def drop(self, name: str):
+        """
+        Drop datasource by name
+
+        :param name: name of datasource
+        """
+
         self.api.delete(f'/datasources/{name}')