idmtools-cli 0.0.0.dev0__py3-none-any.whl → 0.0.3__py3-none-any.whl

idmtools_cli/utils/cols.py

@@ -0,0 +1,135 @@
+"""Defines utilities for display formatting on multiple platforms."""
+from __future__ import absolute_import
+from typing import Optional
+from .formatters import max_width, min_width
+import sys
+
+NEWLINES = ('\n', '\r', '\r\n')
+
+
+def _find_unix_console_width() -> Optional[int]:
+    """
+    Find the width of a Unix console where possible.
+
+    Returns:
+        Width
+    """
+    import termios
+    import fcntl
+    import struct
+
+    # fcntl.ioctl will fail if stdout is not a tty
+    if not sys.stdout.isatty():
+        return None
+
+    s = struct.pack("HHHH", 0, 0, 0, 0)
+    fd_stdout = sys.stdout.fileno()
+    size = fcntl.ioctl(fd_stdout, termios.TIOCGWINSZ, s)
+    height, width = struct.unpack("HHHH", size)[:2]
+    return width
+
+
+def _find_windows_console_width() -> int:
+    """
+    Find the windows console width.
+
+    Returns:
+        Returns width of Windows Console
+    """
+    from ctypes import windll, create_string_buffer
+    stdin, stdout, stderr = -10, -11, -12  # noqa: F841
+
+    h = windll.kernel32.GetStdHandle(stderr)
+    csbi = create_string_buffer(22)
+    res = windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
+
+    if res:
+        import struct
+        (bufx, bufy, curx, cury, wattr,
+         left, top, right, bottom,
+         maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
+        sizex = right - left + 1
+        return sizex
+
+
+def console_width(kwargs: dict) -> int:
+    """
+    Determine Console Width.
+
+    Args:
+        kwargs: Optional args. Currently Width is supported
+
+    Returns:
+        Console Width
+    """
+    if sys.platform.startswith('win'):
+        cons_width = _find_windows_console_width()
+    else:
+        cons_width = _find_unix_console_width()
+
+    _width = kwargs.get('width', None)
+    if _width:
+        cons_width = _width
+    else:
+        if not cons_width:
+            cons_width = 80
+
+    return cons_width
+
+
+def columns(*cols, **kwargs) -> str:
+    """
+    Format click output in columns.
+
+    Args:
+        *cols: Colums in tuples
+        **kwargs: Optional arguments
+
+    Examples:
+        > click.echo(columns((a, 20), (b, 20), (b, None)))
+
+    Returns:
+        Column formatted strings
+    """
+    cwidth = console_width(kwargs)
+
+    _big_col = None
+    _total_cols = 0
+
+    cols = [list(c) for c in cols]
+
+    for i, (string, width) in enumerate(cols):
+
+        if width is not None:
+            _total_cols += (width + 1)
+            cols[i][0] = max_width(string, width).split('\n')
+        else:
+            _big_col = i
+
+    if _big_col:
+        cols[_big_col][1] = (cwidth - _total_cols) - len(cols)
+        cols[_big_col][0] = max_width(cols[_big_col][0], cols[_big_col][1]).split('\n')
+
+    height = len(max([c[0] for c in cols], key=len))
+
+    for i, (strings, width) in enumerate(cols):
+
+        for _ in range(height - len(strings)):
+            cols[i][0].append('')
+
+        for j, string in enumerate(strings):
+            cols[i][0][j] = min_width(string, width)
+
+    stack = [c[0] for c in cols]
+    _out = []
+
+    for i in range(height):
+        _row = ''
+
+        for col in stack:
+            _row += col[i]
+            _row += ' '
+
+        _out.append(_row)
+
+    return '\n'.join(_out)

idmtools_cli/utils/formatters.py

@@ -0,0 +1,105 @@
+"""Utility functions around formatting output for cli."""
+from __future__ import absolute_import
+import re
+from .utils import tsplit, schunk
+
+NEWLINES = ('\n', '\r', '\r\n')
+
+
+def clean(s: str):
+    """
+    Clean string so that all special formatting is stripped.
+
+    Args:
+        s: str
+
+    Returns:
+        Cleaned string
+    """
+    strip = re.compile(r'(\x9B|\x1B\[)[0-?]*[ -\/]*[@-~]')
+    txt = strip.sub('', s)
+
+    return txt
+
+
+def min_width(string, cols: int, padding=' '):
+    """
+    Returns given string with right padding.
+
+    Args:
+        string: string to be formatted
+        cols: min width the text to be formatted
+        padding: Padding
+
+    Returns:
+        String formatted with min width
+    """
+    stack = tsplit(str(string), NEWLINES)
+
+    for i, substring in enumerate(stack):
+        _sub = clean(substring).ljust((cols + 0), padding)
+        stack[i] = _sub
+
+    return '\n'.join(stack)
+
+
+def max_width(string: str, cols: int, separator='\n'):
+    """
+    Returns a freshly formatted string.
+
+    Args:
+        string: string to be formatted
+        cols: max width the text to be formatted
+        separator: separator to break rows
+
+    Returns:
+        String formatted with max width
+    """
+    stack = tsplit(string, NEWLINES)
+
+    for i, substring in enumerate(stack):
+        stack[i] = substring.split()
+
+    _stack = []
+
+    for row in stack:
+        _row = ['', ]
+        _row_i = 0
+
+        for word in row:
+            if (len(_row[_row_i]) + len(word)) <= cols:
+                _row[_row_i] += word
+                _row[_row_i] += ' '
+
+            elif len(word) > cols:
+
+                # ensure empty row
+                if len(_row[_row_i]):
+                    _row[_row_i] = _row[_row_i].rstrip()
+                    _row.append('')
+                    _row_i += 1
+
+                chunks = schunk(word, cols)
+                for i, chunk in enumerate(chunks):
+                    if i + 1 != len(chunks):
+                        _row[_row_i] += chunk
+                        _row[_row_i] = _row[_row_i].rstrip()
+                        _row.append('')
+                        _row_i += 1
+                    else:
+                        _row[_row_i] += chunk
+                        _row[_row_i] += ' '
+            else:
+                _row[_row_i] = _row[_row_i].rstrip()
+                _row.append('')
+                _row_i += 1
+                _row[_row_i] += word
+                _row[_row_i] += ' '
+        else:
+            _row[_row_i] = _row[_row_i].rstrip()
+
+        _row = map(str, _row)
+        _stack.append(separator.join(_row))
+
+    _s = '\n'.join(_stack)
+    return _s

idmtools_cli/utils/utils.py

@@ -0,0 +1,63 @@
+"""Misc util functions for cli."""
+from __future__ import absolute_import
+from __future__ import with_statement
+
+import errno
+import os.path
+from os import makedirs
+from glob import glob
+
+try:
+    basestring
+except NameError:
+    basestring = str
+
+
+def expand_path(path):
+    """Expands directories and globs in given path."""
+    paths = []
+    path = os.path.expanduser(path)
+    path = os.path.expandvars(path)
+
+    if os.path.isdir(path):
+
+        for (dir, _dirs, files) in os.walk(path):
+            for file in files:
+                paths.append(os.path.join(dir, file))
+    else:
+        paths.extend(glob(path))
+
+    return paths
+
+
+def is_collection(obj):
+    """Tests if an object is a collection. Strings don't count."""
+    if isinstance(obj, basestring):
+        return False
+
+    return hasattr(obj, '__getitem__')
+
+
+def mkdir_p(path):
+    """Emulates `mkdir -p` behavior."""
+    try:
+        makedirs(path)
+    except OSError as exc:  # Python >2.5
+        if exc.errno != errno.EEXIST:
+            raise
+
+
+def tsplit(string, delimiters):
+    """Behaves str.split but supports tuples of delimiters."""
+    delimiters = tuple(delimiters)
+    if len(delimiters) < 1:
+        return [string, ]
+    final_delimiter = delimiters[0]
+    for i in delimiters[1:]:
+        string = string.replace(i, final_delimiter)
+    return string.split(final_delimiter)
+
+
+def schunk(string, size):
+    """Splits string into n sized chunks."""
+    return [string[i:i + size] for i in range(0, len(string), size)]

idmtools_cli-0.0.3.dist-info/METADATA

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: idmtools_cli
+Version: 0.0.3
+Summary: CLI for IDM-Tools
+Author-email: Sharon Chen <schen@idmod.org>, Clinton Collins <ccollins@idmod.org>, Zhaowei Du <zdu@idmod.org>, Mary Fisher <mfisher@idmod.org>, Clark Kirkman IV <ckirkman@idmod.org>, Benoit Raybaud <braybaud@idmod.org>
+Project-URL: Homepage, https://github.com/InstituteforDiseaseModeling/idmtools
+Keywords: modeling,IDM,cli
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.TXT
+Requires-Dist: click~=8.1.7
+Requires-Dist: click-plugins
+Requires-Dist: colorama~=0.4.6
+Requires-Dist: cookiecutter~=2.6.0
+Requires-Dist: idmtools<1.0.0,>=0.0.0
+Requires-Dist: tabulate<0.10,>=0.8.9
+Requires-Dist: pyperclip~=1.8
+Requires-Dist: yaspin<3.1.0,>=1.2.0
+Provides-Extra: test
+Requires-Dist: idmtools[test]; extra == "test"
+Dynamic: license-file
+
+![Staging: idmtools-cli](https://github.com/InstituteforDiseaseModeling/idmtools/workflows/Staging:%20idmtools-cli/badge.svg?branch=dev)
+
+# idmtools-cli
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**
+
+  - [Installing](#installing)
+- [Development tips](#development-tips)
+- [Using the CLI](#using-the-cli)
+  - [Version command](#version-command)
+  - [Experiment commands for Local Platform](#experiment-commands-for-local-platform)
+    - [Status](#status)
+    - [Delete](#delete)
+  - [Simulation commands for Local Platform](#simulation-commands-for-local-platform)
+  - [Status](#status-1)
+  - [GitRepo commands](#gitrepo-commands)
+    - [View](#view)
+    - [Repos](#repos)
+    - [Releases](#releases)
+    - [Peep](#peep)
+    - [Download](#download)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installing
+
+```bash
+pip install idmtools-cli --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
+```
+
+# Development tips
+
+There is a Makefile file available for most common development tasks. Here is a list of commands
+```bash
+clean       -   Clean up temproary files
+lint        -   Lint package and tests
+test        -   Run All tests
+coverage    -   Run tests and generate coverage report that is shown in browser
+```
+On Windows, you can use `pymake` instead of `make`
+
+# Using the CLI
+
+The CLI requires the workers service to already be running.
+`idmtools`
+
+## Version command
+
+To determine version of idmtools and related plugins, use the version cli command.
+
+
+```
+> idmtools version
+```
+
+Example output
+```bash
+emodpy                               Version: 1.3.0                           
+  Plugins:
+    EMODTask                  
+idmtools                             Version: 1.4.0+nightly.0                 
+  Plugins:
+    CommandTask               
+idmtools-cli                         Version: 1.4.0+nightly.0                 
+idmtools-models                      Version: 1.4.0+nightly.0                 
+  Plugins:
+    JSONConfiguredPythonTask  
+    JSONConfiguredRTask       
+    JSONConfiguredTask        
+    PythonTask                
+    RTask                     
+    ScriptWrapperTask         
+    TemplatedScriptTask       
+idmtools-platform-comps              Version: 1.4.0+nightly.0                 
+  Plugins:
+    COMPSPlatform             
+    SSMTPlatform                        
+idmtools-platform-slurm              Version: 1.0.0+nightly                   
+  Plugins:
+    SlurmPlatform             
+```
+
+
+## Experiment commands for Local Platform
+
+### Status
+
+You can check the status of experiments use the follow command. It will also summarize the simulations under
+the experiment as a progress bar with green section for completed tasks, yellow for in progress, red for failed, and
+white for queued. 
+
+```
+> idmtools experiment --platform Local status --help
+```
+ 
+
+In addition, we used in conjunction with a console that supports auto-highlighting of hyperlinks, you will be able to
+easily open up the asset directories by clicking on the data path URLs.
+
+You can also perform filtering on the experiments
+```bash
+> idmtools experiment --platform Local status --tag type PythonExperiment
+> idmtools experiment --platform Local status --id 8EHU147Z
+```
+
+### Delete
+
+You can delete experiments and their child simulations using the following command. Optionally you can also delete
+the associated data directories as well by using the *--data* option.
+
+```
+>idmtools experiment --platform Local delete <experiment_id>
+```
+
+## Simulation commands for Local Platform
+
+## Status 
+
+You can check the status of simulations use the follow command.
+
+```
+>idmtools simulation --platform Local status
+```
+
+You can also filter by a either id, experiment id, status, and tags or any combination of the aforementioned
+
+```bash
+> idmtools simulation --platform Local status --experiment-id EFX6JXBV
+> idmtools simulation --platform Local status --id XDT0VMVV
+> idmtools simulation --platform Local status --tag a 5 --tag b
+> idmtools simulation --platform Local status --experiment-id --status failed
+```
+
+
+## GitRepo commands
+
+### View
+
+You can check idmtools available examples. You can use --raw to determine to display in detailed or simplified format
+
+```
+> idmtools gitrepo view
+```
+
+### Repos
+
+You can list all public repos for a GitHub owner. You can use --owner to specify an owner and --page for pagination
+--owner default to 'institutefordiseasemodeling'
+--page default to 1
+
+```
+> idmtools gitrepo repos
+```
+
+### Releases
+
+You can list all releases of a repo by providing --owner and --repo
+--owner default to 'institutefordiseasemodeling' and --repo default to 'idmtools'
+
+```
+> idmtools gitrepo releasess
+```
+
+### Peep
+
+You can list all current files/dirs of a repo folder by providing --url
+
+```
+> idmtools gitrepo peep
+```
+
+### Download
+
+You can download files from a public repo to a specified local folder (default to current folder). By default, it will 
+download idmtools examples. You can also download any files from any public repo by using --url (multiple is supported)
+
+```
+> idmtools gitrepo download
+```

idmtools_cli-0.0.3.dist-info/RECORD

@@ -0,0 +1,22 @@
+idmtools_cli/__init__.py,sha256=sEBWyulZ-E6ZW9tckw0upjv2CXr54scjCD-G7_sGSGA,404
+idmtools_cli/iplatform_cli.py,sha256=tNWPKXFvNvUUcTrTW7fOq9fnWa_CAo--wnq7G5SpiSs,4203
+idmtools_cli/main.py,sha256=8FzGi8ql1VzlZ-z_2Y6Smrn-u-qEMoDzqjtx_9m4AEg,1428
+idmtools_cli/cli/__init__.py,sha256=W27dJyYV-UFQiUpLLHOd-akBiOCFn94wspdblnJm-4E,25
+idmtools_cli/cli/common_project_templates.json,sha256=9eattYzi8VE2YjHnxz6l24jgUfvk01OvzyHWG5AVeO8,1236
+idmtools_cli/cli/config_file.py,sha256=R8nX7Ig1ic7eoVDfm1-tLUrGhQVrmZAPdLYoWfhkJmE,6876
+idmtools_cli/cli/entrypoint.py,sha256=SMk8c8fOEUgBAzH1-Ry9wMu9LlNVsuL86NTwAlLKzCw,1624
+idmtools_cli/cli/gitrepo.py,sha256=4j8XRxf4nVs3zjYMSYNjWSkXXmf5W9yXAMzIwKeJ-DE,11883
+idmtools_cli/cli/init.py,sha256=U-MdurqF0pI60joet7TfCeTUyAiJL6hrw0OqHVVUZC4,3294
+idmtools_cli/cli/package.py,sha256=ULzhssPxfRjYUcDFwFF6iX5T8hU8jA4luvEidAvupnw,3758
+idmtools_cli/cli/system_info.py,sha256=DZ7a4qeOO1xV1JmdNf8iiTQN47g7YIfl0iZQ3XjqPyw,6574
+idmtools_cli/cli/utils.py,sha256=c-SUl-XBFUu-jDDdOqMtJLOaIubAKSVPBfUqlN3gPTY,1619
+idmtools_cli/utils/__init__.py,sha256=bDPP5rNgKsS-pNIr8PTNxcNC4yEtDiBm5WqikdkJBgY,28
+idmtools_cli/utils/cols.py,sha256=S1iB5XVCKNjbTG32WKbq0nxAtw7uQI_kVEc3hF3d1m4,3181
+idmtools_cli/utils/formatters.py,sha256=8PWs23BoquAuNrp4CKooL7IcnvB4LQIqFPtDc52U-D4,2643
+idmtools_cli/utils/utils.py,sha256=fGN8-J1ucsah37ej7A691isNHooqm_1wJ-RY1bXuT0o,1507
+idmtools_cli-0.0.3.dist-info/licenses/LICENSE.TXT,sha256=l9S8Ydr_LcejxKoqK8191ZAOsmVX-nJLSPoLKZDUgcg,197
+idmtools_cli-0.0.3.dist-info/METADATA,sha256=GoVv_QxHbw0AfmDgUGMntPNnMRv0I27DUAwJjFA4dSc,6333
+idmtools_cli-0.0.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+idmtools_cli-0.0.3.dist-info/entry_points.txt,sha256=gBZCfX9EkfkYtAoN8-bmXmaRNB6_ZQO9xb9_NcPQ0c0,52
+idmtools_cli-0.0.3.dist-info/top_level.txt,sha256=x73U8RzbjKObflWrJtj_wQxw0rkmUv3BgNuQHt1wyAE,13
+idmtools_cli-0.0.3.dist-info/RECORD,,

idmtools_cli-0.0.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+idmtools = idmtools_cli.main:main

idmtools_cli-0.0.3.dist-info/licenses/LICENSE.TXT

@@ -0,0 +1,3 @@
+idmtools is licensed under the Creative Commons Attribution-Noncommercial-ShareAlike 4.0 License.
+
+To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode

idmtools_cli-0.0.0.dev0.dist-info/METADATA

@@ -1,41 +0,0 @@
-Metadata-Version: 2.4
-Name: idmtools-cli
-Version: 0.0.0.dev0
-Summary: Placeholder package for idmtools-cli - reserved for future use
-Author-email: IDM <idmtools@idmod.org>
-License: Proprietary
-Project-URL: Homepage, https://github.com/InstituteforDiseaseModeling/idmtools
-Project-URL: Bug Tracker, https://github.com/InstituteforDiseaseModeling/idmtools/issues
-Keywords: placeholder,reserved,idmtools
-Classifier: Development Status :: 1 - Planning
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-
-# idmtools-cli
-
-**PLACEHOLDER PACKAGE - NOT FOR USE**
-
-This package is a placeholder to reserve the name `idmtools-cli` on PyPI.
-
-The actual package implementation will be released in the future.
-
-## Purpose
-
-This placeholder ensures the package name is reserved and prevents name squatting.
-
-## Status
-
-This is version 0.0.0.dev0 - a minimal placeholder release.
-
-## Future Release
-
-The full implementation of idmtools-cli will be published when ready.
-
-For more information, visit: https://github.com/InstituteforDiseaseModeling/idmtools

idmtools_cli-0.0.0.dev0.dist-info/RECORD

@@ -1,5 +0,0 @@
-idmtools_cli/__init__.py,sha256=oC5LxDoe7FrQgNwAtQoenj9Ne-g6RXWsNDXtbwCRo1U,183
-idmtools_cli-0.0.0.dev0.dist-info/METADATA,sha256=9qqO8VWY7W4fY4ZKhEBqYSF8AdlShoZb6fPdO7HdiDU,1438
-idmtools_cli-0.0.0.dev0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-idmtools_cli-0.0.0.dev0.dist-info/top_level.txt,sha256=x73U8RzbjKObflWrJtj_wQxw0rkmUv3BgNuQHt1wyAE,13
-idmtools_cli-0.0.0.dev0.dist-info/RECORD,,