sliderule-cli 5.6.1__py3-none-any.whl

sliderule_cli-5.6.1.dist-info/METADATA

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: sliderule-cli
+Version: 5.6.1
+Summary: SlideRule Command Line Tool
+License-Expression: BSD-3-Clause
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sliderule
+Requires-Dist: boto3
+Provides-Extra: progress
+Requires-Dist: tqdm; extra == "progress"
+Provides-Extra: recorder
+Requires-Dist: geoip2; extra == "recorder"
+Requires-Dist: pillow; extra == "recorder"
+Requires-Dist: matplotlib; extra == "recorder"
+Dynamic: license-file
+
+# sliderule-cli
+
+The SlideRule Command Line Tool

sliderule_cli-5.6.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+sliderule_cli-5.6.1.dist-info/licenses/LICENSE,sha256=119rmm_x_XICR1bLzv5ISXhCTfJ1GADdw145fZ3kbM0,1524
+sliderule_cluster/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sliderule_cluster/main.py,sha256=89DoY7nhYd36Vmach6jlHNQOK8o9rJ70_t5n6P5ww18,8435
+sliderule_provisioner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sliderule_provisioner/main.py,sha256=jDg2I1gVM98kITdNDjQQA1h9GzkuuiNLzBeIT6Fn6H4,6179
+sliderule_recorder/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sliderule_recorder/environment.yml,sha256=NrjKVuDD16mc1Kzizl6nerai1k6Bu9fcL3aEhYogbDQ,175
+sliderule_recorder/main.py,sha256=eaJpevchj8HZjbuAQcD0lTZRhHvKLjxdOkrMEqu2fno,23139
+sliderule_runner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sliderule_runner/database.py,sha256=z6OwXbJQlhHzj_E7sa1R6yKkIBvIHpnuf9FUAz1NCr4,2953
+sliderule_runner/main.py,sha256=b70PcgYwCNSw-1KL4jqcFkmsCzM1J3kYbCP0791Wb8k,11550
+sliderule_cli-5.6.1.dist-info/METADATA,sha256=cEwsg952ADP-tvEy7fzoNe-qyfjXVS7PKVUdjro03Gg,554
+sliderule_cli-5.6.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+sliderule_cli-5.6.1.dist-info/entry_points.txt,sha256=qA4WQESkLLqYTxo6bhooVBXcXFk-6pfl3gIs7yDlCW8,218
+sliderule_cli-5.6.1.dist-info/top_level.txt,sha256=uGQrdicJQc2qDd2pOcTS5DX0rcp-IwiCI0EtEiiaRKw,76
+sliderule_cli-5.6.1.dist-info/RECORD,,

sliderule_cli-5.6.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sliderule_cli-5.6.1.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+sliderule-cluster = sliderule_cluster.main:main
+sliderule-provisioner = sliderule_provisioner.main:main
+sliderule-recorder = sliderule_recorder.main:main
+sliderule-runner = sliderule_runner.main:main

sliderule_cli-5.6.1.dist-info/licenses/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2021, University of Washington. 
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the University of Washington nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY OF WASHINGTON AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OF WASHINGTON OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sliderule_cli-5.6.1.dist-info/top_level.txt

@@ -0,0 +1,4 @@
+sliderule_cluster
+sliderule_provisioner
+sliderule_recorder
+sliderule_runner

sliderule_cluster/main.py

