ciocore 8.0.0rc1__py2.py3-none-any.whl → 8.1.0__py2.py3-none-any.whl

ciocore/VERSION

@@ -1 +1 @@
-8.0.0-rc.1
+8.1.0

ciocore/api_client.py

@@ -3,6 +3,9 @@ The api_client module is used to make requests to the Conductor API.
 """
 
 import base64
+import collections
+import datetime
+import hashlib
 import importlib
 import json
 import jwt
@@ -14,7 +17,6 @@ import socket
 import time
 import sys
 import platform
-import hashlib
 
 from urllib import parse
 
@@ -786,3 +788,223 @@ def kill_tasks(job_id, *task_ids):
         raise Exception(msg)
     
     return json.loads(response)
+
+def _get_compute_usage(start_time, end_time):
+    """
+    Query the account usage to get the raw compute data. Private method.
+    
+    Compute includes licenses, instances and Conductor cost. Everything involved
+    with running a job.
+    
+    Please use the public method api_client.get_compute_usage() instead.
+    
+    Args:
+        start_time (datetime.datetime): The first day to include in the report. Only the date is considered and it's assumed to be in UTC.
+        end_time (datetime.datetime): The last day to include in the report. Only the date is considered and it's assumed to be in UTC.
+        
+    Returns:
+        list: A list of billing entries
+        
+    Examples:
+        >>> from ciocore import api_client
+        >>> api_client._get_compute_usage(start_time, end_time)
+            [
+                {
+                    "cores": 0.5, 
+                    "instance_cost": 0.019999999552965164, 
+                    "license_cost": 0.019999999552965164, 
+                    "minutes": 6.9700000286102295, 
+                    "self_link": 0, 
+                    "start_time": "Tue, 09 Jan 2024 18:00:00 GMT"
+                }, 
+                {
+                    "cores": 0.4, 
+                    "instance_cost": 0.019999999552965164, 
+                    "license_cost": 0.019999999552965164, 
+                    "minutes": 6.960000038146973, 
+                    "self_link": 1, 
+                    "start_time": "Tue, 09 Jan 2024 19:00:00 GMT"
+                }] 
+    """
+
+    api = ApiClient()
+
+    payload = {
+        "filter": json.dumps(
+            [{"field": "start_time", "op": ">=", "value": start_time.date().isoformat()},
+             {"field": "start_time", "op": "<", "value": end_time.date().isoformat()}]),
+        "group_by": json.dumps(["start_time"]),
+        "order_by": "start_time"
+    }
+
+    response, response_code = api.make_request(
+        uri_path="billing/get_usage", 
+        verb="GET",
+        raise_on_error=False,
+        use_api_key=True,
+        params=payload
+    )
+
+    if response_code not in [200]:
+        msg = f"Failed to query compute usage"
+        msg += "\nError %s ...\n%s" % (response_code, response)
+        raise Exception(msg)
+
+    return json.loads(response)['data']
+
+def _get_storage_usage(start_time, end_time):
+    """
+    Query the account usage to get the raw storage data. Private method.
+    
+    Please use the public method api_client.get_storage_usage() instead.
+    
+    Args:
+        start_time (datetime.datetime): The first day to include in the report. Only the date is considered and it's assumed to be in UTC.
+        end_time (datetime.datetime): The last day to include in the report. Only the date is considered and it's assumed to be in UTC.
+        
+    Returns:
+        dict: A dict of billing details related to storage
+        
+    Examples:
+        >>> from ciocore import api_client
+        >>> api_client._get_storage_usage(start_time, end_time)
+           {
+                "cost": "28.96", 
+                "cost_per_day": [
+                    4.022,
+                    4.502, 
+                    4.502, 
+                    5.102, 
+                    5.102, 
+                    5.732
+                ], 
+                "currency": "USD", 
+                "daily_price": "0.006", 
+                "end_date": "2024-01-07", 
+                "gibs_per_day": [
+                    679.714,
+                    750.34, 
+                    750.34, 
+                    850.36, 
+                    850.35, 
+                    955.32
+                ], 
+                "gibs_used": "806.07", 
+                "monthly_price": "0.18", 
+                "start_date": "2024-01-01", 
+                "storage_unit": "GiB"
+                }
+            ]
+            } 
+    """
+
+    api = ApiClient()
+    
+    # Add one day to the end time as the query is exclusive of the last day but
+    # we want consistency with _get_compute_usage()    
+    payload = {
+        "start": start_time.date().isoformat(),
+        "end": (end_time.date() + datetime.timedelta(days=1)).isoformat()
+    }
+
+    response, response_code = api.make_request(
+        uri_path="billing/get_storage_usage", 
+        verb="GET",
+        raise_on_error=False,
+        use_api_key=True,
+        params=payload
+    )
+
+    if response_code not in [200]:
+        msg = f"Failed to query storage usage"
+        msg += "\nError %s ...\n%s" % (response_code, response)
+        raise Exception(msg)
+
+    return json.loads(response)['data'][0]
+
+def get_compute_usage(start_time, end_time):
+    '''
+    Query the compute usage for an account.
+    
+    Compute includes licenses, instances and Conductor cost. Everything involved
+    with running a job.    
+    
+    Args:
+        start_time (datetime.datetime): The first day to include in the report. Only the date is considered and it's assumed to be in UTC.
+        end_time (datetime.datetime): The last day to include in the report. Only the date is considered and it's assumed to be in UTC.
+        
+    Returns:
+        dict: Each key is a date (UTC). The value is a dict with values for:
+                - cost: The total accumulated compute cost for the day
+                - corehours: The total accumulated core hours for the day
+                - walltime: The number of minutes that instances (regardless of type) were running
+        
+    Examples:
+        >>> from ciocore import api_client
+        >>> api_client.get_compute_usage(start_time, end_time)
+        {  '2024-01-09': {  'cost': 0.08,
+                            'corehours': 0.9, 
+                            'walltime': 13.93},
+            '2024-01-16': { 'cost': 0.12,
+                            'corehours': 0.9613, 
+                            'walltime': 7.21}}
+    '''
+    date_format = "%a, %d %b %Y %H:%M:%S %Z"
+    data = _get_compute_usage(start_time, end_time)
+
+    # Create a nested default dictionary with initial float values of 0.0
+    results =  collections.defaultdict(lambda: collections.defaultdict(float))
+
+    for entry in data:
+        entry_start_date = datetime.datetime.strptime(entry['start_time'], date_format).date().isoformat()
+
+        results[entry_start_date]['walltime'] += entry['minutes']
+        results[entry_start_date]['corehours'] += entry['cores']
+        results[entry_start_date]['cost'] += entry['license_cost'] + entry['instance_cost']
+
+    # Round the data to avoid FP errors
+    results[entry_start_date]['walltime'] = round(results[entry_start_date]['walltime'], 4)
+    results[entry_start_date]['corehours'] = round(results[entry_start_date]['corehours'], 4)
+    results[entry_start_date]['cost'] = round(results[entry_start_date]['cost'], 4)
+    
+    return results
+
+def get_storage_usage(start_time, end_time):
+    '''
+    Query the storage usage for an account.
+    
+    Storage is calculated twice a day (UTC) and the average is used.
+    
+    Args:
+        start_time (datetime.datetime): The first day to include in the report. Only the date is considered and it's assumed to be in UTC.
+        end_time (datetime.datetime): The last day to include in the report. Only the date is considered and it's assumed to be in UTC.
+        
+    Returns:
+        dict: Each key is a date (UTC). The value is a dict with values for:
+                - cost: The cost of accumulated storage for that one day
+                - GiB: The total amount of storage used on that day
+        
+    Examples:
+        >>> from ciocore import api_client
+        >>> api_client.get_storage_usage(start_time, end_time)
+        { '2024-01-01': {'cost': 4.022, 'GiB': 679.714},
+          '2024-01-02': {'cost': 4.502, 'GiB': 750.34},
+          '2024-01-03': {'cost': 4.502, 'GiB': 750.34}}
+    '''
+    one_day = datetime.timedelta(days=1)
+    
+    data = _get_storage_usage(start_time, end_time)
+
+    results =  {}
+
+    entry_date = datetime.date.fromisoformat(data['start_date'])
+
+    for cnt, entry in enumerate(data["cost_per_day"]):
+
+        entry_start_date = entry_date.isoformat()
+        results[entry_start_date] = {'cost': float(entry), 'GiB': float(data['gibs_per_day'][cnt])}
+        entry_date += one_day
+
+    return results
+
+

ciocore/cli.py

@@ -118,9 +118,11 @@ def _set_logging(log_level, log_to_console=True, log_dir=None, log_filename=None
         log_filename=log_filename,
         console_formatter=loggeria.FORMATTER_VERBOSE,
         disable_console_logging= not log_to_console,
-        use_system_log=False,
+        use_system_log=True,
     )
 
+    print("Logging to %s" % loggeria.LOG_PATH)
+
 def _register(client):
     api_client.ApiClient.register_client(
         client_name=client.CLIENT_NAME, client_version=VERSION
@@ -166,7 +168,7 @@ def main(ctx, version):
     default=DEFAULT_CONFIG_LOG_LEVEL,
 )
 @click.option("-ld", "--log_dir", help=LOG_DIR_HELP)
-@click.option("-lcl", "--log_to_console", is_flag=True, help=LOG_TO_CONSOLE_HELP, default=True)
+@click.option("-lcl", "--log_to_console", is_flag=True, help=LOG_TO_CONSOLE_HELP, default=False)
 @click.option(
     "-tc",
     "--thread_count",
@@ -189,15 +191,13 @@ def upload(
     Example:
     conductor upload file1 file2 file3
     """
