ciocore 7.0.2b4__py2.py3-none-any.whl → 8.0.0__py2.py3-none-any.whl

ciocore/package_environment.py

@@ -7,21 +7,15 @@ class PackageEnvironment(object):
 
     def __init__(self, env_list=None, platform=None):
         """
-        Create a list of environment variables.
+        Encapsulate a list of environment variables.
 
-        Typically, one would initialize a PackageEnvironment with a package, and then modify by
-        adding more packages or lists of variables. Extra variables can be added by the customer, or
-        programmatically such as during asset scraping.
-
-        Keyword Arguments:
-
-        * **`env_list`** -- Either a Package that contains an "environment" property, or a list of
-          environment objects. -- Defaults to `None`.
-        * **`platform`** -- If env_list is not a package, then the platform must be provided. --
-          Defaults to `None`.
-
-        On instantiation, delegete args to the [extend()](#extend) method.
+        Typically, one would initialize a PackageEnvironment with a package, and then modify by adding more packages or lists of variables. Extra variables can be added by the customer, or programmatically such as during asset scraping.
 
+        Args:
+            env_list (object|list): An object that provides a list of dictionaries with properties: `name`, `value`, and `merge_policy`.
+            platform (str): If the env_list is a regular list, then this is required.
+            
+        Args are delegated to [extend()](/package_environment/#ciocore.package_environment.PackageEnvironment.extend).
         """
         self.platform = None
         self._env = {}
@@ -33,73 +27,53 @@ class PackageEnvironment(object):
         """
         Extend the Package environment with the given variable specifications.
 
-        Arguments:
-
-        * **`env_list`** --  Either:
-        1. A list of dictionaries with properties: `name`, `value`, and `merge_policy`.
-        2. An object with an `environment` key that contains a list of the dictionaries described
-           above. The latter is the structure of a package. Therefore we can initialize or extend a
-           PackageEnvironment with a package.
-
-
-        Keyword Arguments:
+        Args:
+            env_list (object|list): Either:
+                * A list of dictionaries with properties: `name`, `value`, and `merge_policy`.
+                * An object with an `environment` key that contains a list of the dictionaries described above. The latter is the structure of a package. Therefore we can initialize or extend a PackageEnvironment with a package.
+            platform (str): Defaults to `None`. If env_list is a package, then the platform is taken from the package and the `platform` keyword is ignored. If env_list is a list, then if this is the first add, a platform should be specified, otherwise it will default to linux.
+                
+        The first time data is added to a PackageEnvironment, the platform is set in stone. Subsequent `adds` that try to change the platform are considered an error.
 
-        * **`platform`** -- Defaults to `None`.
-            If env_list is a package, then the platform is taken from the package and the `platform`
-            keyword is ignored. If env_list is a list, then if this is the first add, a platform
-            should be specified, otherwise it willl default to linux.
-        
-        The first time data is added to a PackageEnvironment, the platform is set in stone.
-        Subsequent `adds` that try to change the platform are considered an error.
-
-        Each variable to be added specifies a merge_policy: `append` or `exclusive`. Once an
-        individual variable has been initialized with a merge policy, it can't be changed. This
-        means: 1. It's not possible to overwrite variables that have been set as append. 2.
-        Exclusive variables are always overwritten by subsequent adds.
+        Each variable to be added specifies a merge_policy: `append`, `prepend`, or `exclusive` `append` and `prepend` can be thought of as lists= types. Once an individual variable has been initialized as a list, it can't be changed to `exclusive`. This means:
+    
+        1. It's not possible to overwrite variables that have been added as `append` or `prepend`.
+        2. Exclusive variables are always overwritten by subsequent adds.
 
         Raises:
-
-        * **`ValueError`** -- Attempt to change the platform once initialized.
-        * **`ValueError`** -- Unknown merge policy
-        .
-
-        ???+ example
-            ``` python
-
-            from ciocore import api_client, package_tree, package_environment
-            packages = api_client.request_software_packages()
-            pt = package_tree.PackageTree(packages, product="cinema4d")
-            one_dcc_name = pt.supported_host_names()[0]
-            # 'cinema4d 21.209.RB305619 linux'
-            pkg = pt.find_by_name(one_dcc_name)
-            pe = package_environment.PackageEnvironment(pkg)
-            print(dict(pe))
-
-            # Result:
-            # {
-            # "PATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin",
-            # "g_licenseServerRLM": "conductor-rlm:6112",
-            # "LD_LIBRARY_PATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/lib64:/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/python/libs/linux64/python.linux64.framework/lib64:/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/embree.module/libs/linux64",
-            # "PYTHONPATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/python/libs/linux64/python.linux64.framework/lib64/python2.7/lib-dynload",
-            # }
-
-            extra_env = [
+            ValueError: Either an attempt to change the platform once initialized, or an invalid merge policy.
+
+            
+        Example:
+            >>> from ciocore import api_client, package_tree, package_environment
+            >>> packages = api_client.request_software_packages()
+            >>> pt = package_tree.PackageTree(packages, product="cinema4d")
+            >>> one_dcc_name = pt.supported_host_names()[0]
+            cinema4d 21.209.RB305619 linux
+        
+            >>> pkg = pt.find_by_name(one_dcc_name)
+            >>> pe = package_environment.PackageEnvironment(pkg)
+            >>> print(dict(pe))
+            {
+            "PATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin",
+            "g_licenseServerRLM": "conductor-rlm:6112",
+            "LD_LIBRARY_PATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/lib64:/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/python/libs/linux64/python.linux64.framework/lib64:/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/embree.module/libs/linux64",
+            "PYTHONPATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/python/libs/linux64/python.linux64.framework/lib64/python2.7/lib-dynload",
+            }
+
+            >>> extra_env = [
                 {"name":"PATH", "value": "/my/custom/scripts", "merge_policy":"append"},
                 {"name":"DEBUG_MODE", "value": "1", "merge_policy":"exclusive"}
             ]
-
-            pe.extend(extra_env)
-            print(dict(pe))
-
-            # Result:
-            # {
-            #     "PATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin:/my/custom/scripts",
-            #     "g_licenseServerRLM": "conductor-rlm:6112",
-            #     "LD_LIBRARY_PATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/lib64:/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/python/libs/linux64/python.linux64.framework/lib64:/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/embree.module/libs/linux64",
-            #     "PYTHONPATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/python/libs/linux64/python.linux64.framework/lib64/python2.7/lib-dynload",
-            #     "DEBUG_MODE": "1",
-            # }
-            ```
+            >>> pe.extend(extra_env)
+            >>> print(dict(pe))
+            {
+                "PATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin:/my/custom/scripts",
+                "g_licenseServerRLM": "conductor-rlm:6112",
+                "LD_LIBRARY_PATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/lib64:/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/python/libs/linux64/python.linux64.framework/lib64:/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/embree.module/libs/linux64",
+                "PYTHONPATH": "/opt/maxon/cinema4d/21/cinema4d21.209vRB305619/bin/resource/modules/python/libs/linux64/python.linux64.framework/lib64/python2.7/lib-dynload",
+                "DEBUG_MODE": "1",
+            }
         """
 
         if not env_list:
