diff --git a/.buildinfo b/.buildinfo index 671abc8..1f1cce2 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 7c1c321fedc909dca2311ad00a70ec63 +config: 0efed8557f8133d9c383ee8226a85d1b tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_modules/index.html b/_modules/index.html index e639478..fd2c5fb 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -5,7 +5,7 @@ - Overview: module code - SewerRat 0.0.post1.dev1+ge3e1b6e documentation + Overview: module code - SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -165,7 +165,7 @@
-
SewerRat 0.0.post1.dev1+ge3e1b6e documentation
 +
SewerRat 0.0.post1.dev1+g0462be7 documentation
@@ -189,7 +189,7 @@
- SewerRat 0.0.post1.dev1+ge3e1b6e documentation + SewerRat 0.0.post1.dev1+g0462be7 documentation
-
+
diff --git a/_modules/sewerrat/deregister.html b/_modules/sewerrat/deregister.html index 216844f..1310e1a 100644 --- a/_modules/sewerrat/deregister.html +++ b/_modules/sewerrat/deregister.html @@ -5,7 +5,7 @@ - sewerrat.deregister - SewerRat 0.0.post1.dev1+ge3e1b6e documentation + sewerrat.deregister - SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -165,7 +165,7 @@
-
SewerRat 0.0.post1.dev1+ge3e1b6e documentation
 +
SewerRat 0.0.post1.dev1+g0462be7 documentation
@@ -189,7 +189,7 @@
- SewerRat 0.0.post1.dev1+ge3e1b6e documentation + SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -326,7 +326,7 @@

Source code for sewerrat.deregister
-
+
diff --git a/_modules/sewerrat/list_files.html b/_modules/sewerrat/list_files.html index f0460ee..8b91ca3 100644 --- a/_modules/sewerrat/list_files.html +++ b/_modules/sewerrat/list_files.html @@ -5,7 +5,7 @@ - sewerrat.list_files - SewerRat 0.0.post1.dev1+ge3e1b6e documentation + sewerrat.list_files - SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -165,7 +165,7 @@
-
SewerRat 0.0.post1.dev1+ge3e1b6e documentation
 +
SewerRat 0.0.post1.dev1+g0462be7 documentation
@@ -189,7 +189,7 @@
- SewerRat 0.0.post1.dev1+ge3e1b6e documentation + SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -319,7 +319,7 @@

Source code for sewerrat.list_files
-
+
diff --git a/_modules/sewerrat/query.html b/_modules/sewerrat/query.html index 8520258..afe1dbf 100644 --- a/_modules/sewerrat/query.html +++ b/_modules/sewerrat/query.html @@ -5,7 +5,7 @@ - sewerrat.query - SewerRat 0.0.post1.dev1+ge3e1b6e documentation + sewerrat.query - SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -165,7 +165,7 @@
-
SewerRat 0.0.post1.dev1+ge3e1b6e documentation
 +
SewerRat 0.0.post1.dev1+g0462be7 documentation
@@ -189,7 +189,7 @@
- SewerRat 0.0.post1.dev1+ge3e1b6e documentation + SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -366,7 +366,7 @@

Source code for sewerrat.query
-
+
diff --git a/_modules/sewerrat/register.html b/_modules/sewerrat/register.html index 69e21db..189fd5c 100644 --- a/_modules/sewerrat/register.html +++ b/_modules/sewerrat/register.html @@ -5,7 +5,7 @@ - sewerrat.register - SewerRat 0.0.post1.dev1+ge3e1b6e documentation + sewerrat.register - SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -165,7 +165,7 @@
-
SewerRat 0.0.post1.dev1+ge3e1b6e documentation
 +
SewerRat 0.0.post1.dev1+g0462be7 documentation
@@ -189,7 +189,7 @@
- SewerRat 0.0.post1.dev1+ge3e1b6e documentation + SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -339,7 +339,7 @@

Source code for sewerrat.register
-
+
diff --git a/_modules/sewerrat/retrieve_directory.html b/_modules/sewerrat/retrieve_directory.html index 31cf55b..6b4e272 100644 --- a/_modules/sewerrat/retrieve_directory.html +++ b/_modules/sewerrat/retrieve_directory.html @@ -5,7 +5,7 @@ - sewerrat.retrieve_directory - SewerRat 0.0.post1.dev1+ge3e1b6e documentation + sewerrat.retrieve_directory - SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -165,7 +165,7 @@
-
SewerRat 0.0.post1.dev1+ge3e1b6e documentation
 +
SewerRat 0.0.post1.dev1+g0462be7 documentation
@@ -189,7 +189,7 @@
- SewerRat 0.0.post1.dev1+ge3e1b6e documentation + SewerRat 0.0.post1.dev1+g0462be7 documentation @@ -246,8 +246,8 @@

Source code for sewerrat.retrieve_directory

 import os
 import tempfile
 import urllib
+import time
 import requests
-import shutil
 from . import _utils as ut
 
 
@@ -258,21 +258,34 @@ 
Source code for sewerrat.retrieve_directory
     return os.path.join(cache, urllib.parse.quote_plus(url))
 
 
-def _acquire_file_raw(cache: str, path: str, url: str, overwrite: bool) -> str:
+def _full_file_url(url: str, path: str) -> str:
+    return url + "/retrieve/file?path=" + urllib.parse.quote_plus(path)
+
+
+def _acquire_file_raw(cache: str, path: str, url: str, overwrite: bool, update_delay: int) -> str:
     target = os.path.join(cache, "LOCAL" + path) # os.path.join behaves poorly when 'path' is an absolute path.
 
-    if overwrite or not os.path.exists(target):
+    if not overwrite:
+        if not os.path.exists(target):
+            overwrite = True
+        else:
+            last_mod = os.path.getmtime(target)
+            if last_mod + update_delay < time.time(): # only check older files for updates, to avoid excessive queries.
+                with requests.head(_full_file_url(url, path)) as r:
+                    if r.status_code >= 300:
+                        raise format_error(r)
+                    modtime = ut.parse_remote_last_modified(r)
+                    if modtime is not None and modtime > last_mod:
+                        overwrite = True
+
+    if overwrite: 
         tempdir = os.path.join(cache, "TEMP")
         os.makedirs(tempdir, exist_ok=True)
         os.makedirs(os.path.dirname(target), exist_ok=True)
 
-        tempfid, temppath = tempfile.mkstemp(dir=tempdir)
+        _, temppath = tempfile.mkstemp(dir=tempdir)
         try:
-            with requests.get(url + "/retrieve/file?path=" + urllib.parse.quote_plus(path), stream=True) as r:
-                if r.status_code >= 300:
-                    raise ut.format_error(r)
-                with os.fdopen(tempfid, 'wb') as f:
-                    shutil.copyfileobj(r.raw, f)
+            ut.download_file(_full_file_url(url, path), temppath)
             os.rename(temppath, target) # this should be more or less atomic, so no need for locks.
         finally:
             if os.path.exists(temppath):
@@ -281,13 +294,13 @@ 
Source code for sewerrat.retrieve_directory
     return target
 
 
-def _acquire_file(cache: str, path: str, name: str, url: str, overwrite: bool) -> str:
-    return _acquire_file_raw(cache, path + "/" + name, url, overwrite)
+def _acquire_file(cache: str, path: str, name: str, url: str, overwrite: bool, update_delay: int) -> str:
+    return _acquire_file_raw(cache, path + "/" + name, url, overwrite, update_delay)
 
 
 

 [docs]
