Merge pull request #631 from threefoldtech/development

docs
threefoldtech · Dec 27, 2022 · 0409148 · 0409148
2 parents 3ee58a2 + 637f4f9
commit 0409148
Show file tree

Hide file tree

Showing 40 changed files with 401 additions and 439 deletions.
diff --git a/docs/api/jumpscale/clients/redis/redis.html b/docs/api/jumpscale/clients/redis/redis.html
@@ -74,7 +74,7 @@ <h1 class="title">Module <code>jumpscale.clients.redis.redis</code></h1>
                 self.__client = Redis(self.hostname, self.port)
 
         return self.__client
-    
+
     def is_running(self):
         try:
             return self.redis_client.ping()
@@ -154,7 +154,7 @@ <h2 id="args">Args</h2>
                 self.__client = Redis(self.hostname, self.port)
 
         return self.__client
-    
+
     def is_running(self):
         try:
             return self.redis_client.ping()

diff --git a/docs/api/jumpscale/clients/sshclient/sshclient.html b/docs/api/jumpscale/clients/sshclient/sshclient.html
@@ -107,7 +107,7 @@ <h2 id="creating-sshclient-using-that-key-and-executing-commands">Creating sshcl
 
     @property
     def _sshkey(self):
-        &#34;&#34;&#34; Get sshkey client that you have loaded
+        &#34;&#34;&#34;Get sshkey client that you have loaded
         e.g
             JS-NG&gt; localconnection = j.clients.sshclient.new(&#34;localconnection&#34;)
             JS-NG&gt; localconnection.sshkey = &#34;xmonader&#34;
@@ -138,7 +138,7 @@ <h2 id="creating-sshclient-using-that-key-and-executing-commands">Creating sshcl
         return self.__client
 
     def reset_connection(self):
-        &#34;&#34;&#34; Reset the connection
+        &#34;&#34;&#34;Reset the connection
         e.g
             localconnection = j.clients.sshclient.new(&#34;localconnection&#34;)
             localconnection.reset_connection()
@@ -224,7 +224,7 @@ <h2 id="args">Args</h2>
 
     @property
     def _sshkey(self):
-        &#34;&#34;&#34; Get sshkey client that you have loaded
+        &#34;&#34;&#34;Get sshkey client that you have loaded
         e.g
             JS-NG&gt; localconnection = j.clients.sshclient.new(&#34;localconnection&#34;)
             JS-NG&gt; localconnection.sshkey = &#34;xmonader&#34;
@@ -255,7 +255,7 @@ <h2 id="args">Args</h2>
         return self.__client
 
     def reset_connection(self):
-        &#34;&#34;&#34; Reset the connection
+        &#34;&#34;&#34;Reset the connection
         e.g
             localconnection = j.clients.sshclient.new(&#34;localconnection&#34;)
             localconnection.reset_connection()
@@ -531,7 +531,7 @@ <h3>Methods</h3>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def reset_connection(self):
-    &#34;&#34;&#34; Reset the connection
+    &#34;&#34;&#34;Reset the connection
     e.g
         localconnection = j.clients.sshclient.new(&#34;localconnection&#34;)
         localconnection.reset_connection()

diff --git a/docs/api/jumpscale/clients/sshkey/sshkey.html b/docs/api/jumpscale/clients/sshkey/sshkey.html
@@ -91,7 +91,7 @@ <h3 id="writing-ssh-keys-to-files-system">Writing ssh keys to files system</h3>
             self.load_from_file_system()
 
     def load_from_file_system(self):
-        &#34;&#34;&#34; Load public key and private key from files using private key path and public key path
+        &#34;&#34;&#34;Load public key and private key from files using private key path and public key path
         e.g
             ssh_cl = j.clients.sshkey.get(&#34;ssh_test&#34;)
             ssh_cl.load_from_file_system()
@@ -122,7 +122,7 @@ <h3 id="writing-ssh-keys-to-files-system">Writing ssh keys to files system</h3>
 
     @property
     def public_key_path(self):
-        &#34;&#34;&#34; Get the public key path
+        &#34;&#34;&#34;Get the public key path
         e.g
             ssh_cl = j.clients.sshkey.get(&#34;ssh_test&#34;)
             ssh_cl.public_key_path  -&gt; &#34;/root/.config/jumpscale/sshkeys/tU59lc6P.pub&#34;
@@ -133,7 +133,7 @@ <h3 id="writing-ssh-keys-to-files-system">Writing ssh keys to files system</h3>
         return &#34;{}.pub&#34;.format(self.private_key_path)
 
     def write_to_filesystem(self):
-        &#34;&#34;&#34; Write public key and private key to files using private key path and public key path.
+        &#34;&#34;&#34;Write public key and private key to files using private key path and public key path.
         e.g
             ssh_cl = j.clients.sshkey.get(&#34;ssh_test&#34;)
             ssh_cl.write_to_filesystem()
@@ -204,7 +204,7 @@ <h2 id="args">Args</h2>
             self.load_from_file_system()
 
     def load_from_file_system(self):
-        &#34;&#34;&#34; Load public key and private key from files using private key path and public key path
+        &#34;&#34;&#34;Load public key and private key from files using private key path and public key path
         e.g
             ssh_cl = j.clients.sshkey.get(&#34;ssh_test&#34;)
             ssh_cl.load_from_file_system()
@@ -235,7 +235,7 @@ <h2 id="args">Args</h2>
 
     @property
     def public_key_path(self):
-        &#34;&#34;&#34; Get the public key path
+        &#34;&#34;&#34;Get the public key path
         e.g
             ssh_cl = j.clients.sshkey.get(&#34;ssh_test&#34;)
             ssh_cl.public_key_path  -&gt; &#34;/root/.config/jumpscale/sshkeys/tU59lc6P.pub&#34;
@@ -246,7 +246,7 @@ <h2 id="args">Args</h2>
         return &#34;{}.pub&#34;.format(self.private_key_path)
 
     def write_to_filesystem(self):
-        &#34;&#34;&#34; Write public key and private key to files using private key path and public key path.
+        &#34;&#34;&#34;Write public key and private key to files using private key path and public key path.
         e.g
             ssh_cl = j.clients.sshkey.get(&#34;ssh_test&#34;)
             ssh_cl.write_to_filesystem()
@@ -448,7 +448,7 @@ <h2 id="returns">Returns</h2>
 </summary>
 <pre><code class="python">@property
 def public_key_path(self):
-    &#34;&#34;&#34; Get the public key path
+    &#34;&#34;&#34;Get the public key path
     e.g
         ssh_cl = j.clients.sshkey.get(&#34;ssh_test&#34;)
         ssh_cl.public_key_path  -&gt; &#34;/root/.config/jumpscale/sshkeys/tU59lc6P.pub&#34;
@@ -522,7 +522,7 @@ <h3>Methods</h3>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def load_from_file_system(self):
-    &#34;&#34;&#34; Load public key and private key from files using private key path and public key path
+    &#34;&#34;&#34;Load public key and private key from files using private key path and public key path
     e.g
         ssh_cl = j.clients.sshkey.get(&#34;ssh_test&#34;)
         ssh_cl.load_from_file_system()
@@ -544,7 +544,7 @@ <h3>Methods</h3>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def write_to_filesystem(self):
-    &#34;&#34;&#34; Write public key and private key to files using private key path and public key path.
+    &#34;&#34;&#34;Write public key and private key to files using private key path and public key path.
     e.g
         ssh_cl = j.clients.sshkey.get(&#34;ssh_test&#34;)
         ssh_cl.write_to_filesystem()

diff --git a/docs/api/jumpscale/core/base/factory.html b/docs/api/jumpscale/core/base/factory.html
@@ -603,7 +603,7 @@ <h1 class="title">Module <code>jumpscale.core.base.factory</code></h1>
             raise ValueError(&#34;at least one query parameter is required, e.g. age=10&#34;)
 
         new_cursor, count, result = self.store.find(cursor_=cursor_, limit_=limit_, **query)
-        return new_cursor, count, (self._get_object_from_config(data[KEY_FIELD_NAME], data) for data in result)
+        return (new_cursor, count, (self._get_object_from_config(data[KEY_FIELD_NAME], data) for data in result))
 
     def list_all(self):
         &#34;&#34;&#34;
@@ -1478,7 +1478,7 @@ <h2 id="args">Args</h2>
             raise ValueError(&#34;at least one query parameter is required, e.g. age=10&#34;)
 
         new_cursor, count, result = self.store.find(cursor_=cursor_, limit_=limit_, **query)
-        return new_cursor, count, (self._get_object_from_config(data[KEY_FIELD_NAME], data) for data in result)
+        return (new_cursor, count, (self._get_object_from_config(data[KEY_FIELD_NAME], data) for data in result))
 
     def list_all(self):
         &#34;&#34;&#34;
@@ -1657,7 +1657,7 @@ <h2 id="returns">Returns</h2>
         raise ValueError(&#34;at least one query parameter is required, e.g. age=10&#34;)
 
     new_cursor, count, result = self.store.find(cursor_=cursor_, limit_=limit_, **query)
-    return new_cursor, count, (self._get_object_from_config(data[KEY_FIELD_NAME], data) for data in result)</code></pre>
+    return (new_cursor, count, (self._get_object_from_config(data[KEY_FIELD_NAME], data) for data in result))</code></pre>
 </details>
 </dd>
 <dt id="jumpscale.core.base.factory.StoredFactory.get_instance_property"><code class="name flex">

diff --git a/docs/api/jumpscale/core/base/store/whooshfts.html b/docs/api/jumpscale/core/base/store/whooshfts.html
@@ -106,9 +106,7 @@ <h1 class="title">Module <code>jumpscale.core.base.store.whooshfts</code></h1>
         return self.location.type._fields.items()
 
     def get_schema(self):
-        schema_fields = {
-            KEY_FIELD_NAME: fields.ID(unique=True, stored=True),
-        }
+        schema_fields = {KEY_FIELD_NAME: fields.ID(unique=True, stored=True)}
 
         for name, field in self.type_fields:
             field_type_name = field.__class__.__name__
@@ -288,9 +286,7 @@ <h2 id="args">Args</h2>
         return self.location.type._fields.items()
 
     def get_schema(self):
-        schema_fields = {
-            KEY_FIELD_NAME: fields.ID(unique=True, stored=True),
-        }
+        schema_fields = {KEY_FIELD_NAME: fields.ID(unique=True, stored=True)}
 
         for name, field in self.type_fields:
             field_type_name = field.__class__.__name__
@@ -498,9 +494,7 @@ <h3>Methods</h3>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def get_schema(self):
-    schema_fields = {
-        KEY_FIELD_NAME: fields.ID(unique=True, stored=True),
-    }
+    schema_fields = {KEY_FIELD_NAME: fields.ID(unique=True, stored=True)}
 
     for name, field in self.type_fields:
         field_type_name = field.__class__.__name__

diff --git a/docs/api/jumpscale/core/config/config.html b/docs/api/jumpscale/core/config/config.html
@@ -186,10 +186,7 @@ <h2 id="getset">Get/Set</h2>
         &#34;debug&#34;: True,
         &#34;shell&#34;: &#34;ptpython&#34;,
         &#34;logging&#34;: {
-            &#34;default&#34;: {
-                &#34;enabled&#34;: True,
-                &#34;level&#34;: 10,
-            },
+            &#34;default&#34;: {&#34;enabled&#34;: True, &#34;level&#34;: 10},
             &#34;redis&#34;: {
                 &#34;enabled&#34;: True,
                 &#34;level&#34;: 15,
@@ -214,9 +211,7 @@ <h2 id="getset">Get/Set</h2>
         },
         &#34;factory&#34;: {&#34;always_reload&#34;: False},
         &#34;store&#34;: &#34;filesystem&#34;,
-        &#34;threebot&#34;: {
-            &#34;default&#34;: &#34;&#34;,
-        },
+        &#34;threebot&#34;: {&#34;default&#34;: &#34;&#34;},
     }
 
 
@@ -444,10 +439,7 @@ <h2 id="returns">Returns</h2>
         &#34;debug&#34;: True,
         &#34;shell&#34;: &#34;ptpython&#34;,
         &#34;logging&#34;: {
-            &#34;default&#34;: {
-                &#34;enabled&#34;: True,
-                &#34;level&#34;: 10,
-            },
+            &#34;default&#34;: {&#34;enabled&#34;: True, &#34;level&#34;: 10},
             &#34;redis&#34;: {
                 &#34;enabled&#34;: True,
                 &#34;level&#34;: 15,
@@ -472,9 +464,7 @@ <h2 id="returns">Returns</h2>
         },
         &#34;factory&#34;: {&#34;always_reload&#34;: False},
         &#34;store&#34;: &#34;filesystem&#34;,
-        &#34;threebot&#34;: {
-            &#34;default&#34;: &#34;&#34;,
-        },
+        &#34;threebot&#34;: {&#34;default&#34;: &#34;&#34;},
     }</code></pre>
 </details>
 </dd>

diff --git a/docs/api/jumpscale/core/logging/logging.html b/docs/api/jumpscale/core/logging/logging.html
@@ -39,13 +39,7 @@ <h1 class="title">Module <code>jumpscale.core.logging.logging</code></h1>
 from jumpscale.loader import j
 
 
-LEVELS = {
-    10: &#34;DEBUG&#34;,
-    20: &#34;INFO&#34;,
-    30: &#34;WARNING&#34;,
-    40: &#34;ERROR&#34;,
-    50: &#34;CRITICAL&#34;,
-}
+LEVELS = {10: &#34;DEBUG&#34;, 20: &#34;INFO&#34;, 30: &#34;WARNING&#34;, 40: &#34;ERROR&#34;, 50: &#34;CRITICAL&#34;}
 
 # init is kept as a name for backward compatibility
 DEFAULT_APP_NAME = &#34;init&#34;