@@ -121,11 +95,13 @@ class PackageEnvironment(object):
             name = var["name"]
             value = var["value"]
             policy = var["merge_policy"]
-            if policy not in ["append", "exclusive"]:
+            if policy not in ["append", "prepend", "exclusive"]:
                 raise ValueError("Unexpected merge policy: %s" % policy)
 
             if policy == "append":
                 self._append(name, value)
+            elif policy == "prepend":
+                self._prepend(name, value)
             else:
                 self._set(name, value)
 
@@ -159,6 +135,22 @@ class PackageEnvironment(object):
             self._env[name] = []
         self._env[name].append(value)
 
+    def _prepend(self, name, value):
+        """Set the value of an append/prepend variable.
+
+        Can be appended to with subsequent adds.
+
+        It is an error if the variable has already been declared with policy=exclusive.
+        """
+        if self._env.get(name):
+            if not isinstance(self._env[name], list):
+                raise ValueError(
+                    "Can't change merge policy for '{}' from 'exclusive' to 'prepend'.".format(name)
+                )
+        else:
+            self._env[name] = []
+        self._env[name].insert(0, value)
+        
     def __iter__(self):
         """Cast the object as a dict."""
         sep = ";" if self.platform == "windows" else ":"

ciocore/package_query.py

@@ -0,0 +1,171 @@
+"""
+Generate markdown from the software packages list.
+"""
+import os
+import sys
+import json
+from ciocore.package_tree import PackageTree
+from ciocore import api_client
+import markdown
+import io
+import tempfile
+import webbrowser
+
+PURE = """
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/purecss@3.0.0/build/pure-min.css" integrity="sha384-X38yfunGUhNzHpBaEBsWLO+A0HDYOQi8ufWDkZ0k9e0eXz/tH3II7uKZ9msv++Ls" crossorigin="anonymous">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+"""
+
+def green(rhs):
+    return "\033[92m{}\033[0m".format(rhs)
+
+
+def red(rhs):
+    return "\033[91m{}\033[0m".format(rhs)
+
+
+def blue(rhs):
+    return "\033[94m{}\033[0m".format(rhs)
+
+
+def magenta(rhs):
+    return "\033[95m{}\033[0m".format(rhs)
+
+
+def raw(rhs, stream):
+    stream.write("{}\n\n".format(rhs))
+
+
+def d(n, rhs, stream):
+    """Indent with dashes"""
+    stream.write("{} {}\n".format("-" * n, rhs))
+
+
+def hr(stream):
+    stream.write("---\n\n")
+
+
+def h(n, rhs, stream):
+    stream.write("{} {}\n\n".format("#" * n, rhs))
+
+
+def plugin_table_header(stream):
+    stream.write(
+        '|<div style="width:150px">Plugin</div> |<div style="min-width:400px">Versions</div>|\n|:------------|:-------------|\n'
+    )
+
+
+def plugin_table_row(plugin, versions, stream):
+    stream.write("|{}|{}|\n".format(plugin, versions))
+
+
+def write_markdown(hostnames, tree_data, platform, stream):
+    """
+    Write the tree of packages in Markdown.
+
+    Use this to generate docs for the Conductor mkdocs site.
+    """
+    if not hostnames:
+        return
+    h(2, "{} Software".format(platform.capitalize()), stream)
+    last_hostgroup = None
+    for hostname in hostnames:
+        display_hostname = " ".join(hostname.split()[:2])
+        hostgroup = hostname.split(" ")[0]
+        stream.write("\n")
+        if not hostgroup == last_hostgroup:
+            hr(stream)
+            h(3, hostgroup, stream)
+        h(4, display_hostname, stream)
+        last_hostgroup = hostgroup
+        plugins = tree_data.supported_plugins(hostname)
+        if plugins:
+            plugin_table_header(stream)
+            for plugin in plugins:
+                plugin_table_row(
+                    plugin["plugin"], ", ".join(plugin["versions"]), stream
+                )
+
+
+def write_text(hostnames, tree_data, platform, color_func, stream):
+    """
+    Write the tree of packages as text.
+
+    Products are indented with one dash.
+    Host packages are indented with two dashes.
+    Plugin packages are indented with three dashes.
+    """
+    if not hostnames:
+        d(0, red("There are no '{}' host packages".format(platform)), stream)
+        return
+    d(0, "{} Software".format(platform).upper(), stream)
+    last_hostgroup = None
+    for hostname in hostnames:
+        display_hostname = " ".join(hostname.split()[:2])
+        hostgroup = hostname.split(" ")[0]
+        if not hostgroup == last_hostgroup:
+            d(0, green("-" * 30), stream)
+            d(1, color_func(hostgroup), stream)
+        d(2, color_func(display_hostname), stream)
+        last_hostgroup = hostgroup
+        plugins = tree_data.supported_plugins(hostname)
+        if plugins:
+            for plugin in plugins:
+                d(
+                    3,
+                    color_func(
+                        "{} [{}]".format(
+                            plugin["plugin"], ", ".join(plugin["versions"])
+                        )
+                    ),
+                    stream,
+                )
+
+
+def pq(format="text"):
+    packages = api_client.request_software_packages()
+
+    tree_data = PackageTree(packages)
+
+    hostnames = tree_data.supported_host_names()
+    linux_hostnames = [h for h in hostnames if h.endswith("linux")]
+    windows_hostnames = [h for h in hostnames if h.endswith("windows")]
+
+    if format == "markdown":
+        stream = sys.stdout
+        raw(
+            "This page contains the complete list of software available at Conductor. If you require applications or plugins that are not in the list, please [create a support ticket](https://support.conductortech.com/hc/en-us/requests/new) and let us know.",
+            stream,
+        )
+        write_markdown(linux_hostnames, tree_data, "linux", stream)
+        write_markdown(windows_hostnames, tree_data, "windows", stream)
+    elif format == "text":
+        stream = sys.stdout
+        write_text(linux_hostnames, tree_data, "linux", magenta, stream)
+        d(0, "", stream)
+        write_text(windows_hostnames, tree_data, "windows", blue, stream)
+    elif format == "html":
+        stream = io.StringIO()
+        raw(
+            "This page contains the complete list of software available at Conductor. If you require applications or plugins that are not in the list, please [create a support ticket](https://support.conductortech.com/hc/en-us/requests/new) and let us know.",
+            stream,
+        )
+
+        write_markdown(linux_hostnames, tree_data, "linux", stream)
+        write_markdown(windows_hostnames, tree_data, "windows", stream)
+
+        html = markdown.markdown(
+            stream.getvalue(), extensions=["markdown.extensions.tables"]
+        )
+
+        html = decorate(html)
+
+        stream.close()
+        with tempfile.NamedTemporaryFile(mode="w", suffix=".html", delete=False) as f:
+            f.write(html)
+            webbrowser.open("file://" + f.name, new=2)
+
+def decorate(html):
+    html = html.replace("<table>", '<table class="pure-table pure-table-bordered">')
+    html = '<html><head>{}</head><body style="margin: 2em;">{}</body></html>'.format(PURE, html)
+    return html