@@ -0,0 +1,194 @@
+import json
+import uuid
+import tempfile
+import argparse
+from pathlib import Path
+from sliderule import sliderule
+
+#########################################
+# Tool
+#########################################
+
+class Tool:
+
+    # constructor
+    def __init__(self, args):
+        self.args = args
+        self.session = sliderule.create_session(domain=args.domain, cluster=args.cluster, user_service=args.user_service, verbose=args.verbose)
+
+    # display_result
+    def __display_result(self, result, reformat=False):
+        if reformat:
+            result = json.dumps(result, indent=2)
+        print(f'{self.args.cluster}.{self.args.domain} [{self.session.service}]: {result}')
+
+    # get_parms
+    def __get_parms(self, parms=None):
+        if self.args.parms:
+            with open(self.args.parms, "r") as file:
+                parms = json.load(file) # override
+        return parms
+
+    # get_poly
+    def __get_poly(self):
+        if self.args.poly:
+            return sliderule.toregion(self.args.poly)["poly"]
+        elif self.args.geojson:
+            return sliderule.toregion(self.args.geojson)["poly"]
+        elif self.args.bbox:
+            return sliderule.toregion(self.args.bbox)["poly"]
+        else:
+            return None
+
+    # whoami
+    def whoami(self):
+        rsps = self.session.source("whoami", parm={}, path="/discovery", retries=0, rethrow=True)
+        result = json.dumps(rsps)
+        self.__display_result(result)
+        return result
+
+    # status
+    def status(self):
+        if self.session.service != self.session.PUBLIC_CLUSTER:
+            parm = {"service":self.session.service}
+        else:
+            parm = {}
+        rsps = self.session.source("status", parm=parm, path="/discovery", retries=0, rethrow=True)
+        result = json.dumps(rsps)
+        self.__display_result(result)
+        return result
+
+    # version
+    def version(self):
+        result = sliderule.get_version(session=self.session)
+        self.__display_result(result, reformat=True)
+        return result
+
+    # defaults
+    def defaults(self):
+        result = sliderule.source("defaults", session=self.session)
+        self.__display_result(result, reformat=True)
+        return result
+
+    # earthdata
+    def earthdata(self):
+        parms = self.__get_parms({ k: v for k, v in {
+            "asset": self.args.asset,
+            "short_name": self.args.short_name,
+            "poly": self.__get_poly(),
+            "t0": self.args.t0,
+            "t1": self.args.t1,
+            "with_meta": self.args.with_meta,
+            "name_filter": self.args.name_filter,
+            "max_resources": self.args.max_resources
+        }.items() if v is not None })
+        result = sliderule.source("earthdata", parms, rethrow=True, session=self.session)
+        self.__display_result(result, reformat=True)
+        return result
+
+    # run
+    def run(self):
+        # get request parameters
+        if self.args.parms.startswith('"') or self.args.parms.startswith('{'):
+            parms = self.args.parms
+        else:
+            parms = self.__get_parms()
+        # build output parameters (if not supplied in request)
+        if "output" not in parms:
+            output_format = "geoparquet"
+            output_path = str(Path(tempfile.gettempdir()) / f"{uuid.uuid4()}.{output_format}")
+            parms |= {
+                "output": {
+                    "path": output_path,
+                    "format": output_format
+                }
+            }
+        elif "path" in parms["output"]:
+            output_path = parms["output"]["path"]
+        else:
+            output_path = None # will need to look for it later
+        # make request
+        rsps = sliderule.source(self.args.api, {"parms": parms}, stream=True, session=self.session)
+        # find remote output path (if not already set)
+        if not output_path:
+            for rsp in rsps:
+                if 'arrowrec.remote' == rsp['__rectype']:
+                    output_path = rsp['url']
+                    break
+        # set and return results
+        result = output_path
+        self.__display_result(result, reformat=True)
+        return result
+
+#########################################
+# Main
+#########################################
+
+def main():
+
+    # options shared by every subcommand; parents= lets them appear after the command name
+    common = argparse.ArgumentParser(add_help=False)
+    common.add_argument('--domain',         type=str,               default="slideruleearth.io")
+    common.add_argument('--cluster',        type=str,               default="sliderule")
+    common.add_argument('--user_service',   action='store_true',    default=False, help="uses dedicated user capacity")
+    common.add_argument('--verbose',        action='store_true',    default=False, help="turns on verbose log messages")
+    common.add_argument('--result',         type=str,               default=None, help="file name to store result of command")
+
+    # command line arguments
+    parser = argparse.ArgumentParser(prog="sliderule-cluster", description="""SlideRule Cluster""")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    # whoami
+    whoami = subparsers.add_parser("whoami", parents=[common], help="self identification of the cluster; returns cluster name")
+    whoami.set_defaults(func=Tool.whoami)
+
+    # status
+    status = subparsers.add_parser("status", parents=[common], help="registration status of cluster")
+    status.set_defaults(func=Tool.status)
+
+    # version
+    version = subparsers.add_parser("version", parents=[common], help="cluster version information")
+    version.set_defaults(func=Tool.version)
+
+    # defaults
+    defaults = subparsers.add_parser("defaults", parents=[common], help="cluster default parameter values")
+    defaults.set_defaults(func=Tool.defaults)
+
+    # earthdata
+    earthdata = subparsers.add_parser("earthdata", parents=[common], help="earthdata search")
+    earthdata.add_argument('--asset',           type=str,               default="icesat2", help="SlideRule asset name")
+    earthdata.add_argument('--poly',            type=float, nargs='+',  default=None, help="closed counter-clockwise list of latitude longitude pairs defining the area of interest; e.g. lon1 lat1 lon2 lat2 lon3 lat3 ... lon1 lat1")
+    earthdata.add_argument('--geojson',         type=str,               default=None, help="geojson filename defining the area of interest")
+    earthdata.add_argument('--bbox',            type=float, nargs='+',  default=None, help="bounding box defining the area of interest; e.g. lon_ll lat_ll lon_ur lat_ur")
+    earthdata.add_argument('--t0',              type=str,               default=None, help="start time as an ISO datetime string YYYY-MM-DDTHH:MM:SSZ") # datetime.fromisoformat(args.t0)
+    earthdata.add_argument('--t1',              type=str,               default=None, help="stop time as an ISO datetime string YYYY-MM-DDTHH:MM:SSZ") # datetime.fromisoformat(args.t1)
+    earthdata.add_argument('--max_resources',   type=int,               default=None, help="maximum number of resources allowed to be returned by query; queries exceeding this number return an error")
+    earthdata.add_argument('--short_name',      type=str,               default=None, help="CMR dataset name")
+    earthdata.add_argument('--with_meta',       action='store_true',    default=False, help="return metadata along with query results")
+    earthdata.add_argument('--name_filter',     type=str,               default=None, help="regular expression to evaluate against resource names returned by query")
+    earthdata.set_defaults(func=Tool.earthdata)
+
+    # run
+    run = subparsers.add_parser("run", parents=[common], help="execute dataframe based api request")
+    run.add_argument('api',     type=str,   metavar="<api>", help="endpoint being called")
+    run.add_argument('--parms', type=str,   required=True, help="string or filename containing json parameters to use in request")
+    run.set_defaults(func=Tool.run)
+
+    # parse command line
+    args = parser.parse_args()
+
+    # create tool
+    tool = Tool(args)
+
+    # route command
+    try:
+        result = args.func(tool)
+        if args.result:
+            with open(args.result, "w") as file:
+                file.write(result)
+    except Exception as e:
+        if args.verbose: raise
+        print(f"Unhandled error: {e}")
+
+# running via direct invocation
+if __name__ == "__main__": main()