-def retrieve_directory(path: str, url: str, cache: Optional[str] = None, force_remote: bool = False, overwrite: bool = False, concurrent: int = 1) -> str:
+def retrieve_directory(path: str, url: str, cache: Optional[str] = None, force_remote: bool = False, overwrite: bool = False, concurrent: int = 1, update_delay: int = 3600) -> str:
     """
     Obtain the path to a registered directory or one of its subdirectories.
     This may create a local copy of the directory's contents if the caller
@@ -315,6 +328,10 @@ 
Source code for sewerrat.retrieve_directory
         concurrent:
             Number of concurrent downloads.
 
+        update_delay: 
+            Maximum age of a cached file, in seconds. Older files will be
+            automatically checked for updates.
+
     Returns:
         Path to the subdirectory on the caller's filesystem.  This is either
         ``path`` if it is accessible, or a path to a local cache of the
@@ -326,8 +343,12 @@ 
Source code for sewerrat.retrieve_directory
     cache = _local_root(cache, url)
     final = os.path.join(cache, "LOCAL" + path) # os.path.join doesn't like joining of absolute paths.
     ok = os.path.join(cache, "SUCCESS" + path, "....OK")
+
     if not overwrite and os.path.exists(ok) and os.path.exists(final):
-        return final
+        # Only check for updates every 'update_delay' since the last check, so
+        # as to avoid excessive queries to the API.
+        if os.path.getmtime(ok) + update_delay >= time.time():
+            return final
 
     res = requests.get(url + "/list?path=" + urllib.parse.quote_plus(path) + "&recursive=true")
     if res.status_code >= 300:
@@ -336,12 +357,12 @@ 
Source code for sewerrat.retrieve_directory
 
     if concurrent == 1:
         for y in listing:
-            _acquire_file(cache, name=y, path=path, url=url, overwrite=overwrite)
+            _acquire_file(cache, name=y, path=path, url=url, overwrite=overwrite, update_delay=update_delay)
     else:
         import multiprocessing
         import functools
         with multiprocessing.Pool(concurrent) as p:
-            p.map(functools.partial(_acquire_file, cache, path, url=url, overwrite=overwrite), listing)
+            p.map(functools.partial(_acquire_file, cache, path, url=url, overwrite=overwrite, update_delay=update_delay), listing)
 
     # We use a directory-level OK file to avoid having to scan through all 
     # the directory contents to indicate that it's complete.
@@ -382,7 +403,7 @@ 
Source code for sewerrat.retrieve_directory
       
     
   

-

+

     
     
     
diff --git a/_modules/sewerrat/retrieve_file.html b/_modules/sewerrat/retrieve_file.html
index 0376e3b..c47de54 100644
--- a/_modules/sewerrat/retrieve_file.html
+++ b/_modules/sewerrat/retrieve_file.html
@@ -5,7 +5,7 @@
     
 
     
-        sewerrat.retrieve_file - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        sewerrat.retrieve_file - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -165,7 +165,7 @@
       
     

     

-      
SewerRat 0.0.post1.dev1+ge3e1b6e documentation

+      
SewerRat 0.0.post1.dev1+g0462be7 documentation

     

     

       

@@ -189,7 +189,7 @@
       

   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -249,7 +249,7 @@ 
Source code for sewerrat.retrieve_file
 
 

 [docs]
-def retrieve_file(path, url, cache: Optional[str] = None, force_remote: bool = False, overwrite: bool = False) -> str:
+def retrieve_file(path, url, cache: Optional[str] = None, force_remote: bool = False, overwrite: bool = False, update_delay: int = 3600) -> str:
     """
     Retrieve the path to a single file in a registered directory. This will
     call the REST API if the caller is not on the same filesystem. 
@@ -273,6 +273,10 @@ 
Source code for sewerrat.retrieve_file
         overwrite:
             Whether to overwrite existing files in the cache.
 
+        update_delay: 
+            Maximum age of a cached file, in seconds. Older files will be
+            automatically checked for updates.
+
     Returns:
         Path to the subdirectory on the caller's filesystem. This is either
         ``path`` if it is accessible, or a path to a local copy otherwise.
@@ -281,7 +285,7 @@ 
Source code for sewerrat.retrieve_file
         return path
     else:
         cache = _local_root(cache, url)
-        return _acquire_file_raw(cache, path, url=url, overwrite=overwrite)

+        return _acquire_file_raw(cache, path, url=url, overwrite=overwrite, update_delay=update_delay)

 
 

         
@@ -315,7 +319,7 @@ 
Source code for sewerrat.retrieve_file
       
     
   

-

+

     
     
     
diff --git a/_modules/sewerrat/retrieve_metadata.html b/_modules/sewerrat/retrieve_metadata.html
index 7ba35f2..6d93843 100644
--- a/_modules/sewerrat/retrieve_metadata.html
+++ b/_modules/sewerrat/retrieve_metadata.html
@@ -5,7 +5,7 @@
     
 
     
-        sewerrat.retrieve_metadata - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        sewerrat.retrieve_metadata - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -165,7 +165,7 @@
       
     

     

-      
SewerRat 0.0.post1.dev1+ge3e1b6e documentation

+      
SewerRat 0.0.post1.dev1+g0462be7 documentation

     

     

       

@@ -189,7 +189,7 @@
       

   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -308,7 +308,7 @@ 
Source code for sewerrat.retrieve_metadata
       
     
   

-

+

     
     
     
diff --git a/_modules/sewerrat/start_sewerrat.html b/_modules/sewerrat/start_sewerrat.html
index eb6e70e..dc14e42 100644
--- a/_modules/sewerrat/start_sewerrat.html
+++ b/_modules/sewerrat/start_sewerrat.html
@@ -5,7 +5,7 @@
     
 
     
-        sewerrat.start_sewerrat - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        sewerrat.start_sewerrat - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -165,7 +165,7 @@
       
     

     

-      
SewerRat 0.0.post1.dev1+ge3e1b6e documentation

+      
SewerRat 0.0.post1.dev1+g0462be7 documentation

     

     

       

@@ -189,7 +189,7 @@
       

   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -246,6 +246,7 @@ 
Source code for sewerrat.start_sewerrat
 import requests
 import os
 import time
+from . import _utils as ut
 
 
 test_api_process = None
@@ -322,10 +323,7 @@ 
Source code for sewerrat.start_sewerrat
         import shutil
         os.makedirs(cache, exist_ok=True)
         tmp = exe + ".tmp"
-        with requests.get(url, stream=True) as r:
-            with open(tmp, 'wb') as f:
-                shutil.copyfileobj(r.raw, f)
-
+        ut.download_file(url, tmp)
         os.chmod(tmp, 0o755)
 
         # Using a write-and-rename paradigm to provide some atomicity. Note
@@ -411,7 +409,7 @@ 
Source code for sewerrat.start_sewerrat
       
     
   

-

+

     
     
     
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
index f441237..185e7c9 100644
--- a/_static/documentation_options.js
+++ b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.0.post1.dev1+ge3e1b6e',
+    VERSION: '0.0.post1.dev1+g0462be7',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/api/modules.html b/api/modules.html
index 83e8674..f0ec7e7 100644
--- a/api/modules.html
+++ b/api/modules.html
@@ -6,7 +6,7 @@
 
 
     
-        sewerrat - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        sewerrat - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -166,7 +166,7 @@
       
     

     

-      
SewerRat 0.0.post1.dev1+ge3e1b6e documentation

+      
SewerRat 0.0.post1.dev1+g0462be7 documentation

     

     

       

@@ -190,7 +190,7 @@
       

   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -343,7 +343,7 @@ 
sewerrat
       
     
   

-

+

     
     
     
diff --git a/api/sewerrat.html b/api/sewerrat.html
index de59ec9..e90db21 100644
--- a/api/sewerrat.html
+++ b/api/sewerrat.html
@@ -6,7 +6,7 @@
 
 
     
-        sewerrat package - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        sewerrat package - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -166,7 +166,7 @@
       
     

     

-      
SewerRat 0.0.post1.dev1+ge3e1b6e documentation

+      
SewerRat 0.0.post1.dev1+g0462be7 documentation

     

     

       

@@ -190,7 +190,7 @@
       

   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -374,7 +374,7 @@ 
Submodules
sewerrat.retrieve_directory module

 

 

-sewerrat.retrieve_directory.retrieve_directory(path, url, cache=None, force_remote=False, overwrite=False, concurrent=1)[source]

+sewerrat.retrieve_directory.retrieve_directory(path, url, cache=None, force_remote=False, overwrite=False, concurrent=1, update_delay=3600)[source]
 
Obtain the path to a registered directory or one of its subdirectories.
 This may create a local copy of the directory’s contents if the caller
 is not on the same filesystem.

@@ -390,6 +390,8 @@ 
Submodulespath is present on the same filesystem.

 
  • overwrite (bool) – Whether to overwrite existing files in the cache.
    • 
 
  • concurrent (int) – Number of concurrent downloads.
    • 
+
  • update_delay (int) – Maximum age of a cached file, in seconds. Older files will be
+automatically checked for updates.
    • 
 
 
    
 
    Return type:
    
@@ -408,7 +410,7 @@ 
    Submodules
    sewerrat.retrieve_file module
    
 
    
 
    
-sewerrat.retrieve_file.retrieve_file(path, url, cache=None, force_remote=False, overwrite=False)[source]
    