-    logfile = log_dir and os.path.join(log_dir, "conductor_ul.log")
-    _set_logging(log_level, log_to_console=log_to_console,  log_dir=log_dir)
+
+    _set_logging(log_level, log_to_console=log_to_console,  log_dir=log_dir, log_filename="conductor_uploader.log")
 
     args_dict = {
         "database_filepath": database_filepath,
         "location": location,
         "md5_caching": md5_caching,
-        "log_level": log_level,
-        "log_dir": log_dir,
         "thread_count": thread_count,
     }
 
@@ -284,7 +284,7 @@ DEPRECATED_PATHS_HELP = "Specify a list of paths to upload."
     help=THREADS_HELP,
     default=DEFAULT_CONFIG_THREAD_COUNT,
 )
-@click.option("-lcl", "--log_to_console", is_flag=True, help=LOG_TO_CONSOLE_HELP, default=True)
+@click.option("-lcl", "--log_to_console", is_flag=True, help=LOG_TO_CONSOLE_HELP, default=False)
 @click.option("-lc", "--location", help=LOCATION_HELP)
 @click.option(
     "-p",
@@ -306,14 +306,12 @@ def uploader(
     Example:
     conductor upload file1 file2 file3
     """
-    _set_logging(log_level, log_to_console=log_to_console,  log_dir=log_dir)
+    _set_logging(log_level, log_to_console=log_to_console,  log_dir=log_dir, log_filename="conductor_uploader.log")
 
     args_dict = {
         "database_filepath": database_filepath,
         "location": location,
         "md5_caching": md5_caching,
-        "log_level": log_level,
-        "log_dir": log_dir,
         "thread_count": thread_count,
     }
 

ciocore/docsite/404.html

@@ -14,7 +14,7 @@
       
       
       <link rel="icon" href="/assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.2.0-b2">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.2.0-b2">
     
     
       

ciocore/docsite/apidoc/api_client/index.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.2.0-b2">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.2.0-b2">
     
     
       
@@ -709,6 +709,20 @@
     kill_tasks()
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#ciocore.api_client.get_compute_usage" class="md-nav__link">
+    get_compute_usage()
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#ciocore.api_client.get_storage_usage" class="md-nav__link">
+    get_storage_usage()
+  </a>
+  
 </li>
       
     </ul>
@@ -1023,6 +1037,20 @@
     kill_tasks()
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#ciocore.api_client.get_compute_usage" class="md-nav__link">
+    get_compute_usage()
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#ciocore.api_client.get_storage_usage" class="md-nav__link">
+    get_storage_usage()
+  </a>
+  
 </li>
       
     </ul>
@@ -3138,6 +3166,244 @@ prompt the user to log in. </p>
 
 
 
+  <div class="doc doc-object doc-function">
+
+
+
+<h2 id="ciocore.api_client.get_compute_usage" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">get_compute_usage</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">)</span></code>
+
+
+</h2>
+
+    <div class="doc doc-contents ">
+
+      <p>Query the compute usage for an account.</p>
+<p>Compute includes licenses, instances and Conductor cost. Everything involved
+with running a job.    </p>
+
+<p><strong>Parameters:</strong></p>
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Type</th>
+      <th>Description</th>
+      <th>Default</th>
+    </tr>
+  </thead>
+  <tbody>
+      <tr>
+        <td><code>start_time</code></td>
+        <td><code>datetime.datetime</code></td>
+        <td><p>The first day to include in the report. Only the date is considered and it's assumed to be in UTC.</p></td>
+        <td><em>required</em></td>
+      </tr>
+      <tr>
+        <td><code>end_time</code></td>
+        <td><code>datetime.datetime</code></td>
+        <td><p>The last day to include in the report. Only the date is considered and it's assumed to be in UTC.</p></td>
+        <td><em>required</em></td>
+      </tr>
+  </tbody>
+</table>
+<p><strong>Returns:</strong></p>
+<table>
+  <thead>
+    <tr>
+      <th>Type</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>dict</code></td>
+      <td><p>Each key is a date (UTC). The value is a dict with values for:
+        - cost: The total accumulated compute cost for the day
+        - corehours: The total accumulated core hours for the day
+        - walltime: The number of minutes that instances (regardless of type) were running</p></td>
+    </tr>
+  </tbody>
+</table>
+<p><strong>Examples:</strong></p>
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">api_client</span><span class="o">.</span><span class="n">get_compute_usage</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">)</span>
+<span class="p">{</span>  <span class="s1">&#39;2024-01-09&#39;</span><span class="p">:</span> <span class="p">{</span>  <span class="s1">&#39;cost&#39;</span><span class="p">:</span> <span class="mf">0.08</span><span class="p">,</span>
+                    <span class="s1">&#39;corehours&#39;</span><span class="p">:</span> <span class="mf">0.9</span><span class="p">,</span> 
+                    <span class="s1">&#39;walltime&#39;</span><span class="p">:</span> <span class="mf">13.93</span><span class="p">},</span>
+    <span class="s1">&#39;2024-01-16&#39;</span><span class="p">:</span> <span class="p">{</span> <span class="s1">&#39;cost&#39;</span><span class="p">:</span> <span class="mf">0.12</span><span class="p">,</span>
+                    <span class="s1">&#39;corehours&#39;</span><span class="p">:</span> <span class="mf">0.9613</span><span class="p">,</span> 
+                    <span class="s1">&#39;walltime&#39;</span><span class="p">:</span> <span class="mf">7.21</span><span class="p">}}</span>
+</code></pre></div>
+
+        <details class="quote">
+          <summary>Source code in <code>ciocore/api_client.py</code></summary>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">get_compute_usage</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&#39;&#39;&#39;</span>
+<span class="sd">    Query the compute usage for an account.</span>
+
+<span class="sd">    Compute includes licenses, instances and Conductor cost. Everything involved</span>
+<span class="sd">    with running a job.    </span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        start_time (datetime.datetime): The first day to include in the report. Only the date is considered and it&#39;s assumed to be in UTC.</span>
+<span class="sd">        end_time (datetime.datetime): The last day to include in the report. Only the date is considered and it&#39;s assumed to be in UTC.</span>
+
+<span class="sd">    Returns:</span>
+<span class="sd">        dict: Each key is a date (UTC). The value is a dict with values for:</span>
+<span class="sd">                - cost: The total accumulated compute cost for the day</span>
+<span class="sd">                - corehours: The total accumulated core hours for the day</span>
+<span class="sd">                - walltime: The number of minutes that instances (regardless of type) were running</span>
+
+<span class="sd">    Examples:</span>
+<span class="sd">        &gt;&gt;&gt; from ciocore import api_client</span>
+<span class="sd">        &gt;&gt;&gt; api_client.get_compute_usage(start_time, end_time)</span>
+<span class="sd">        {  &#39;2024-01-09&#39;: {  &#39;cost&#39;: 0.08,</span>
+<span class="sd">                            &#39;corehours&#39;: 0.9, </span>
+<span class="sd">                            &#39;walltime&#39;: 13.93},</span>
+<span class="sd">            &#39;2024-01-16&#39;: { &#39;cost&#39;: 0.12,</span>
+<span class="sd">                            &#39;corehours&#39;: 0.9613, </span>
+<span class="sd">                            &#39;walltime&#39;: 7.21}}</span>
+<span class="sd">    &#39;&#39;&#39;</span>
+    <span class="n">date_format</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">%a</span><span class="s2">, </span><span class="si">%d</span><span class="s2"> %b %Y %H:%M:%S %Z&quot;</span>
+    <span class="n">data</span> <span class="o">=</span> <span class="n">_get_compute_usage</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">)</span>
+
+    <span class="c1"># Create a nested default dictionary with initial float values of 0.0</span>
+    <span class="n">results</span> <span class="o">=</span>  <span class="n">collections</span><span class="o">.</span><span class="n">defaultdict</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="n">collections</span><span class="o">.</span><span class="n">defaultdict</span><span class="p">(</span><span class="nb">float</span><span class="p">))</span>
+
+    <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
+        <span class="n">entry_start_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">entry</span><span class="p">[</span><span class="s1">&#39;start_time&#39;</span><span class="p">],</span> <span class="n">date_format</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span>
+
+        <span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">][</span><span class="s1">&#39;walltime&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="n">entry</span><span class="p">[</span><span class="s1">&#39;minutes&#39;</span><span class="p">]</span>
+        <span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">][</span><span class="s1">&#39;corehours&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="n">entry</span><span class="p">[</span><span class="s1">&#39;cores&#39;</span><span class="p">]</span>
+        <span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">][</span><span class="s1">&#39;cost&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="n">entry</span><span class="p">[</span><span class="s1">&#39;license_cost&#39;</span><span class="p">]</span> <span class="o">+</span> <span class="n">entry</span><span class="p">[</span><span class="s1">&#39;instance_cost&#39;</span><span class="p">]</span>
+
+    <span class="c1"># Round the data to avoid FP errors</span>
+    <span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">][</span><span class="s1">&#39;walltime&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">][</span><span class="s1">&#39;walltime&#39;</span><span class="p">],</span> <span class="mi">4</span><span class="p">)</span>
+    <span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">][</span><span class="s1">&#39;corehours&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">][</span><span class="s1">&#39;corehours&#39;</span><span class="p">],</span> <span class="mi">4</span><span class="p">)</span>
+    <span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">][</span><span class="s1">&#39;cost&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">][</span><span class="s1">&#39;cost&#39;</span><span class="p">],</span> <span class="mi">4</span><span class="p">)</span>
+
+    <span class="k">return</span> <span class="n">results</span>
+</code></pre></div>
+        </details>
+    </div>
+
+  </div>
+
+
+
+  <div class="doc doc-object doc-function">
+
+
+
+<h2 id="ciocore.api_client.get_storage_usage" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">get_storage_usage</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">)</span></code>
+
+
+</h2>
+
+    <div class="doc doc-contents ">
+
+      <p>Query the storage usage for an account.</p>
+<p>Storage is calculated twice a day (UTC) and the average is used.</p>
+
+<p><strong>Parameters:</strong></p>
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Type</th>
+      <th>Description</th>
+      <th>Default</th>
+    </tr>
+  </thead>
+  <tbody>
+      <tr>
+        <td><code>start_time</code></td>
+        <td><code>datetime.datetime</code></td>
+        <td><p>The first day to include in the report. Only the date is considered and it's assumed to be in UTC.</p></td>
+        <td><em>required</em></td>
+      </tr>
+      <tr>
+        <td><code>end_time</code></td>
+        <td><code>datetime.datetime</code></td>
+        <td><p>The last day to include in the report. Only the date is considered and it's assumed to be in UTC.</p></td>
+        <td><em>required</em></td>
+      </tr>
+  </tbody>
+</table>
+<p><strong>Returns:</strong></p>
+<table>
+  <thead>
+    <tr>
+      <th>Type</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>dict</code></td>
+      <td><p>Each key is a date (UTC). The value is a dict with values for:
+        - cost: The cost of accumulated storage for that one day
+        - GiB: The total amount of storage used on that day</p></td>
+    </tr>
+  </tbody>
+</table>
+<p><strong>Examples:</strong></p>
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">api_client</span><span class="o">.</span><span class="n">get_storage_usage</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">)</span>
+<span class="p">{</span> <span class="s1">&#39;2024-01-01&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;cost&#39;</span><span class="p">:</span> <span class="mf">4.022</span><span class="p">,</span> <span class="s1">&#39;GiB&#39;</span><span class="p">:</span> <span class="mf">679.714</span><span class="p">},</span>
+  <span class="s1">&#39;2024-01-02&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;cost&#39;</span><span class="p">:</span> <span class="mf">4.502</span><span class="p">,</span> <span class="s1">&#39;GiB&#39;</span><span class="p">:</span> <span class="mf">750.34</span><span class="p">},</span>
+  <span class="s1">&#39;2024-01-03&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;cost&#39;</span><span class="p">:</span> <span class="mf">4.502</span><span class="p">,</span> <span class="s1">&#39;GiB&#39;</span><span class="p">:</span> <span class="mf">750.34</span><span class="p">}}</span>
+</code></pre></div>
+
+        <details class="quote">
+          <summary>Source code in <code>ciocore/api_client.py</code></summary>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">get_storage_usage</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&#39;&#39;&#39;</span>
+<span class="sd">    Query the storage usage for an account.</span>
+
+<span class="sd">    Storage is calculated twice a day (UTC) and the average is used.</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        start_time (datetime.datetime): The first day to include in the report. Only the date is considered and it&#39;s assumed to be in UTC.</span>
+<span class="sd">        end_time (datetime.datetime): The last day to include in the report. Only the date is considered and it&#39;s assumed to be in UTC.</span>
+
+<span class="sd">    Returns:</span>
+<span class="sd">        dict: Each key is a date (UTC). The value is a dict with values for:</span>
+<span class="sd">                - cost: The cost of accumulated storage for that one day</span>
+<span class="sd">                - GiB: The total amount of storage used on that day</span>
+
+<span class="sd">    Examples:</span>
+<span class="sd">        &gt;&gt;&gt; from ciocore import api_client</span>
+<span class="sd">        &gt;&gt;&gt; api_client.get_storage_usage(start_time, end_time)</span>
+<span class="sd">        { &#39;2024-01-01&#39;: {&#39;cost&#39;: 4.022, &#39;GiB&#39;: 679.714},</span>
+<span class="sd">          &#39;2024-01-02&#39;: {&#39;cost&#39;: 4.502, &#39;GiB&#39;: 750.34},</span>
+<span class="sd">          &#39;2024-01-03&#39;: {&#39;cost&#39;: 4.502, &#39;GiB&#39;: 750.34}}</span>
+<span class="sd">    &#39;&#39;&#39;</span>
+    <span class="n">one_day</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
+
+    <span class="n">data</span> <span class="o">=</span> <span class="n">_get_storage_usage</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">end_time</span><span class="p">)</span>
+
+    <span class="n">results</span> <span class="o">=</span>  <span class="p">{}</span>
+
+    <span class="n">entry_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s1">&#39;start_date&#39;</span><span class="p">])</span>
+
+    <span class="k">for</span> <span class="n">cnt</span><span class="p">,</span> <span class="n">entry</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;cost_per_day&quot;</span><span class="p">]):</span>
+
+        <span class="n">entry_start_date</span> <span class="o">=</span> <span class="n">entry_date</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span>
+        <span class="n">results</span><span class="p">[</span><span class="n">entry_start_date</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;cost&#39;</span><span class="p">:</span> <span class="nb">float</span><span class="p">(</span><span class="n">entry</span><span class="p">),</span> <span class="s1">&#39;GiB&#39;</span><span class="p">:</span> <span class="nb">float</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s1">&#39;gibs_per_day&#39;</span><span class="p">][</span><span class="n">cnt</span><span class="p">])}</span>
+        <span class="n">entry_date</span> <span class="o">+=</span> <span class="n">one_day</span>
+
+    <span class="k">return</span> <span class="n">results</span>
+</code></pre></div>
+        </details>
+    </div>
+
+  </div>
+
+
+
 
 
 

ciocore/docsite/apidoc/apidoc/index.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.2.0-b2">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.2.0-b2">
     
     
       

ciocore/docsite/apidoc/config/index.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.2.0-b2">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.2.0-b2">