sliderule_provisioner/main.py

@@ -0,0 +1,154 @@
+import json
+import argparse
+from datetime import datetime
+from zoneinfo import ZoneInfo
+from sliderule import sliderule
+
+#########################################
+# Tool
+#########################################
+
+class Tool:
+
+    # Constructor
+    def __init__(self, args):
+        self.args = args
+        self.session = sliderule.create_session(domain=args.domain, cluster=args.cluster, user_service=args.user_service, verbose=args.verbose)
+
+    def __display_concise(self, response):
+        data = {
+            "error": response.get("error"),
+            "error_description": response.get("error_description"),
+            "stack_name": response.get("response", {}).get("StackName"),
+            "stack_status": response.get("response", {}).get("StackStatus"),
+            "creation_time": response.get("response", {}).get("CreationTime"),
+            "auto_shutdown": response.get("auto_shutdown"),
+            "current_nodes": response.get("current_nodes"),
+            "version": response.get("version"),
+            "is_public": response.get("is_public"),
+            "node_capacity": response.get("node_capacity"),
+            "users": response.get("users")
+        }
+        for date_field in ["creation_time", "auto_shutdown"]:
+            if data[date_field]:
+                data[date_field] = datetime.fromisoformat(data[date_field]).astimezone(ZoneInfo(self.args.timezone)).strftime("%Y-%m-%d %H:%M:%S %Z")
+        if data["users"]:
+            for user in data["users"]:
+                data["users"][user]["auto_shutdown"] = datetime.fromisoformat(data["users"][user]["auto_shutdown"]).astimezone(ZoneInfo(self.args.timezone)).strftime("%Y-%m-%d %H:%M:%S %Z")
+        return {k:data[k] for k in data if data[k] is not None}
+
+    # Deploy
+    def deploy(self):
+        return self.session.provisioner.deploy(is_public=(self.args.is_public == "true"), node_capacity=self.args.node_capacity, ttl=self.args.ttl, version=self.args.version)
+
+    # Extend
+    def extend(self):
+        return self.session.provisioner.extend(ttl=self.args.ttl)
+
+    # Destroy
+    def destroy(self):
+        return self.session.provisioner.destroy()
+
+    # Status
+    def status(self):
+        return self.__display_concise(self.session.provisioner.status())
+
+    # Events
+    def events(self):
+        return self.session.provisioner.events()
+
+    # Report
+    def report(self):
+        return {k[0]:self.__display_concise(k[1]) for k in self.session.provisioner.report(kind=self.args.kind).items()}
+
+    # Test
+    def test(self):
+        return self.session.gateway_request("test", subdomain="provisioner", data={"branch":self.args.branch})
+
+    # Info
+    def info(self):
+        return self.session.provisioner.info()
+
+    # Authenticate
+    def authenticate(self):
+        return self.session.authenticate(force_login=True)
+
+
+#########################################
+# Main
+#########################################
+
+def main():
+
+    # command line arguments
+    parser = argparse.ArgumentParser(prog="sliderule-runner", description="""SlideRule Runner""")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    # options shared by every subcommand; parents= lets them appear after the command name
+    common = argparse.ArgumentParser(add_help=False)
+    common.add_argument('--domain',         type=str,               default="slideruleearth.io")
+    common.add_argument('--cluster',        type=str,               default="developers")
+    common.add_argument('--user_service',   action='store_true',    default=False)
+    common.add_argument('--concise',        action='store_true',    default=False)
+    common.add_argument('--verbose',        action='store_true',    default=False)
+    common.add_argument('--timezone',       type=str,               default="America/New_York")
+
+    # deploy
+    deploy = subparsers.add_parser("deploy", parents=[common], help="deploy a cluster (stand-alone or as user capacity)")
+    deploy.add_argument('--is_public',      type=str,   default="false")
+    deploy.add_argument('--node_capacity',  type=int,   default=1)
+    deploy.add_argument('--ttl',            type=int,   default=60) # 1 hour
+    deploy.add_argument('--version',        type=str,   default="unstable")
+    deploy.set_defaults(func=Tool.deploy)
+
+    # extend
+    extend = subparsers.add_parser("extend", parents=[common], help="extend a cluster")
+    extend.add_argument('--ttl',    type=int,   default=60) # 1 hour
+    extend.set_defaults(func=Tool.extend)
+
+    # destroy
+    destroy = subparsers.add_parser("destroy", parents=[common], help="destroy a cluster")
+    destroy.set_defaults(func=Tool.destroy)
+
+    # status
+    status = subparsers.add_parser("status", parents=[common], help="status a cluster")
+    status.set_defaults(func=Tool.status)
+
+    # events
+    events = subparsers.add_parser("events", parents=[common], help="list the stack events associated with a cluster")
+    events.set_defaults(func=Tool.events)
+
+    # report
+    report = subparsers.add_parser("report", parents=[common], help="report metadata of active clusters")
+    report.add_argument('--kind',   type=str,   default="clusters", help="'cluster' for cluster report, 'test' for test report")
+    report.set_defaults(func=Tool.report)
+
+    # test
+    test = subparsers.add_parser("test", parents=[common], help="execute the test runner")
+    test.add_argument('--branch',   type=str,   default="main")
+    test.set_defaults(func=Tool.test)
+
+    # info
+    info = subparsers.add_parser("info", parents=[common], help="display information about provisioner")
+    info.set_defaults(func=Tool.info)
+
+    # authenticate
+    authenticate = subparsers.add_parser("authenticate", parents=[common], help="force re-authentication of user account")
+    authenticate.set_defaults(func=Tool.authenticate)
+
+    # parse command line
+    args = parser.parse_args()
+
+    # create tool
+    tool = Tool(args)
+
+    # route command
+    try:
+        result = args.func(tool)
+        print(f'{json.dumps(result, indent=2)}')
+    except Exception as e:
+        if args.verbose: raise
+        print(f"Unhandled error: {e}")
+
+# running via direct invocation
+if __name__ == "__main__": main()

sliderule_recorder/environment.yml

@@ -0,0 +1,12 @@
+# conda env create -f environment.yml
+name: recorder
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - python
+  - boto3
+  - geoip2
+  - pandas
+  - pillow
+  - matplotlib