+sewerrat.retrieve_file.retrieve_file(path, url, cache=None, force_remote=False, overwrite=False, update_delay=3600)[source]
 
    Retrieve the path to a single file in a registered directory. This will
 call the REST API if the caller is not on the same filesystem.
    
 
    
@@ -422,6 +424,8 @@ 
    Submodulespath is present on the
 same filesystem.
    
 
  • overwrite (bool) – Whether to overwrite existing files in the cache.
    • 
+
  • update_delay (int) – Maximum age of a cached file, in seconds. Older files will be
+automatically checked for updates.
    • 
 
 
    
 
    Return type:
    
@@ -601,7 +605,7 @@ 
    Submodules
+
    
     
     
     
diff --git a/authors.html b/authors.html
index ba9826f..2af18d5 100644
--- a/authors.html
+++ b/authors.html
@@ -6,7 +6,7 @@
 
 
     
-        Contributors - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        Contributors - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -166,7 +166,7 @@
       
     
    
     
    
-      
    SewerRat 0.0.post1.dev1+ge3e1b6e documentation
    
+      
    SewerRat 0.0.post1.dev1+g0462be7 documentation
    
     
    
     
    
       
    
@@ -190,7 +190,7 @@
       
    
   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -304,7 +304,7 @@ 
    Contributors
+
    
     
     
     
diff --git a/changelog.html b/changelog.html
index 27211c1..6e826b2 100644
--- a/changelog.html
+++ b/changelog.html
@@ -6,7 +6,7 @@
 
 
     
-        Changelog - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        Changelog - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -166,7 +166,7 @@
       
     
    
     
    
-      
    SewerRat 0.0.post1.dev1+ge3e1b6e documentation
    
+      
    SewerRat 0.0.post1.dev1+g0462be7 documentation
    
     
    
     
    
       
    
@@ -190,7 +190,7 @@
       
    
   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -343,7 +343,7 @@ 
    Version 0.1.0
+
    
     
     
     
diff --git a/contributing.html b/contributing.html
index f417502..8029dcb 100644
--- a/contributing.html
+++ b/contributing.html
@@ -6,7 +6,7 @@
 
 
     
-        Contributing - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        Contributing - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -166,7 +166,7 @@
       
     
    
     
    
-      
    SewerRat 0.0.post1.dev1+ge3e1b6e documentation
    
+      
    SewerRat 0.0.post1.dev1+g0462be7 documentation
    
     
    
     
    
       
    
@@ -190,7 +190,7 @@
       
    
   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -569,7 +569,7 @@ 
    Releases
       
     
   
    
-
    
+
    
     
     
     
diff --git a/genindex.html b/genindex.html
index 3e1c7cb..bd147ff 100644
--- a/genindex.html
+++ b/genindex.html
@@ -4,7 +4,7 @@
     
     
 
-    Index - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+    Index - SewerRat 0.0.post1.dev1+g0462be7 documentation
 
     
     
@@ -164,7 +164,7 @@
       
     
    
     
    
-      
    SewerRat 0.0.post1.dev1+ge3e1b6e documentation
    
+      
    SewerRat 0.0.post1.dev1+g0462be7 documentation
    
     
    
     
    
       
    
@@ -188,7 +188,7 @@
       
    
   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -433,7 +433,7 @@ 
    S
    
       
     
   
    
-
    
+
    
     
     
     
diff --git a/index.html b/index.html
index a6a4045..0a8e670 100644
--- a/index.html
+++ b/index.html
@@ -6,7 +6,7 @@
 
 
     
-        SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -166,7 +166,7 @@
       
     
    
     
    
-      
    SewerRat 0.0.post1.dev1+ge3e1b6e documentation
    
+      
    SewerRat 0.0.post1.dev1+g0462be7 documentation
    
     
    
     
    
       
    
@@ -190,7 +190,7 @@
       
    
   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -347,7 +347,7 @@ 
    Indices and tables
+
    
     
     
     
diff --git a/license.html b/license.html
index 4106ff3..67435a3 100644
--- a/license.html
+++ b/license.html
@@ -6,7 +6,7 @@
 
 
     
-        License - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        License - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -166,7 +166,7 @@
       
     
    
     
    
-      
    SewerRat 0.0.post1.dev1+ge3e1b6e documentation
    
+      
    SewerRat 0.0.post1.dev1+g0462be7 documentation
    
     
    
     
    
       
    
@@ -190,7 +190,7 @@
       
    
   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -324,7 +324,7 @@ 
    License
    
-
    
+
    
     
     
     
diff --git a/objects.inv b/objects.inv
index 7f0f0c6..0722a0c 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/py-modindex.html b/py-modindex.html
index b7a83fb..cf10384 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -4,7 +4,7 @@
     
     
 
-    Python Module Index - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+    Python Module Index - SewerRat 0.0.post1.dev1+g0462be7 documentation
 
     
     
@@ -164,7 +164,7 @@
       
     
    
     
    
-      
    SewerRat 0.0.post1.dev1+ge3e1b6e documentation
    
+      
    SewerRat 0.0.post1.dev1+g0462be7 documentation
    
     
    
     
    
       
    
@@ -188,7 +188,7 @@
       
    
   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -340,7 +340,7 @@ 
    Python Module Index
    
       
     
   
    
-
    
+
    
     
     
     
diff --git a/readme.html b/readme.html
index d8af5d5..020bbef 100644
--- a/readme.html
+++ b/readme.html
@@ -6,7 +6,7 @@
 
 
     
-        Python interface to the SewerRat API - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+        Python interface to the SewerRat API - SewerRat 0.0.post1.dev1+g0462be7 documentation
       
     
     
@@ -166,7 +166,7 @@
       
     
    
     
    
-      
    SewerRat 0.0.post1.dev1+ge3e1b6e documentation
    
+      
    SewerRat 0.0.post1.dev1+g0462be7 documentation
    
     
    
     
    
       
    
@@ -190,7 +190,7 @@
       
    
   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -366,7 +366,7 @@ 
    Python interface to the SewerRat API
+
    
     
     
     
diff --git a/search.html b/search.html
index 376decd..97f3a60 100644
--- a/search.html
+++ b/search.html
@@ -7,7 +7,7 @@
 
     
 
-Search - SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+Search - SewerRat 0.0.post1.dev1+g0462be7 documentation
     
     
     
@@ -166,7 +166,7 @@
       
     
    
     
    
-      
    SewerRat 0.0.post1.dev1+ge3e1b6e documentation
    
+      
    SewerRat 0.0.post1.dev1+g0462be7 documentation
    
     
    
     
    
       
    
@@ -190,7 +190,7 @@
       
    
   
   
-  SewerRat 0.0.post1.dev1+ge3e1b6e documentation
+  SewerRat 0.0.post1.dev1+g0462be7 documentation
   
 
   
@@ -285,7 +285,7 @@
       
     
   
    
-
    
