ciocore 8.0.0b11__py2.py3-none-any.whl → 8.0.0b14__py2.py3-none-any.whl

ciocore/VERSION

@@ -1 +1 @@
-8.0.0-beta.11
+8.0.0-beta.14

ciocore/api_client.py

@@ -13,7 +13,8 @@ import requests
 import socket
 import time
 import sys
-
+import platform
+import hashlib
 
 from urllib import parse
 
@@ -39,11 +40,33 @@ except AttributeError:
     )
 
 
+def truncate_middle(s, max_length):
+    """
+    Truncate the string `s` to `max_length` by removing characters from the middle.
+
+    :param s: The original string to be truncated.
+    :type s: str
+    :param max_length: The maximum allowed length of the string after truncation.
+    :type max_length: int
+    :return: The truncated string.
+    :rtype: str
+    """
+
+    if len(s) <= max_length:
+        # String is already at or below the maximum length, return it as is
+        return s
+
+    # Calculate the number of characters to keep from the start and end of the string
+    num_keep_front = (max_length // 2)
+    num_keep_end = max_length - num_keep_front - 1  # -1 for the ellipsis
+    
+    # Construct the truncated string
+    return s[:num_keep_front] + '~' + s[-num_keep_end:]
+
 
 # TODO: appspot_dot_com_cert = os.path.join(common.base_dir(),'auth','appspot_dot_com_cert2') load
 # appspot.com cert into requests lib verify = appspot_dot_com_cert
 
-
 class ApiClient:
     """
     The ApiClient class is a wrapper around the requests library that handles authentication and retries.
@@ -239,96 +262,32 @@ class ApiClient:
         return response.text, response.status_code
 
     @classmethod
-    def _get_user_agent_header(cls, client_name, client_version=None):
+    def register_client(cls, client_name, client_version=None):
         """
         Generates the http User Agent header that includes helpful debug info.
-
-        The final component is the path to the python executable (MD5 hex).
-
-        Example:
-        'ciomaya/0.3.7 (ciocore 4.3.2; python 3.9.5; linux 3.10.0-1160.53.1.el7.x86_64; 0ee7123c2365d7a0d126de5a70f19727)'
-
-        :param client_name: The name of the client to be used in the header. If it's importable it
-                            will be queried for its __version__ (unless client_version is supplied)
-        :type client_name: str
-
-        :param client_version: The version to use in the header if client_name can't be queried for
-                               __version__ (or it needs to be overridden)
-        :type client_version: str [default = None]
-
-        :return: The value for the User Agent header
-        :rtype: str
         """
 
-        try:
-            client_module = importlib.import_module(client_name)
-        except ImportError:
-            logger.warning(f"Unable to import module '{client_name}'. Won't query for version details.")
+        # Use the provided client_version.
+        if not client_version:
             client_version = 'unknown'
 
-        if not client_version:
-            try:
-                client_version = client_module.__version__
-            except AttributeError:
-                try:
-                    client_version = client_module.version
-                except AttributeError:
-                    logger.warning(f"Module '{client_name}' has no __version__ or version attribute. Setting version to 'N/A' in the user agent")
-                    client_version = 'unknown'
+        python_version = platform.python_version()
+        system_info = platform.system()
+        release_info = platform.release()
         
 
+        # Get the MD5 hex digest of the path to the python executable
+        python_executable_path = truncate_middle(sys.executable.encode('utf-8'), cls.USER_AGENT_MAX_PATH_LENGTH)
+        md5_hash = hashlib.md5(python_executable_path).hexdigest()
 
-        python_path = sys.executable
-
-        # If the length of the path is longer than allowed, truncate the middle
-        if len(python_path) > cls.USER_AGENT_MAX_PATH_LENGTH:
-            first_half = int(cls.USER_AGENT_MAX_PATH_LENGTH / 2)
-            second_half = len(python_path) - int(cls.USER_AGENT_MAX_PATH_LENGTH / 2)
-
-            print(first_half, second_half)
-            python_path = "{}...{}".format(
-                python_path[0:first_half], python_path[second_half:-1]
-            )
-
-        python_path_encoded = base64.b64encode(python_path.encode("utf-8")).decode(
-            "utf-8"
+        user_agent = (
+            f"{client_name}/{client_version} "
+            f"(python {python_version}; {system_info} {release_info}; {md5_hash})"
         )
-
-        if platform.system() == "Linux":
-            platform_details = platform.release()
-
-        elif platform.system() == "Windows":
-            platform_details = platform.version()
-
-        elif platform.system() == "Darwin":
-            platform_details = platform.mac_ver()[0]
-
-        else:
-            raise ValueError("Unrecognized platform '{}'".format(platform.release()))
-
-        pid = base64.b64encode(str(os.getpid()).encode("utf-8")).decode("utf-8")
-        hostname = base64.b64encode(socket.gethostname().encode("utf-8")).decode(
-            "utf-8"
-        )
-
-        return cls.USER_AGENT_TEMPLATE.format(
-            client_name=client_name,
-            client_version=client_version,
-            ciocore_version=ciocore.version,
-            runtime="python",
-            runtime_version=platform.python_version(),
-            platform=sys.platform,
-            platform_details=platform_details,
-            pid=pid,
-            hostname=hostname,
-            python_path=python_path_encoded,
-        )
-
-    @classmethod
-    def register_client(cls, client_name, client_version=None):
-        cls.user_agent_header = cls._get_user_agent_header(client_name, client_version)
-        
+        cls.user_agent_header = user_agent
         
+        return user_agent
+    
 
 def read_conductor_credentials(use_api_key=False):
     """

ciocore/cli.py

@@ -97,14 +97,12 @@ LOG_FORMATTER = logging.Formatter(
     "%(asctime)s  %(name)s%(levelname)9s  %(threadName)s:  %(message)s"
 )
 
-
 cfg = config.get()
 DEFAULT_CONFIG_MD5_CACHING = cfg["md5_caching"]
 DEFAULT_CONFIG_THREAD_COUNT = cfg["thread_count"]
 DEFAULT_CONFIG_LOG_LEVEL = cfg["log_level"]
 DEFAULT_DOWNLOADER_PAGE_SIZE = cfg["downloader_page_size"]
 
-
 def _set_logging(log_level, log_to_console=True, log_dir=None, log_filename=None):
     level = loggeria.LEVEL_MAP.get(log_level)
     loggeria.setup_conductor_logging(
@@ -115,13 +113,11 @@ def _set_logging(log_level, log_to_console=True, log_dir=None, log_filename=None
         use_system_log=False,
     )
 
-
 def _register(client):
     api_client.ApiClient.register_client(
         client_name=client.CLIENT_NAME, client_version=VERSION
     )
 
-
 ########################### MAIN #################################
 @click.group(invoke_without_command=True)
 @click.pass_context
@@ -135,8 +131,7 @@ def main(ctx, version):
         click.echo(ctx.get_help())
         ctx.exit()
 
-
-############################# UPLOADER #############################
+############################# UPLOAD #############################
 @main.command()
 @click.option("-db", "--database_filepath", help=UPLOADER_DATABASE_FILEPATH_HELP)
 @click.option(
@@ -155,6 +150,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(
     "-tc",
     "--thread_count",
@@ -165,7 +161,7 @@ def main(ctx, version):
 @click.option("-lc", "--location", help=LOCATION_HELP)
 @click.argument("paths", nargs=-1, type=click.Path(exists=True, resolve_path=True))
 def upload(
-    database_filepath, location, md5_caching, log_level, log_dir, thread_count, paths
+    database_filepath, location, md5_caching, log_level, log_to_console, log_dir, thread_count, paths
 ):
     """Upload files to Conductor.
 
@@ -178,7 +174,7 @@ def upload(
     conductor upload file1 file2 file3
     """
     logfile = log_dir and os.path.join(log_dir, "conductor_ul.log")
-    _set_logging(log_level, logfile)
+    _set_logging(log_level, log_to_console=log_to_console,  log_dir=log_dir)
 
     args_dict = {
         "database_filepath": database_filepath,
@@ -272,6 +268,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("-lc", "--location", help=LOCATION_HELP)
 @click.option(
     "-p",
@@ -293,7 +290,7 @@ def uploader(
     Example:
     conductor upload file1 file2 file3
     """
-    _set_logging(log_level, log_to_console=log_to_console,  log_dir=log_dir, log_filename="conductor_uploader.log")
+    _set_logging(log_level, log_to_console=log_to_console,  log_dir=log_dir)
 
     args_dict = {
         "database_filepath": database_filepath,
@@ -418,7 +415,6 @@ def downloader(
     default=DEFAULT_CONFIG_THREAD_COUNT,
 )
 @click.option("-r", "--regex", help=DOWNLOAD_REGEX_HELP)
-@click.option("-ld", "--log_dir", help=LOG_DIR_HELP)
 @click.option("-lc", "--location", help=LOCATION_HELP)
 @click.argument("jobids", nargs=-1)
 def download(
@@ -428,7 +424,6 @@ def download(
     location,
     progress_interval,
     log_level,
-    log_dir,
     thread_count,
     force,
     regex,
@@ -454,9 +449,13 @@ def download(
     conductor download 1234:1-5 1235:5-10
     """
 
-    logfile = log_dir and os.path.join(log_dir, "conductor_dl.log")
-    _set_logging(log_level, logfile)
+
+    _set_logging(
+        log_level=log_level, 
+        log_to_console=True)
+    
     _register(LoggingDownloadRunner)
+    
     kwargs = {
         "destination": destination,
         "num_threads": thread_count,
@@ -473,7 +472,6 @@ def download(
     )
 
     dl.run()
- 
 
 
 ########################### SEQUENCE CHECKER #############################

ciocore/config.py

@@ -10,6 +10,7 @@ import os
 import base64
 import json
 import re
+import platform
 
 from ciocore.common import CONDUCTOR_LOGGER_NAME
 
@@ -17,6 +18,15 @@ logger = logging.getLogger(CONDUCTOR_LOGGER_NAME)
 
 # https://stackoverflow.com/a/3809435/179412
 
+
+USER_DIRS = {
+    "Linux": os.path.expanduser(os.path.join("~", ".conductor")),
+    "Darwin": os.path.expanduser(os.path.join("~",".conductor")),
+    "Windows": os.path.expanduser(os.path.join("~", "AppData", "Local", "Conductor")),
+}
+
+DEFAULT_USER_DIR = USER_DIRS.get(platform.system(), USER_DIRS["Linux"])
+
 URL_REGEX = re.compile(
     r"https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)"
 )
@@ -104,6 +114,8 @@ class Config(object):
         """
         default_downloader_page_size = 50
 
+     
+
         try:
             default_thread_count = min( os.cpu_count() - 1, 15)
         except NotImplementedError:
@@ -145,7 +157,7 @@ class Config(object):
             "auth_url": url,
             "api_url": api_url,
             "api_key": self.get_api_key_from_variable() or self.get_api_key_from_file(),
-            "user_dir": os.environ.get('CONDUCTOR_USER_DIR', os.path.expanduser(os.path.join("~", ".conductor")))
+            "user_dir": os.environ.get('CONDUCTOR_USER_DIR', DEFAULT_USER_DIR)
         }
 
     @staticmethod

ciocore/docsite/apidoc/api_client/index.html

@@ -585,11 +585,25 @@
     make_request()
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#ciocore.api_client.ApiClient.register_client" class="md-nav__link">
+    register_client()
+  </a>
+  
 </li>
         
       </ul>
     </nav>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#ciocore.api_client.truncate_middle" class="md-nav__link">
+    truncate_middle()
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -878,11 +892,25 @@
     make_request()
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#ciocore.api_client.ApiClient.register_client" class="md-nav__link">
+    register_client()
+  </a>
+  
 </li>
         
       </ul>
     </nav>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#ciocore.api_client.truncate_middle" class="md-nav__link">
+    truncate_middle()
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -1232,94 +1260,31 @@ ApiClient        </code>
         <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span>
 
     <span class="nd">@classmethod</span>
-    <span class="k">def</span> <span class="nf">_get_user_agent_header</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">client_name</span><span class="p">,</span> <span class="n">client_version</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">register_client</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">client_name</span><span class="p">,</span> <span class="n">client_version</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Generates the http User Agent header that includes helpful debug info.</span>
-
-<span class="sd">        The final component is the path to the python executable (MD5 hex).</span>
-
-<span class="sd">        Example:</span>
-<span class="sd">        &#39;ciomaya/0.3.7 (ciocore 4.3.2; python 3.9.5; linux 3.10.0-1160.53.1.el7.x86_64; 0ee7123c2365d7a0d126de5a70f19727)&#39;</span>
-
-<span class="sd">        :param client_name: The name of the client to be used in the header. If it&#39;s importable it</span>
-<span class="sd">                            will be queried for its __version__ (unless client_version is supplied)</span>
-<span class="sd">        :type client_name: str</span>
-
-<span class="sd">        :param client_version: The version to use in the header if client_name can&#39;t be queried for</span>
-<span class="sd">                               __version__ (or it needs to be overridden)</span>
-<span class="sd">        :type client_version: str [default = None]</span>
-
-<span class="sd">        :return: The value for the User Agent header</span>
-<span class="sd">        :rtype: str</span>
 <span class="sd">        &quot;&quot;&quot;</span>
 
-        <span class="k">try</span><span class="p">:</span>
-            <span class="n">client_module</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="n">client_name</span><span class="p">)</span>
-        <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
-            <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unable to import module &#39;</span><span class="si">{</span><span class="n">client_name</span><span class="si">}</span><span class="s2">&#39;. Won&#39;t query for version details.&quot;</span><span class="p">)</span>
-            <span class="n">client_version</span> <span class="o">=</span> <span class="s1">&#39;unknown&#39;</span>
-
+        <span class="c1"># Use the provided client_version.</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="n">client_version</span><span class="p">:</span>
-            <span class="k">try</span><span class="p">:</span>
-                <span class="n">client_version</span> <span class="o">=</span> <span class="n">client_module</span><span class="o">.</span><span class="n">__version__</span>
-            <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
-                <span class="k">try</span><span class="p">:</span>
-                    <span class="n">client_version</span> <span class="o">=</span> <span class="n">client_module</span><span class="o">.</span><span class="n">version</span>
-                <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
-                    <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Module &#39;</span><span class="si">{</span><span class="n">client_name</span><span class="si">}</span><span class="s2">&#39; has no __version__ or version attribute. Setting version to &#39;N/A&#39; in the user agent&quot;</span><span class="p">)</span>
-                    <span class="n">client_version</span> <span class="o">=</span> <span class="s1">&#39;unknown&#39;</span>
-
-
-
-        <span class="n">python_path</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">executable</span>
-
-        <span class="c1"># If the length of the path is longer than allowed, truncate the middle</span>
-        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">python_path</span><span class="p">)</span> <span class="o">&gt;</span> <span class="bp">cls</span><span class="o">.</span><span class="n">USER_AGENT_MAX_PATH_LENGTH</span><span class="p">:</span>
-            <span class="n">first_half</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">USER_AGENT_MAX_PATH_LENGTH</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span>
-            <span class="n">second_half</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">python_path</span><span class="p">)</span> <span class="o">-</span> <span class="nb">int</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">USER_AGENT_MAX_PATH_LENGTH</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span>
-
-            <span class="nb">print</span><span class="p">(</span><span class="n">first_half</span><span class="p">,</span> <span class="n">second_half</span><span class="p">)</span>
-            <span class="n">python_path</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2">...</span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
-                <span class="n">python_path</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="n">first_half</span><span class="p">],</span> <span class="n">python_path</span><span class="p">[</span><span class="n">second_half</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
-            <span class="p">)</span>
-
-        <span class="n">python_path_encoded</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">python_path</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span>
-            <span class="s2">&quot;utf-8&quot;</span>
-        <span class="p">)</span>
-
-        <span class="k">if</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;Linux&quot;</span><span class="p">:</span>
-            <span class="n">platform_details</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
-
-        <span class="k">elif</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;Windows&quot;</span><span class="p">:</span>
-            <span class="n">platform_details</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">version</span><span class="p">()</span>
+            <span class="n">client_version</span> <span class="o">=</span> <span class="s1">&#39;unknown&#39;</span>
 
-        <span class="k">elif</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;Darwin&quot;</span><span class="p">:</span>
-            <span class="n">platform_details</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">mac_ver</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
+        <span class="n">python_version</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">python_version</span><span class="p">()</span>
+        <span class="n">system_info</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span>
+        <span class="n">release_info</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
 
-        <span class="k">else</span><span class="p">:</span>
-            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Unrecognized platform &#39;</span><span class="si">{}</span><span class="s2">&#39;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">platform</span><span class="o">.</span><span class="n">release</span><span class="p">()))</span>
 
-        <span class="n">pid</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getpid</span><span class="p">())</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span>
-        <span class="n">hostname</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">gethostname</span><span class="p">()</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span>
-            <span class="s2">&quot;utf-8&quot;</span>
-        <span class="p">)</span>
+        <span class="c1"># Get the MD5 hex digest of the path to the python executable</span>
+        <span class="n">python_executable_path</span> <span class="o">=</span> <span class="n">truncate_middle</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">&#39;utf-8&#39;</span><span class="p">),</span> <span class="bp">cls</span><span class="o">.</span><span class="n">USER_AGENT_MAX_PATH_LENGTH</span><span class="p">)</span>
+        <span class="n">md5_hash</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">md5</span><span class="p">(</span><span class="n">python_executable_path</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
 
-        <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">USER_AGENT_TEMPLATE</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
-            <span class="n">client_name</span><span class="o">=</span><span class="n">client_name</span><span class="p">,</span>
-            <span class="n">client_version</span><span class="o">=</span><span class="n">client_version</span><span class="p">,</span>
-            <span class="n">ciocore_version</span><span class="o">=</span><span class="n">ciocore</span><span class="o">.</span><span class="n">version</span><span class="p">,</span>
-            <span class="n">runtime</span><span class="o">=</span><span class="s2">&quot;python&quot;</span><span class="p">,</span>
-            <span class="n">runtime_version</span><span class="o">=</span><span class="n">platform</span><span class="o">.</span><span class="n">python_version</span><span class="p">(),</span>
-            <span class="n">platform</span><span class="o">=</span><span class="n">sys</span><span class="o">.</span><span class="n">platform</span><span class="p">,</span>
-            <span class="n">platform_details</span><span class="o">=</span><span class="n">platform_details</span><span class="p">,</span>
-            <span class="n">pid</span><span class="o">=</span><span class="n">pid</span><span class="p">,</span>
-            <span class="n">hostname</span><span class="o">=</span><span class="n">hostname</span><span class="p">,</span>
-            <span class="n">python_path</span><span class="o">=</span><span class="n">python_path_encoded</span><span class="p">,</span>
+        <span class="n">user_agent</span> <span class="o">=</span> <span class="p">(</span>
+            <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">client_name</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">client_version</span><span class="si">}</span><span class="s2"> &quot;</span>
+            <span class="sa">f</span><span class="s2">&quot;(python </span><span class="si">{</span><span class="n">python_version</span><span class="si">}</span><span class="s2">; </span><span class="si">{</span><span class="n">system_info</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">release_info</span><span class="si">}</span><span class="s2">; </span><span class="si">{</span><span class="n">md5_hash</span><span class="si">}</span><span class="s2">)&quot;</span>
         <span class="p">)</span>
+        <span class="bp">cls</span><span class="o">.</span><span class="n">user_agent_header</span> <span class="o">=</span> <span class="n">user_agent</span>
 
-    <span class="nd">@classmethod</span>
-    <span class="k">def</span> <span class="nf">register_client</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">client_name</span><span class="p">,</span> <span class="n">client_version</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
-        <span class="bp">cls</span><span class="o">.</span><span class="n">user_agent_header</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_get_user_agent_header</span><span class="p">(</span><span class="n">client_name</span><span class="p">,</span> <span class="n">client_version</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">user_agent</span>
 </code></pre></div>
         </details>
 
@@ -1715,6 +1680,58 @@ client is built to use Requests 3.x this function can be removed.</p>
 
 
 
+  <div class="doc doc-object doc-method">
+
+
+
+<h3 id="ciocore.api_client.ApiClient.register_client" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">register_client</span><span class="p">(</span><span class="n">client_name</span><span class="p">,</span> <span class="n">client_version</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
+
+  <span class="doc doc-properties">
+      <small class="doc doc-property doc-property-classmethod"><code>classmethod</code></small>
+  </span>
+
+</h3>
+
+    <div class="doc doc-contents ">
+
+      <p>Generates the http User Agent header that includes helpful debug info.</p>
+
+        <details class="quote">
+          <summary>Source code in <code>ciocore/api_client.py</code></summary>
+          <div class="highlight"><pre><span></span><code><span class="nd">@classmethod</span>
+<span class="k">def</span> <span class="nf">register_client</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">client_name</span><span class="p">,</span> <span class="n">client_version</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Generates the http User Agent header that includes helpful debug info.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="c1"># Use the provided client_version.</span>
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">client_version</span><span class="p">:</span>
+        <span class="n">client_version</span> <span class="o">=</span> <span class="s1">&#39;unknown&#39;</span>
+
+    <span class="n">python_version</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">python_version</span><span class="p">()</span>
+    <span class="n">system_info</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span>
+    <span class="n">release_info</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
+
+
+    <span class="c1"># Get the MD5 hex digest of the path to the python executable</span>
+    <span class="n">python_executable_path</span> <span class="o">=</span> <span class="n">truncate_middle</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">&#39;utf-8&#39;</span><span class="p">),</span> <span class="bp">cls</span><span class="o">.</span><span class="n">USER_AGENT_MAX_PATH_LENGTH</span><span class="p">)</span>
+    <span class="n">md5_hash</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">md5</span><span class="p">(</span><span class="n">python_executable_path</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
+
+    <span class="n">user_agent</span> <span class="o">=</span> <span class="p">(</span>
+        <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">client_name</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">client_version</span><span class="si">}</span><span class="s2"> &quot;</span>
+        <span class="sa">f</span><span class="s2">&quot;(python </span><span class="si">{</span><span class="n">python_version</span><span class="si">}</span><span class="s2">; </span><span class="si">{</span><span class="n">system_info</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">release_info</span><span class="si">}</span><span class="s2">; </span><span class="si">{</span><span class="n">md5_hash</span><span class="si">}</span><span class="s2">)&quot;</span>
+    <span class="p">)</span>
+    <span class="bp">cls</span><span class="o">.</span><span class="n">user_agent_header</span> <span class="o">=</span> <span class="n">user_agent</span>
+
+    <span class="k">return</span> <span class="n">user_agent</span>
+</code></pre></div>
+        </details>
+    </div>
+
+  </div>
+
+
 
 
 
@@ -1727,6 +1744,58 @@ client is built to use Requests 3.x this function can be removed.</p>
 
 
 
+  <div class="doc doc-object doc-function">
+
+
+
+<h2 id="ciocore.api_client.truncate_middle" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">truncate_middle</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">max_length</span><span class="p">)</span></code>
+
+
+</h2>
+
+    <div class="doc doc-contents ">
+
+      <p>Truncate the string <code>s</code> to <code>max_length</code> by removing characters from the middle.</p>
+<p>:param s: The original string to be truncated.
+:type s: str
+:param max_length: The maximum allowed length of the string after truncation.
+:type max_length: int
+:return: The truncated string.
+:rtype: str</p>
+
+        <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">truncate_middle</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">max_length</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Truncate the string `s` to `max_length` by removing characters from the middle.</span>
+
+<span class="sd">    :param s: The original string to be truncated.</span>
+<span class="sd">    :type s: str</span>
+<span class="sd">    :param max_length: The maximum allowed length of the string after truncation.</span>
+<span class="sd">    :type max_length: int</span>
+<span class="sd">    :return: The truncated string.</span>
+<span class="sd">    :rtype: str</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="n">max_length</span><span class="p">:</span>
+        <span class="c1"># String is already at or below the maximum length, return it as is</span>
+        <span class="k">return</span> <span class="n">s</span>
+
+    <span class="c1"># Calculate the number of characters to keep from the start and end of the string</span>
+    <span class="n">num_keep_front</span> <span class="o">=</span> <span class="p">(</span><span class="n">max_length</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span>
+    <span class="n">num_keep_end</span> <span class="o">=</span> <span class="n">max_length</span> <span class="o">-</span> <span class="n">num_keep_front</span> <span class="o">-</span> <span class="mi">1</span>  <span class="c1"># -1 for the ellipsis</span>
+
+    <span class="c1"># Construct the truncated string</span>
+    <span class="k">return</span> <span class="n">s</span><span class="p">[:</span><span class="n">num_keep_front</span><span class="p">]</span> <span class="o">+</span> <span class="s1">&#39;~&#39;</span> <span class="o">+</span> <span class="n">s</span><span class="p">[</span><span class="o">-</span><span class="n">num_keep_end</span><span class="p">:]</span>
+</code></pre></div>
+        </details>
+    </div>
+
+  </div>
+
+
+
   <div class="doc doc-object doc-function">