+
    
     
     
     
diff --git a/searchindex.js b/searchindex.js
index 491ccb1..5218970 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"Changelog": [[3, null]], "Clone the repository": [[4, "clone-the-repository"]], "Code Contributions": [[4, "code-contributions"]], "Contents": [[5, "contents"]], "Contributing": [[4, "contributing"]], "Contributors": [[2, null]], "Create an environment": [[4, "create-an-environment"]], "Documentation Improvements": [[4, "documentation-improvements"]], "Implement your changes": [[4, "implement-your-changes"]], "Indices and tables": [[5, "indices-and-tables"]], "Issue Reports": [[4, "issue-reports"]], "License": [[6, null]], "Maintainer tasks": [[4, "maintainer-tasks"]], "Module contents": [[1, "module-sewerrat"]], "Python interface to the SewerRat API": [[7, null]], "Releases": [[4, "releases"]], "SewerRat": [[5, null]], "Submit an issue": [[4, "submit-an-issue"]], "Submit your contribution": [[4, "submit-your-contribution"]], "Submodules": [[1, "submodules"]], "Todo": [[4, null], [4, "id2"], [4, "id3"], [4, "id5"], [4, "id6"], [4, "id7"], [4, "id8"], [4, "id9"], [4, "id10"], [4, "id11"], [4, "id12"]], "Troubleshooting": [[4, "troubleshooting"]], "Version 0.1.0": [[3, "version-0-1-0"]], "Version 0.2.0": [[3, "version-0-2-0"]], "Version 0.2.1": [[3, "version-0-2-1"]], "sewerrat": [[0, null]], "sewerrat package": [[1, null]], "sewerrat.deregister module": [[1, "module-sewerrat.deregister"]], "sewerrat.list_files module": [[1, "module-sewerrat.list_files"]], "sewerrat.query module": [[1, "module-sewerrat.query"]], "sewerrat.register module": [[1, "module-sewerrat.register"]], "sewerrat.retrieve_directory module": [[1, "module-sewerrat.retrieve_directory"]], "sewerrat.retrieve_file module": [[1, "module-sewerrat.retrieve_file"]], "sewerrat.retrieve_metadata module": [[1, "module-sewerrat.retrieve_metadata"]], "sewerrat.start_sewerrat module": [[1, "module-sewerrat.start_sewerrat"]]}, "docnames": ["api/modules", "api/sewerrat", "authors", "changelog", "contributing", "index", "license", "readme"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api/modules.rst", "api/sewerrat.rst", "authors.md", "changelog.md", "contributing.md", "index.md", "license.md", "readme.md"], "indexentries": {"deregister() (in module sewerrat.deregister)": [[1, "sewerrat.deregister.deregister", false]], "list_files() (in module sewerrat.list_files)": [[1, "sewerrat.list_files.list_files", false]], "module": [[1, "module-sewerrat", false], [1, "module-sewerrat.deregister", false], [1, "module-sewerrat.list_files", false], [1, "module-sewerrat.query", false], [1, "module-sewerrat.register", false], [1, "module-sewerrat.retrieve_directory", false], [1, "module-sewerrat.retrieve_file", false], [1, "module-sewerrat.retrieve_metadata", false], [1, "module-sewerrat.start_sewerrat", false]], "query() (in module sewerrat.query)": [[1, "sewerrat.query.query", false]], "register() (in module sewerrat.register)": [[1, "sewerrat.register.register", false]], "retrieve_directory() (in module sewerrat.retrieve_directory)": [[1, "sewerrat.retrieve_directory.retrieve_directory", false]], "retrieve_file() (in module sewerrat.retrieve_file)": [[1, "sewerrat.retrieve_file.retrieve_file", false]], "retrieve_metadata() (in module sewerrat.retrieve_metadata)": [[1, "sewerrat.retrieve_metadata.retrieve_metadata", false]], "sewerrat": [[1, "module-sewerrat", false]], "sewerrat.deregister": [[1, "module-sewerrat.deregister", false]], "sewerrat.list_files": [[1, "module-sewerrat.list_files", false]], "sewerrat.query": [[1, "module-sewerrat.query", false]], "sewerrat.register": [[1, "module-sewerrat.register", false]], "sewerrat.retrieve_directory": [[1, "module-sewerrat.retrieve_directory", false]], "sewerrat.retrieve_file": [[1, "module-sewerrat.retrieve_file", false]], "sewerrat.retrieve_metadata": [[1, "module-sewerrat.retrieve_metadata", false]], "sewerrat.start_sewerrat": [[1, "module-sewerrat.start_sewerrat", false]], "start_sewerrat() (in module sewerrat.start_sewerrat)": [[1, "sewerrat.start_sewerrat.start_sewerrat", false]], "stop_sewerrat() (in module sewerrat.start_sewerrat)": [[1, "sewerrat.start_sewerrat.stop_sewerrat", false]]}, "objects": {"": [[1, 0, 0, "-", "sewerrat"]], "sewerrat": [[1, 0, 0, "-", "deregister"], [1, 0, 0, "-", "list_files"], [1, 0, 0, "-", "query"], [1, 0, 0, "-", "register"], [1, 0, 0, "-", "retrieve_directory"], [1, 0, 0, "-", "retrieve_file"], [1, 0, 0, "-", "retrieve_metadata"], [1, 0, 0, "-", "start_sewerrat"]], "sewerrat.deregister": [[1, 1, 1, "", "deregister"]], "sewerrat.list_files": [[1, 1, 1, "", "list_files"]], "sewerrat.query": [[1, 1, 1, "", "query"]], "sewerrat.register": [[1, 1, 1, "", "register"]], "sewerrat.retrieve_directory": [[1, 1, 1, "", "retrieve_directory"]], "sewerrat.retrieve_file": [[1, 1, 1, "", "retrieve_file"]], "sewerrat.retrieve_metadata": [[1, 1, 1, "", "retrieve_metadata"]], "sewerrat.start_sewerrat": [[1, 1, 1, "", "start_sewerrat"], [1, 1, 1, "", "stop_sewerrat"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"": [1, 4, 7], "0": [1, 4, 5], "1": [1, 4, 5, 7], "100": 1, "2": [4, 5], "2024": 6, "3": [1, 4], "3600": 7, "500kb": 4, "6": 1, "7": 4, "8000": 4, "A": [1, 6], "AND": [6, 7], "AS": 6, "BE": [4, 6], "BUT": 6, "By": 4, "FOR": 6, "For": [4, 7], "IN": 6, "IT": 4, "If": [1, 4], "In": 4, "It": [1, 7], "NO": 6, "NOT": 6, "OF": [4, 6], "OR": [4, 6], "THE": [4, 6], "TO": [4, 6], "The": [4, 6], "These": 7, "To": 7, "WITH": 6, "_": 7, "_build": 4, "abbrev": 4, "abl": 4, "about": 4, "abov": 6, "absolut": 1, "access": [1, 7], "accident": 4, "accord": 4, "accordingli": [4, 7], "account": 4, "action": 6, "activ": 4, "ad": [3, 4], "add": [4, 7], "addit": 4, "after": [1, 4, 7], "ago": 7, "all": [1, 4, 6], "alreadi": [1, 4], "also": [4, 7], "altern": 1, "an": [1, 6], "anaconda": 7, "ani": [1, 4, 6], "anoth": 1, "anyth": 4, "api": [1, 4, 5], "appli": [1, 4], "appreci": 4, "appropri": 1, "ar": [4, 7], "architectur": 4, "aris": 6, "associ": 6, "assum": [1, 4, 7], "assumpt": 4, "author": [4, 5, 6], "autom": 4, "automat": [1, 4], "av": 4, "avail": [1, 4], "avoid": [3, 4], "b": 4, "backend": [1, 3], "badg": 7, "bar": 7, "barramundi": 7, "base": [1, 4], "been": 4, "befor": [1, 4], "behavior": 4, "behind": 4, "being": 4, "best": 4, "big": 4, "bin": 4, "binari": [1, 4], "bitbucket": 4, "black": 4, "bool": 1, "boolean": 7, "bottom": 4, "branch": [4, 7], "break": 4, "breakpoint": 4, "browser": 4, "bug": 4, "bugfix": 4, "build": 4, "built": [4, 7], "button": 4, "c": 6, "cach": 1, "call": 1, "caller": 1, "can": [4, 7], "cannot": 1, "case": [4, 7], "caus": 4, "cd": 4, "cfg": 4, "changelog": 5, "charg": 6, "check": [4, 7], "checkout": 4, "chosen": 1, "ci": [4, 7], "cirru": 7, "claim": 6, "class": 4, "clean": [3, 4], "click": 4, "client": [5, 7], "close": 4, "cluster": 7, "clutter": 4, "code": 5, "coher": 4, "collabor": 4, "collect": 4, "com": [2, 4, 7], "come": 4, "command": 4, "commit": 4, "commonmark": 4, "commun": 4, "compani": 4, "compat": 4, "compil": 4, "complet": 4, "compon": [1, 7], "comput": 7, "concept": [4, 7], "concurr": 1, "conda": [4, 7], "condit": 6, "conduct": 4, "configur": [1, 4], "confus": 4, "connect": 6, "consid": 4, "consider": 4, "contain": 1, "content": [0, 3, 4], "continu": 4, "contract": 6, "contribut": 5, "contributor": 4, "copi": [1, 4, 6], "copyright": 6, "correct": 4, "correctli": 4, "correspond": 1, "cov": 4, "coveral": 7, "creat": [1, 7], "creation": [1, 7], "current": 4, "damag": 6, "databas": 1, "db": 1, "de": 3, "deal": 6, "decid": 4, "decor": 4, "dedic": 4, "definit": 4, "demonstr": 7, "depend": 4, "deprec": [1, 3], "deregist": [0, 7], "describ": [1, 4], "descript": 4, "design": 4, "detail": [1, 4, 7], "develop": 4, "dict": 1, "dictionari": 1, "diet": 7, "differ": 4, "directori": [1, 3, 4, 7], "dirti": 4, "discuss": 4, "disk": 4, "dist": 4, "distribut": [4, 6], "do": [4, 6], "doc": 4, "docstr": 4, "document": [5, 6, 7], "doe": [1, 7], "don": 4, "done": [4, 7], "doubt": 4, "download": [1, 7], "draft": 4, "drop": 4, "due": 1, "e": [1, 4], "each": [1, 7], "easi": 4, "easili": [4, 7], "edit": 4, "editor": 4, "egg": 4, "either": [1, 4], "en": 7, "entir": 7, "entri": 1, "error": [1, 4], "especi": 4, "etc": 1, "even": [1, 4], "event": 6, "eventu": 4, "everyth": 4, "exampl": [4, 7], "excel": 4, "exist": 1, "expect": 4, "experi": 4, "explan": [4, 7], "express": 6, "extens": 4, "extra": 4, "face": 4, "factor": 4, "fall": 4, "fals": 1, "familiar": 4, "featur": 4, "feedback": 4, "feel": 4, "fetch": 4, "few": 4, "field": 7, "file": [1, 3, 4, 6, 7], "filesystem": [1, 7], "filter": 1, "find": [4, 7], "fine": 4, "finish": 4, "fire": 4, "first": [4, 7], "fish": 7, "fit": 6, "fix": 4, "flag": 4, "flake8": 4, "float": 1, "focu": 4, "focus": 4, "folder": 4, "follow": [1, 4, 6], "foo": 7, "forc": 1, "force_remot": 1, "forg": 7, "forget": 4, "fork": 4, "form": 4, "format": 1, "foundat": 4, "free": [1, 4, 6, 7], "freecodecamp": 4, "freshli": 4, "from": [1, 4, 6, 7], "function": [1, 3, 4, 7], "furnish": 6, "g": [1, 4], "gener": [1, 4], "gerrit": 4, "get": 4, "git": 4, "github": [4, 7], "gitlab": 4, "gmail": 2, "go": 4, "gobbler": 1, "good": 4, "grant": 6, "graph": 4, "group": 4, "guid": 4, "guidelin": 4, "ha": [1, 7], "handi": 4, "handl": 7, "hash": 4, "have": 4, "help": [4, 5], "helper": 3, "here": 1, "herebi": 6, "high": 7, "highli": 4, "histori": 4, "hold": 4, "holder": 6, "hook": 4, "host": 4, "hour": 7, "html": 4, "http": [4, 7], "i": [1, 3, 4, 6, 7], "icon": 4, "idea": 4, "ident": 1, "identifi": 4, "ignor": 1, "illustr": 4, "img": 7, "impli": 6, "import": [4, 7], "improv": 5, "includ": [4, 6], "incorrect": 1, "index": [1, 4, 5, 7], "indic": 1, "infinit": 2, "info": 4, "inform": 4, "initi": 1, "inner": 1, "insid": 1, "instal": 4, "instanc": [1, 7], "instead": 4, "institut": 7, "instruct": 4, "insuffici": 1, "int": 1, "integ": 1, "integr": 4, "interact": 4, "interest": [4, 7], "interfac": 4, "intern": 4, "io": 7, "isol": 4, "issu": 5, "item": 4, "its": [1, 4, 7], "itself": 7, "join": 7, "json": [1, 7], "just": 4, "k": 4, "kept": 4, "keyboard": 2, "kind": [4, 6], "label": [4, 7], "languag": 4, "last": 7, "latest": 7, "least": 4, "less": 7, "let": 7, "liabil": 6, "liabl": 6, "licens": 5, "like": 4, "limit": 6, "link": 4, "list": [1, 3, 4], "list_fil": [0, 7], "littl": 4, "load": 1, "local": [1, 4], "localhost": 4, "locat": 1, "log": 4, "look": 4, "loop": 3, "lot": 4, "ltla": [2, 6, 7], "m": 4, "machin": 4, "made": 4, "mai": [1, 4], "main": [4, 7], "maintain": 5, "major": 4, "make": 4, "manual": [3, 4], "mark": 4, "markup": 4, "match": 7, "maximum": 1, "mean": 4, "mechan": 4, "mention": 4, "merchant": 6, "merg": [4, 6], "messag": 4, "metadata": [1, 3, 7], "method": 4, "might": [4, 7], "mind": 4, "miniconda": 4, "minim": 4, "miss": 4, "mistak": 4, "mit": 6, "mkdir": 7, "mkdtemp": 7, "mock": 7, "model": 4, "modif": 1, "modifi": [1, 4, 6], "modul": [0, 4, 5], "monkei": 2, "month": 7, "monthli": 7, "more": [4, 7], "moreov": 4, "most": 1, "motiv": 4, "much": 7, "my": 4, "mydir": 7, "myself": 7, "myst": 4, "n": 4, "name": [1, 4, 7], "navig": 4, "need": 4, "network": 3, "never": 4, "new": [1, 3, 4], "newer": 1, "non": 4, "none": 1, "noninfring": 6, "normal": 4, "normpath": 3, "notic": [4, 6], "now": 3, "number": 1, "o": 7, "object": 1, "obtain": [1, 6], "occur": 4, "often": 4, "old": [1, 4], "older": 1, "onc": [4, 7], "one": [1, 4], "onelin": 4, "onli": [1, 7], "op": 1, "open": [4, 7], "oper": [4, 7], "option": [1, 4], "order": 4, "org": [4, 7], "origin": 4, "other": [4, 6, 7], "otherwis": [1, 6], "out": [4, 6, 7], "overview": 5, "overwrit": 1, "own": 1, "owner": 1, "packag": [0, 3, 4, 5], "page": [4, 5], "paragraph": 4, "paramet": 1, "part": 4, "partial": 7, "particular": 6, "pass": 4, "path": [1, 3, 4, 7], "pattern": 4, "pdb": 4, "pencil": 4, "pepi": 7, "perfectli": 4, "perform": 7, "permiss": [1, 4, 6], "permit": 6, "person": 6, "pip": 4, "pipx": 4, "pleas": [4, 7], "poll": 3, "port": 1, "portion": 6, "potenti": 4, "pr": 4, "pre": 4, "present": 1, "pretti": [4, 7], "preview": 4, "previous": 4, "principl": 4, "print": 1, "privat": 4, "problem": 4, "process": 4, "program": 4, "project": [4, 7], "promot": 4, "propos": 4, "proprietari": 4, "provid": [4, 6, 7], "public": 4, "publicli": 4, "publish": [4, 6], "pull": 4, "purpos": 6, "push": 4, "pypi": 4, "pyscaffold": 4, "pytest": 4, "python": [4, 5], "python3": 4, "queri": [0, 7], "quick": 4, "quickli": 4, "quit": 4, "r": [4, 7], "re": [1, 4], "readabl": [1, 4], "readi": 4, "readm": 7, "readthedoc": 7, "reason": 4, "recent": 1, "recommend": 4, "record": 4, "recreat": 4, "recur": 4, "refer": [4, 5], "regist": [0, 7], "registr": 3, "rel": 1, "releas": 3, "reliabl": 4, "remot": [1, 4, 7], "remov": [1, 4], "repl": 4, "replac": 4, "report": 5, "repositori": 7, "repres": 1, "reproduc": 4, "reproduct": 4, "request": 4, "requir": [1, 4, 7], "resolut": 3, "resourc": 4, "respect": 4, "respons": 3, "rest": 1, "restrict": 6, "restructuredtext": 4, "result": 1, "retain": 1, "retri": [1, 3], "retriev": [1, 3, 7], "retrieve_directori": [0, 7], "retrieve_fil": [0, 7], "retrieve_metadata": [0, 7], "return": [1, 4], "review": 4, "rf": 4, "right": 6, "rm": 4, "root": 4, "rst": 4, "run": [1, 4], "sai": 7, "same": [1, 4, 7], "scientif": 7, "script": 4, "search": [1, 4, 5, 7], "second": 1, "section": 4, "see": 4, "sell": 6, "send": 4, "server": 4, "servic": [1, 4], "session": 4, "setup": 4, "setuptool": 4, "sever": 4, "sewerrat": 4, "shall": 6, "share": [3, 7], "shield": 7, "should": 4, "similar": 4, "similarli": 7, "simplifi": 4, "singl": 1, "six": 4, "size": 4, "slow": 3, "so": 6, "social": 7, "softwar": [4, 6], "solut": 4, "solv": 4, "sometim": 4, "sort": 4, "sourc": [1, 4], "specif": 4, "specifi": 1, "sphinx": 4, "spin": 7, "sqlite": 1, "sr": 7, "src": 4, "stabl": 7, "start": [1, 4], "start_sewerrat": [0, 7], "statu": 7, "step": 4, "still": 4, "stop": 1, "stop_sewerrat": [0, 1], "str": 1, "string": 1, "style": [4, 7], "subdirectori": 1, "subject": [4, 6], "sublicens": 6, "submodul": 0, "substanti": 6, "success": 4, "summari": 4, "suppos": 4, "sure": 4, "svg": 7, "symlink": 3, "syntax": 1, "system": 4, "t": 4, "tag": 4, "task": 5, "tech": 7, "tempfil": 7, "templat": 4, "term": 4, "terminologi": 4, "test": [1, 4], "text": [1, 4, 7], "than": [1, 7], "thei": 4, "them": [1, 4], "thereof": 1, "thi": [1, 3, 4, 6, 7], "thing": 4, "though": 4, "throw": 1, "time": [1, 7], "tin": 7, "tip": 4, "too": 4, "top": 4, "tort": 6, "tox": 4, "tracker": 4, "tricki": 4, "trivial": 4, "troubl": 4, "true": 4, "try": 4, "tupl": 1, "twitter": 7, "txt": 4, "type": 1, "typic": [1, 7], "u": 4, "uncom": 4, "under": 4, "underli": 7, "union": 1, "unit": 4, "unix": 1, "unnecessari": 4, "unwant": 4, "up": [4, 7], "updat": [4, 7], "upload": 4, "upon": 4, "upstream": 4, "url": [1, 4, 7], "us": [1, 4, 6, 7], "user": [1, 4, 7], "v1": 4, "valid": 4, "venv": 4, "veri": 4, "version": [1, 4, 5, 7], "via": [1, 3, 4, 7], "virtual": 4, "virtualenv": 4, "vn": 7, "w": 7, "wa": [1, 4], "wai": 4, "wait": 1, "want": [4, 7], "warn": 1, "warranti": 6, "we": [4, 7], "web": 4, "weird": 4, "welcom": 4, "well": 4, "what": 4, "when": 4, "where": 1, "whether": [1, 6], "which": [1, 4], "while": 4, "who": 1, "whom": 6, "without": 6, "work": 4, "workflow": 4, "world": 1, "would": 4, "write": [1, 4, 7], "written": 4, "you": [4, 7], "your": 7, "yourlogin": 4, "yourself": 4}, "titles": ["sewerrat", "sewerrat package", "Contributors", "Changelog", "Contributing", "SewerRat", "License", "Python interface to the SewerRat API"], "titleterms": {"0": 3, "1": 3, "2": 3, "an": 4, "api": 7, "chang": 4, "changelog": 3, "clone": 4, "code": 4, "content": [1, 5], "contribut": 4, "contributor": 2, "creat": 4, "deregist": 1, "document": 4, "environ": 4, "implement": 4, "improv": 4, "indic": 5, "interfac": 7, "issu": 4, "licens": 6, "list_fil": 1, "maintain": 4, "modul": 1, "packag": 1, "python": 7, "queri": 1, "regist": 1, "releas": 4, "report": 4, "repositori": 4, "retrieve_directori": 1, "retrieve_fil": 1, "retrieve_metadata": 1, "sewerrat": [0, 1, 5, 7], "start_sewerrat": 1, "submit": 4, "submodul": 1, "tabl": 5, "task": 4, "todo": 4, "troubleshoot": 4, "version": 3, "your": 4}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"Changelog": [[3, null]], "Clone the repository": [[4, "clone-the-repository"]], "Code Contributions": [[4, "code-contributions"]], "Contents": [[5, "contents"]], "Contributing": [[4, "contributing"]], "Contributors": [[2, null]], "Create an environment": [[4, "create-an-environment"]], "Documentation Improvements": [[4, "documentation-improvements"]], "Implement your changes": [[4, "implement-your-changes"]], "Indices and tables": [[5, "indices-and-tables"]], "Issue Reports": [[4, "issue-reports"]], "License": [[6, null]], "Maintainer tasks": [[4, "maintainer-tasks"]], "Module contents": [[1, "module-sewerrat"]], "Python interface to the SewerRat API": [[7, null]], "Releases": [[4, "releases"]], "SewerRat": [[5, null]], "Submit an issue": [[4, "submit-an-issue"]], "Submit your contribution": [[4, "submit-your-contribution"]], "Submodules": [[1, "submodules"]], "Todo": [[4, null], [4, "id2"], [4, "id3"], [4, "id5"], [4, "id6"], [4, "id7"], [4, "id8"], [4, "id9"], [4, "id10"], [4, "id11"], [4, "id12"]], "Troubleshooting": [[4, "troubleshooting"]], "Version 0.1.0": [[3, "version-0-1-0"]], "Version 0.2.0": [[3, "version-0-2-0"]], "Version 0.2.1": [[3, "version-0-2-1"]], "sewerrat": [[0, null]], "sewerrat package": [[1, null]], "sewerrat.deregister module": [[1, "module-sewerrat.deregister"]], "sewerrat.list_files module": [[1, "module-sewerrat.list_files"]], "sewerrat.query module": [[1, "module-sewerrat.query"]], "sewerrat.register module": [[1, "module-sewerrat.register"]], "sewerrat.retrieve_directory module": [[1, "module-sewerrat.retrieve_directory"]], "sewerrat.retrieve_file module": [[1, "module-sewerrat.retrieve_file"]], "sewerrat.retrieve_metadata module": [[1, "module-sewerrat.retrieve_metadata"]], "sewerrat.start_sewerrat module": [[1, "module-sewerrat.start_sewerrat"]]}, "docnames": ["api/modules", "api/sewerrat", "authors", "changelog", "contributing", "index", "license", "readme"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api/modules.rst", "api/sewerrat.rst", "authors.md", "changelog.md", "contributing.md", "index.md", "license.md", "readme.md"], "indexentries": {"deregister() (in module sewerrat.deregister)": [[1, "sewerrat.deregister.deregister", false]], "list_files() (in module sewerrat.list_files)": [[1, "sewerrat.list_files.list_files", false]], "module": [[1, "module-sewerrat", false], [1, "module-sewerrat.deregister", false], [1, "module-sewerrat.list_files", false], [1, "module-sewerrat.query", false], [1, "module-sewerrat.register", false], [1, "module-sewerrat.retrieve_directory", false], [1, "module-sewerrat.retrieve_file", false], [1, "module-sewerrat.retrieve_metadata", false], [1, "module-sewerrat.start_sewerrat", false]], "query() (in module sewerrat.query)": [[1, "sewerrat.query.query", false]], "register() (in module sewerrat.register)": [[1, "sewerrat.register.register", false]], "retrieve_directory() (in module sewerrat.retrieve_directory)": [[1, "sewerrat.retrieve_directory.retrieve_directory", false]], "retrieve_file() (in module sewerrat.retrieve_file)": [[1, "sewerrat.retrieve_file.retrieve_file", false]], "retrieve_metadata() (in module sewerrat.retrieve_metadata)": [[1, "sewerrat.retrieve_metadata.retrieve_metadata", false]], "sewerrat": [[1, "module-sewerrat", false]], "sewerrat.deregister": [[1, "module-sewerrat.deregister", false]], "sewerrat.list_files": [[1, "module-sewerrat.list_files", false]], "sewerrat.query": [[1, "module-sewerrat.query", false]], "sewerrat.register": [[1, "module-sewerrat.register", false]], "sewerrat.retrieve_directory": [[1, "module-sewerrat.retrieve_directory", false]], "sewerrat.retrieve_file": [[1, "module-sewerrat.retrieve_file", false]], "sewerrat.retrieve_metadata": [[1, "module-sewerrat.retrieve_metadata", false]], "sewerrat.start_sewerrat": [[1, "module-sewerrat.start_sewerrat", false]], "start_sewerrat() (in module sewerrat.start_sewerrat)": [[1, "sewerrat.start_sewerrat.start_sewerrat", false]], "stop_sewerrat() (in module sewerrat.start_sewerrat)": [[1, "sewerrat.start_sewerrat.stop_sewerrat", false]]}, "objects": {"": [[1, 0, 0, "-", "sewerrat"]], "sewerrat": [[1, 0, 0, "-", "deregister"], [1, 0, 0, "-", "list_files"], [1, 0, 0, "-", "query"], [1, 0, 0, "-", "register"], [1, 0, 0, "-", "retrieve_directory"], [1, 0, 0, "-", "retrieve_file"], [1, 0, 0, "-", "retrieve_metadata"], [1, 0, 0, "-", "start_sewerrat"]], "sewerrat.deregister": [[1, 1, 1, "", "deregister"]], "sewerrat.list_files": [[1, 1, 1, "", "list_files"]], "sewerrat.query": [[1, 1, 1, "", "query"]], "sewerrat.register": [[1, 1, 1, "", "register"]], "sewerrat.retrieve_directory": [[1, 1, 1, "", "retrieve_directory"]], "sewerrat.retrieve_file": [[1, 1, 1, "", "retrieve_file"]], "sewerrat.retrieve_metadata": [[1, 1, 1, "", "retrieve_metadata"]], "sewerrat.start_sewerrat": [[1, 1, 1, "", "start_sewerrat"], [1, 1, 1, "", "stop_sewerrat"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"": [1, 4, 7], "0": [1, 4, 5], "1": [1, 4, 5, 7], "100": 1, "2": [4, 5], "2024": 6, "3": [1, 4], "3600": [1, 7], "500kb": 4, "6": 1, "7": 4, "8000": 4, "A": [1, 6], "AND": [6, 7], "AS": 6, "BE": [4, 6], "BUT": 6, "By": 4, "FOR": 6, "For": [4, 7], "IN": 6, "IT": 4, "If": [1, 4], "In": 4, "It": [1, 7], "NO": 6, "NOT": 6, "OF": [4, 6], "OR": [4, 6], "THE": [4, 6], "TO": [4, 6], "The": [4, 6], "These": 7, "To": 7, "WITH": 6, "_": 7, "_build": 4, "abbrev": 4, "abl": 4, "about": 4, "abov": 6, "absolut": 1, "access": [1, 7], "accident": 4, "accord": 4, "accordingli": [4, 7], "account": 4, "action": 6, "activ": 4, "ad": [3, 4], "add": [4, 7], "addit": 4, "after": [1, 4, 7], "ag": 1, "ago": 7, "all": [1, 4, 6], "alreadi": [1, 4], "also": [4, 7], "altern": 1, "an": [1, 6], "anaconda": 7, "ani": [1, 4, 6], "anoth": 1, "anyth": 4, "api": [1, 4, 5], "appli": [1, 4], "appreci": 4, "appropri": 1, "ar": [4, 7], "architectur": 4, "aris": 6, "associ": 6, "assum": [1, 4, 7], "assumpt": 4, "author": [4, 5, 6], "autom": 4, "automat": [1, 4], "av": 4, "avail": [1, 4], "avoid": [3, 4], "b": 4, "backend": [1, 3], "badg": 7, "bar": 7, "barramundi": 7, "base": [1, 4], "been": 4, "befor": [1, 4], "behavior": 4, "behind": 4, "being": 4, "best": 4, "big": 4, "bin": 4, "binari": [1, 4], "bitbucket": 4, "black": 4, "bool": 1, "boolean": 7, "bottom": 4, "branch": [4, 7], "break": 4, "breakpoint": 4, "browser": 4, "bug": 4, "bugfix": 4, "build": 4, "built": [4, 7], "button": 4, "c": 6, "cach": 1, "call": 1, "caller": 1, "can": [4, 7], "cannot": 1, "case": [4, 7], "caus": 4, "cd": 4, "cfg": 4, "changelog": 5, "charg": 6, "check": [1, 4, 7], "checkout": 4, "chosen": 1, "ci": [4, 7], "cirru": 7, "claim": 6, "class": 4, "clean": [3, 4], "click": 4, "client": [5, 7], "close": 4, "cluster": 7, "clutter": 4, "code": 5, "coher": 4, "collabor": 4, "collect": 4, "com": [2, 4, 7], "come": 4, "command": 4, "commit": 4, "commonmark": 4, "commun": 4, "compani": 4, "compat": 4, "compil": 4, "complet": 4, "compon": [1, 7], "comput": 7, "concept": [4, 7], "concurr": 1, "conda": [4, 7], "condit": 6, "conduct": 4, "configur": [1, 4], "confus": 4, "connect": 6, "consid": 4, "consider": 4, "contain": 1, "content": [0, 3, 4], "continu": 4, "contract": 6, "contribut": 5, "contributor": 4, "copi": [1, 4, 6], "copyright": 6, "correct": 4, "correctli": 4, "correspond": 1, "cov": 4, "coveral": 7, "creat": [1, 7], "creation": [1, 7], "current": 4, "damag": 6, "databas": 1, "db": 1, "de": 3, "deal": 6, "decid": 4, "decor": 4, "dedic": 4, "definit": 4, "demonstr": 7, "depend": 4, "deprec": [1, 3], "deregist": [0, 7], "describ": [1, 4], "descript": 4, "design": 4, "detail": [1, 4, 7], "develop": 4, "dict": 1, "dictionari": 1, "diet": 7, "differ": 4, "directori": [1, 3, 4, 7], "dirti": 4, "discuss": 4, "disk": 4, "dist": 4, "distribut": [4, 6], "do": [4, 6], "doc": 4, "docstr": 4, "document": [5, 6, 7], "doe": [1, 7], "don": 4, "done": [4, 7], "doubt": 4, "download": [1, 7], "draft": 4, "drop": 4, "due": 1, "e": [1, 4], "each": [1, 7], "easi": 4, "easili": [4, 7], "edit": 4, "editor": 4, "egg": 4, "either": [1, 4], "en": 7, "entir": 7, "entri": 1, "error": [1, 4], "especi": 4, "etc": 1, "even": [1, 4], "event": 6, "eventu": 4, "everyth": 4, "exampl": [4, 7], "excel": 4, "exist": 1, "expect": 4, "experi": 4, "explan": [4, 7], "express": 6, "extens": 4, "extra": 4, "face": 4, "factor": 4, "fall": 4, "fals": 1, "familiar": 4, "featur": 4, "feedback": 4, "feel": 4, "fetch": 4, "few": 4, "field": 7, "file": [1, 3, 4, 6, 7], "filesystem": [1, 7], "filter": 1, "find": [4, 7], "fine": 4, "finish": 4, "fire": 4, "first": [4, 7], "fish": 7, "fit": 6, "fix": 4, "flag": 4, "flake8": 4, "float": 1, "focu": 4, "focus": 4, "folder": 4, "follow": [1, 4, 6], "foo": 7, "forc": 1, "force_remot": 1, "forg": 7, "forget": 4, "fork": 4, "form": 4, "format": 1, "foundat": 4, "free": [1, 4, 6, 7], "freecodecamp": 4, "freshli": 4, "from": [1, 4, 6, 7], "function": [1, 3, 4, 7], "furnish": 6, "g": [1, 4], "gener": [1, 4], "gerrit": 4, "get": 4, "git": 4, "github": [4, 7], "gitlab": 4, "gmail": 2, "go": 4, "gobbler": 1, "good": 4, "grant": 6, "graph": 4, "group": 4, "guid": 4, "guidelin": 4, "ha": [1, 7], "handi": 4, "handl": 7, "hash": 4, "have": 4, "help": [4, 5], "helper": 3, "here": 1, "herebi": 6, "high": 7, "highli": 4, "histori": 4, "hold": 4, "holder": 6, "hook": 4, "host": 4, "hour": 7, "html": 4, "http": [4, 7], "i": [1, 3, 4, 6, 7], "icon": 4, "idea": 4, "ident": 1, "identifi": 4, "ignor": 1, "illustr": 4, "img": 7, "impli": 6, "import": [4, 7], "improv": 5, "includ": [4, 6], "incorrect": 1, "index": [1, 4, 5, 7], "indic": 1, "infinit": 2, "info": 4, "inform": 4, "initi": 1, "inner": 1, "insid": 1, "instal": 4, "instanc": [1, 7], "instead": 4, "institut": 7, "instruct": 4, "insuffici": 1, "int": 1, "integ": 1, "integr": 4, "interact": 4, "interest": [4, 7], "interfac": 4, "intern": 4, "io": 7, "isol": 4, "issu": 5, "item": 4, "its": [1, 4, 7], "itself": 7, "join": 7, "json": [1, 7], "just": 4, "k": 4, "kept": 4, "keyboard": 2, "kind": [4, 6], "label": [4, 7], "languag": 4, "last": 7, "latest": 7, "least": 4, "less": 7, "let": 7, "liabil": 6, "liabl": 6, "licens": 5, "like": 4, "limit": 6, "link": 4, "list": [1, 3, 4], "list_fil": [0, 7], "littl": 4, "load": 1, "local": [1, 4], "localhost": 4, "locat": 1, "log": 4, "look": 4, "loop": 3, "lot": 4, "ltla": [2, 6, 7], "m": 4, "machin": 4, "made": 4, "mai": [1, 4], "main": [4, 7], "maintain": 5, "major": 4, "make": 4, "manual": [3, 4], "mark": 4, "markup": 4, "match": 7, "maximum": 1, "mean": 4, "mechan": 4, "mention": 4, "merchant": 6, "merg": [4, 6], "messag": 4, "metadata": [1, 3, 7], "method": 4, "might": [4, 7], "mind": 4, "miniconda": 4, "minim": 4, "miss": 4, "mistak": 4, "mit": 6, "mkdir": 7, "mkdtemp": 7, "mock": 7, "model": 4, "modif": 1, "modifi": [1, 4, 6], "modul": [0, 4, 5], "monkei": 2, "month": 7, "monthli": 7, "more": [4, 7], "moreov": 4, "most": 1, "motiv": 4, "much": 7, "my": 4, "mydir": 7, "myself": 7, "myst": 4, "n": 4, "name": [1, 4, 7], "navig": 4, "need": 4, "network": 3, "never": 4, "new": [1, 3, 4], "newer": 1, "non": 4, "none": 1, "noninfring": 6, "normal": 4, "normpath": 3, "notic": [4, 6], "now": 3, "number": 1, "o": 7, "object": 1, "obtain": [1, 6], "occur": 4, "often": 4, "old": [1, 4], "older": 1, "onc": [4, 7], "one": [1, 4], "onelin": 4, "onli": [1, 7], "op": 1, "open": [4, 7], "oper": [4, 7], "option": [1, 4], "order": 4, "org": [4, 7], "origin": 4, "other": [4, 6, 7], "otherwis": [1, 6], "out": [4, 6, 7], "overview": 5, "overwrit": 1, "own": 1, "owner": 1, "packag": [0, 3, 4, 5], "page": [4, 5], "paragraph": 4, "paramet": 1, "part": 4, "partial": 7, "particular": 6, "pass": 4, "path": [1, 3, 4, 7], "pattern": 4, "pdb": 4, "pencil": 4, "pepi": 7, "perfectli": 4, "perform": 7, "permiss": [1, 4, 6], "permit": 6, "person": 6, "pip": 4, "pipx": 4, "pleas": [4, 7], "poll": 3, "port": 1, "portion": 6, "potenti": 4, "pr": 4, "pre": 4, "present": 1, "pretti": [4, 7], "preview": 4, "previous": 4, "principl": 4, "print": 1, "privat": 4, "problem": 4, "process": 4, "program": 4, "project": [4, 7], "promot": 4, "propos": 4, "proprietari": 4, "provid": [4, 6, 7], "public": 4, "publicli": 4, "publish": [4, 6], "pull": 4, "purpos": 6, "push": 4, "pypi": 4, "pyscaffold": 4, "pytest": 4, "python": [4, 5], "python3": 4, "queri": [0, 7], "quick": 4, "quickli": 4, "quit": 4, "r": [4, 7], "re": [1, 4], "readabl": [1, 4], "readi": 4, "readm": 7, "readthedoc": 7, "reason": 4, "recent": 1, "recommend": 4, "record": 4, "recreat": 4, "recur": 4, "refer": [4, 5], "regist": [0, 7], "registr": 3, "rel": 1, "releas": 3, "reliabl": 4, "remot": [1, 4, 7], "remov": [1, 4], "repl": 4, "replac": 4, "report": 5, "repositori": 7, "repres": 1, "reproduc": 4, "reproduct": 4, "request": 4, "requir": [1, 4, 7], "resolut": 3, "resourc": 4, "respect": 4, "respons": 3, "rest": 1, "restrict": 6, "restructuredtext": 4, "result": 1, "retain": 1, "retri": [1, 3], "retriev": [1, 3, 7], "retrieve_directori": [0, 7], "retrieve_fil": [0, 7], "retrieve_metadata": [0, 7], "return": [1, 4], "review": 4, "rf": 4, "right": 6, "rm": 4, "root": 4, "rst": 4, "run": [1, 4], "sai": 7, "same": [1, 4, 7], "scientif": 7, "script": 4, "search": [1, 4, 5, 7], "second": 1, "section": 4, "see": 4, "sell": 6, "send": 4, "server": 4, "servic": [1, 4], "session": 4, "setup": 4, "setuptool": 4, "sever": 4, "sewerrat": 4, "shall": 6, "share": [3, 7], "shield": 7, "should": 4, "similar": 4, "similarli": 7, "simplifi": 4, "singl": 1, "six": 4, "size": 4, "slow": 3, "so": 6, "social": 7, "softwar": [4, 6], "solut": 4, "solv": 4, "sometim": 4, "sort": 4, "sourc": [1, 4], "specif": 4, "specifi": 1, "sphinx": 4, "spin": 7, "sqlite": 1, "sr": 7, "src": 4, "stabl": 7, "start": [1, 4], "start_sewerrat": [0, 7], "statu": 7, "step": 4, "still": 4, "stop": 1, "stop_sewerrat": [0, 1], "str": 1, "string": 1, "style": [4, 7], "subdirectori": 1, "subject": [4, 6], "sublicens": 6, "submodul": 0, "substanti": 6, "success": 4, "summari": 4, "suppos": 4, "sure": 4, "svg": 7, "symlink": 3, "syntax": 1, "system": 4, "t": 4, "tag": 4, "task": 5, "tech": 7, "tempfil": 7, "templat": 4, "term": 4, "terminologi": 4, "test": [1, 4], "text": [1, 4, 7], "than": [1, 7], "thei": 4, "them": [1, 4], "thereof": 1, "thi": [1, 3, 4, 6, 7], "thing": 4, "though": 4, "throw": 1, "time": [1, 7], "tin": 7, "tip": 4, "too": 4, "top": 4, "tort": 6, "tox": 4, "tracker": 4, "tricki": 4, "trivial": 4, "troubl": 4, "true": 4, "try": 4, "tupl": 1, "twitter": 7, "txt": 4, "type": 1, "typic": [1, 7], "u": 4, "uncom": 4, "under": 4, "underli": 7, "union": 1, "unit": 4, "unix": 1, "unnecessari": 4, "unwant": 4, "up": [4, 7], "updat": [1, 4, 7], "update_delai": 1, "upload": 4, "upon": 4, "upstream": 4, "url": [1, 4, 7], "us": [1, 4, 6, 7], "user": [1, 4, 7], "v1": 4, "valid": 4, "venv": 4, "veri": 4, "version": [1, 4, 5, 7], "via": [1, 3, 4, 7], "virtual": 4, "virtualenv": 4, "vn": 7, "w": 7, "wa": [1, 4], "wai": 4, "wait": 1, "want": [4, 7], "warn": 1, "warranti": 6, "we": [4, 7], "web": 4, "weird": 4, "welcom": 4, "well": 4, "what": 4, "when": 4, "where": 1, "whether": [1, 6], "which": [1, 4], "while": 4, "who": 1, "whom": 6, "without": 6, "work": 4, "workflow": 4, "world": 1, "would": 4, "write": [1, 4, 7], "written": 4, "you": [4, 7], "your": 7, "yourlogin": 4, "yourself": 4}, "titles": ["sewerrat", "sewerrat package", "Contributors", "Changelog", "Contributing", "SewerRat", "License", "Python interface to the SewerRat API"], "titleterms": {"0": 3, "1": 3, "2": 3, "an": 4, "api": 7, "chang": 4, "changelog": 3, "clone": 4, "code": 4, "content": [1, 5], "contribut": 4, "contributor": 2, "creat": 4, "deregist": 1, "document": 4, "environ": 4, "implement": 4, "improv": 4, "indic": 5, "interfac": 7, "issu": 4, "licens": 6, "list_fil": 1, "maintain": 4, "modul": 1, "packag": 1, "python": 7, "queri": 1, "regist": 1, "releas": 4, "report": 4, "repositori": 4, "retrieve_directori": 1, "retrieve_fil": 1, "retrieve_metadata": 1, "sewerrat": [0, 1, 5, 7], "start_sewerrat": 1, "submit": 4, "submodul": 1, "tabl": 5, "task": 4, "todo": 4, "troubleshoot": 4, "version": 3, "your": 4}})
\ No newline at end of file