materials-commons-cli 2.1.1__tar.gz → 2.1.3__tar.gz

{materials_commons-cli-2.1.1 → materials_commons_cli-2.1.3}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
-Name: materials_commons-cli
-Version: 2.1.1
+Name: materials_commons_cli
+Version: 2.1.3
 Summary: Materials Commons CLI
 Home-page: https://materials-commons.github.io/materials-commons-cli/html/index.html
 Author: Materials Commons development team
-Author-email: materials-commons-authors@umich.edu
+Author-email: materials-commons-help@umich.edu
 License: MIT
 Keywords: materials science mc materials-commons prisms
+Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
@@ -21,3 +22,4 @@ This package contains the materials_commons.cli module. This module is an interf
     Commons web site, https://materialscommons.org/, or a similar site based on the
     Materials Commons code (https://github.com/materials-commons/materialscommons), and intend to use these
     tools in that context.
+

materials_commons_cli-2.1.3/materials_commons/cli/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.1.3'

materials_commons_cli-2.1.3/materials_commons/cli/parser.py

@@ -0,0 +1,185 @@
+import argparse
+import json
+import os
+import sys
+from datetime import datetime, timedelta
+from io import StringIO
+
+import materials_commons.api as mcapi
+import pkg_resources
+import requests
+
+import materials_commons.cli.functions as clifuncs
+from materials_commons.cli.exceptions import MCCLIException, MissingRemoteException, \
+	MultipleRemoteException, NoDefaultRemoteException
+from materials_commons.cli.subcommands.clone import clone_subcommand
+from materials_commons.cli.subcommands.config import config_subcommand
+from materials_commons.cli.subcommands.dataset import DatasetSubcommand
+from materials_commons.cli.subcommands.down import down_subcommand
+from materials_commons.cli.subcommands.expt import ExptSubcommand
+from materials_commons.cli.subcommands.fetch import fetch_subcommand
+# from materials_commons.cli.subcommands.samp import SampSubcommand
+from materials_commons.cli.subcommands.globus import globus_subcommand
+from materials_commons.cli.subcommands.init import init_subcommand
+from materials_commons.cli.subcommands.ls import ls_subcommand
+from materials_commons.cli.subcommands.mkdir import mkdir_subcommand
+from materials_commons.cli.subcommands.mv import mv_subcommand
+# from materials_commons.cli.subcommands.proc import ProcSubcommand
+from materials_commons.cli.subcommands.proj import ProjSubcommand
+from materials_commons.cli.subcommands.remote import remote_subcommand
+from materials_commons.cli.subcommands.rm import rm_subcommand
+from materials_commons.cli.subcommands.up import up_subcommand
+from materials_commons.cli.subcommands.versions import versions_subcommand
+from materials_commons.cli.user_config import Config
+
+standard_usage = [
+	{'name': 'remote', 'desc': 'List servers', 'subcommand': remote_subcommand},
+	{'name': 'proj', 'desc': 'List projects', 'subcommand': ProjSubcommand()},
+	{'name': 'dataset', 'desc': 'List datasets', 'subcommand': DatasetSubcommand()},
+	{'name': 'expt', 'desc': 'List experiments', 'subcommand': ExptSubcommand()},
+	{'name': 'init', 'desc': 'Initialize a new project', 'subcommand': init_subcommand},
+	{'name': 'clone', 'desc': 'Clone an existing project', 'subcommand': clone_subcommand},
+	{'name': 'ls', 'desc': 'List directory contents', 'subcommand': ls_subcommand},
+	{'name': 'mkdir', 'desc': 'Make directories', 'subcommand': mkdir_subcommand},
+	{'name': 'rm', 'desc': 'Remove files and directories', 'subcommand': rm_subcommand},
+	{'name': 'mv', 'desc': 'Move files', 'subcommand': mv_subcommand},
+	{'name': 'fetch', 'desc': 'Remote data fetching and configuration', 'subcommand': fetch_subcommand},
+	{'name': 'up', 'desc': 'Upload files', 'subcommand': up_subcommand},
+	{'name': 'down', 'desc': 'Download files', 'subcommand': down_subcommand},
+	{'name': 'globus', 'desc': 'Manage Globus uploads and downloads', 'subcommand': globus_subcommand},
+	{'name': 'versions', 'desc': 'List file versions', 'subcommand': versions_subcommand},
+	# {'name': 'proc', 'desc': 'List processes', 'subcommand': ProcSubcommand()},
+	# {'name': 'samp', 'desc': 'List samples', 'subcommand': SampSubcommand()},
+	{'name': 'config', 'desc': 'Configure `mc`', 'subcommand': config_subcommand}
+]
+standard_interfaces = {d['name']: d for d in standard_usage}
+
+
+def make_parser():
+	usage_help = StringIO()
+	usage_help.write("mc <command> [<args>]\n\n")
+	usage_help.write("The standard mc commands are:\n")
+
+	for name, interface in standard_interfaces.items():
+		usage_help.write("  {:10} {:40}\n".format(name, interface['desc']))
+
+	parser = argparse.ArgumentParser(
+		description='Materials Commons command line interface',
+		usage=usage_help.getvalue())
+	parser.add_argument('command', help='Subcommand to run')
+
+	return parser
+
+
+CLI_VERSION_CACHE_FILE = os.path.expanduser('~/.materialscommons/.cli-version-cache.json')
+
+
+def should_check_version():
+	try:
+		if os.path.exists(CLI_VERSION_CACHE_FILE):
+			with open(CLI_VERSION_CACHE_FILE) as f:
+				cache = json.load(f)
+			last_check = datetime.fromisoformat(cache['last_check'])
+			# Only check once per day
+			if datetime.now() - last_check < timedelta(days=1):
+				return False
+	except Exception:
+		pass
+	return True
+
+
+def update_version_cache():
+	try:
+		with open(CLI_VERSION_CACHE_FILE, 'w') as f:
+			json.dump({
+				'last_check': datetime.now().isoformat()
+			}, f)
+	except Exception:
+		pass
+
+
+def check_package_version():
+	if not should_check_version():
+		return
+
+	package_name = 'materials-commons-cli'
+	try:
+		current_version = pkg_resources.get_distribution(package_name).version
+		response = requests.get(f"https://pypi.org/pypi/{package_name}/json")
+		latest_version = response.json()["info"]["version"]
+
+		if current_version != latest_version:
+			print(
+				f"\nWarning: You are using an older version of the Materials Commons CLI ({current_version}).\n"
+				f"A newer version is available ({latest_version}).\n"
+				f"It is recommended you upgrade to the newest version: pip install --upgrade {package_name}\n",
+				file=sys.stderr,
+			)
+
+		update_version_cache()
+
+	except Exception as e:
+		pass
+
+
+def main(argv=None, working_dir=None):
+	if argv is None:
+		argv = sys.argv
+	if working_dir is None:
+		working_dir = os.getcwd()
+	try:
+
+		config = Config()
+		if config.REST_logging:
+			mcapi.Client.set_debug_on()
+			pass
+
+		parser = make_parser()
+
+		if len(argv) < 2:
+			parser.print_help()
+			return 1
+
+		# parse_args defaults to [1:] for args, but you need to
+		# exclude the rest of the args too, or validation will fail
+		args = parser.parse_args(argv[1:2])
+
+		if args.command in standard_interfaces:
+			result = standard_interfaces[args.command]['subcommand'](argv[2:], working_dir)
+			check_package_version()
+			return result
+
+		else:
+			print('Unrecognized command')
+			parser.print_help()
+			return 1
+
+	except MissingRemoteException as e:
+		print("Error:", e)
+		clifuncs.print_remote_help()
+		return 1
+
+	except MultipleRemoteException as e:
+		print("Error:", e)
+		print(
+			'** Please edit .mc/config.json to include `"remote":{"mcurl": "Materials Commons https address here","email": "YOUR_EMAIL_HERE"}` **')
+		return 1
+
+	except NoDefaultRemoteException as e:
+		print("Error:", e)
+		print("Set the default remote with:")
+		print("    mc remote --set-default EMAIL URL")
+		clifuncs.print_remote_help()
+		return 1
+
+	except MCCLIException as e:
+		print("CLI Error:", e)
+		return 1
+
+	except mcapi.MCAPIError as e:
+		import json
+		print("API Error:", e)
+		print("Writing error message to 'mcapi_error.json'")
+		with open('mcapi_error.json', 'w') as f:
+			json.dump(e.response.json(), f, indent=2)
+		return 1

{materials_commons-cli-2.1.1 → materials_commons_cli-2.1.3}/materials_commons/cli/subcommands/remote.py

@@ -21,8 +21,9 @@ def make_parser():
 
     parser.add_argument('-l', '--list', action="store_true", default=False,  help='List known remote urls.')
     parser.add_argument('--show-apikey', action="store_true", default=False,  help='Show apikey.')
-    parser.add_argument('--add', nargs=2, metavar=('EMAIL', 'URL'), help='Add a new remote.')
-    parser.add_argument('--remove', nargs=2, metavar=('EMAIL', 'URL'), help='Remove a remote from the list.')
+    parser.add_argument('--add', nargs=1, metavar=('EMAIL'), help='Add a new remote. Defaults to URL https://materialscommons.org/api. Use --url to specify a different URL.')
+    parser.add_argument('--remove', nargs=1, metavar=('EMAIL'), help='Remove a remote from the list. Defaults to URL https://materialscommons.org/api. Use --url to specify a different URL.')
+    parser.add_argument('--url', default='https://materialscommons.org/api', help='Remote server API URL (default: https://materialscommons.org/api)')
     parser.add_argument('--set-default', nargs=2, metavar=('EMAIL', 'URL'), help='Set default remote to be used when not in a project.')
     return parser
 
@@ -46,7 +47,7 @@ def remote_subcommand(argv, working_dir):
 
     elif args.add:
         email = args.add[0]
-        url = args.add[1]
+        url = args.url
 
         config = Config()
         remote_config = RemoteConfig(mcurl=url, email=email)
@@ -71,12 +72,14 @@ def remote_subcommand(argv, working_dir):
 
         config.remotes.append(remote_config)
         config.save()
+        if url == 'https://materialscommons.org/api':
+            set_default_remote(email, url)
         print("Added " + email + " at " + url)
 
 
     elif args.remove:
         email = args.remove[0]
-        url = args.remove[1]
+        url = args.url
 
         config = Config()
         remote_config = RemoteConfig(mcurl=url, email=email)
@@ -91,17 +94,9 @@ def remote_subcommand(argv, working_dir):
     elif args.set_default:
         email = args.set_default[0]
         url = args.set_default[1]
-
-        config = Config()
-        remote_config = RemoteConfig(mcurl=url, email=email)
-
-        if remote_config in config.remotes:
-            config.default_remote = config.remotes[config.remotes.index(remote_config)]
-        else:
-            print("Failed: " + email + " at " + url + " not found.")
-            print_remotes(config.remotes)
-            return 1
-        config.save()
+        rv = set_default_remote(email, url)
+        if rv != 0:
+            return rv
         print("Set default: " + email + " at " + url)
 
     else:
@@ -117,3 +112,16 @@ def remote_subcommand(argv, working_dir):
             return 1
 
     return
+
+def set_default_remote(email, url):
+    config = Config()
+    remote_config = RemoteConfig(mcurl=url, email=email)
+
+    if remote_config in config.remotes:
+        config.default_remote = config.remotes[config.remotes.index(remote_config)]
+    else:
+        print("Failed: " + email + " at " + url + " not found.")
+        print_remotes(config.remotes)
+        return 1
+    config.save()
+    return 0

{materials_commons-cli-2.1.1 → materials_commons_cli-2.1.3}/materials_commons/cli/subcommands/up.py

@@ -29,8 +29,8 @@ def make_parser():
     parser.add_argument('paths', nargs='*', default=None, help='Files or directories')
     parser.add_argument('-r', '--recursive', action="store_true", default=False,
                         help='Upload directory contents recursively')
-    parser.add_argument('--limit', nargs=1, type=float, default=[50],
-                        help='File size upload limit (MB). Default=50MB. Does not apply to Globus uploads.')
+    parser.add_argument('--limit', nargs=1, type=float, default=[250],
+                        help='File size upload limit (MB). Default=250MB. Does not apply to Globus uploads.')
     parser.add_argument('-g', '--globus', action="store_true", default=False,
                         help=globus_help)
     parser.add_argument('--label', nargs=1, type=str,

{materials_commons-cli-2.1.1 → materials_commons_cli-2.1.3}/materials_commons_cli.egg-info/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
 Name: materials-commons-cli
-Version: 2.1.1
+Version: 2.1.3
 Summary: Materials Commons CLI
 Home-page: https://materials-commons.github.io/materials-commons-cli/html/index.html
 Author: Materials Commons development team
-Author-email: materials-commons-authors@umich.edu
+Author-email: materials-commons-help@umich.edu
 License: MIT
 Keywords: materials science mc materials-commons prisms
+Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
@@ -21,3 +22,4 @@ This package contains the materials_commons.cli module. This module is an interf
     Commons web site, https://materialscommons.org/, or a similar site based on the
     Materials Commons code (https://github.com/materials-commons/materialscommons), and intend to use these
     tools in that context.
+

{materials_commons-cli-2.1.1 → materials_commons_cli-2.1.3}/materials_commons_cli.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 mc = materials_commons.cli.parser:main
+

{materials_commons-cli-2.1.1 → materials_commons_cli-2.1.3}/materials_commons_cli.egg-info/requires.txt

@@ -5,5 +5,6 @@ materials-commons-api
 python-dateutil
 pyyaml
 requests
+setuptools
 sortedcontainers
 tabulate

{materials_commons-cli-2.1.1 → materials_commons_cli-2.1.3}/setup.py

@@ -4,7 +4,7 @@ from setuptools import setup, find_namespace_packages
 from materials_commons.cli import __version__
 
 setup(
-    name='materials_commons-cli',
+    name='materials_commons_cli',
     version=__version__,
     description='Materials Commons CLI',
     long_description="""This package contains the materials_commons.cli module. This module is an interface
@@ -14,7 +14,7 @@ setup(
     tools in that context.""",
     url='https://materials-commons.github.io/materials-commons-cli/html/index.html',
     author='Materials Commons development team',
-    author_email='materials-commons-authors@umich.edu',
+    author_email='materials-commons-help@umich.edu',
     license='MIT',
     package_data={
         # If any package contains *.txt or *.rst files, include them:
@@ -56,6 +56,7 @@ setup(
         "python-dateutil",
         "pyyaml",
         "requests",
+        "setuptools",
         "sortedcontainers",
         "tabulate"
     ]

materials_commons-cli-2.1.1/materials_commons/cli/__init__.py

@@ -1 +0,0 @@
-__version__ = '2.1.1'

materials_commons-cli-2.1.1/materials_commons/cli/parser.py

@@ -1,130 +0,0 @@
-import argparse
-import os
-import sys
-from io import StringIO
-
-import materials_commons.api as mcapi
-
-from materials_commons.cli.subcommands.clone import clone_subcommand
-from materials_commons.cli.subcommands.config import config_subcommand
-from materials_commons.cli.subcommands.dataset import DatasetSubcommand
-from materials_commons.cli.subcommands.down import down_subcommand
-from materials_commons.cli.subcommands.expt import ExptSubcommand
-from materials_commons.cli.subcommands.fetch import fetch_subcommand
-from materials_commons.cli.subcommands.init import init_subcommand
-from materials_commons.cli.subcommands.ls import ls_subcommand
-from materials_commons.cli.subcommands.mkdir import mkdir_subcommand
-from materials_commons.cli.subcommands.mv import mv_subcommand
-# from materials_commons.cli.subcommands.proc import ProcSubcommand
-from materials_commons.cli.subcommands.proj import ProjSubcommand
-from materials_commons.cli.subcommands.remote import remote_subcommand
-from materials_commons.cli.subcommands.rm import rm_subcommand
-# from materials_commons.cli.subcommands.samp import SampSubcommand
-from materials_commons.cli.subcommands.globus import globus_subcommand
-from materials_commons.cli.subcommands.up import up_subcommand
-from materials_commons.cli.subcommands.versions import versions_subcommand
-
-import materials_commons.cli.functions as clifuncs
-from materials_commons.cli.user_config import Config
-from materials_commons.cli.exceptions import MCCLIException, MissingRemoteException, \
-    MultipleRemoteException, NoDefaultRemoteException
-
-standard_usage = [
-    {'name': 'remote', 'desc': 'List servers', 'subcommand': remote_subcommand},
-    {'name': 'proj', 'desc': 'List projects', 'subcommand': ProjSubcommand()},
-    {'name': 'dataset', 'desc': 'List datasets', 'subcommand': DatasetSubcommand()},
-    {'name': 'expt', 'desc': 'List experiments', 'subcommand': ExptSubcommand()},
-    {'name': 'init', 'desc': 'Initialize a new project', 'subcommand': init_subcommand},
-    {'name': 'clone', 'desc': 'Clone an existing project', 'subcommand': clone_subcommand},
-    {'name': 'ls', 'desc': 'List directory contents', 'subcommand': ls_subcommand},
-    {'name': 'mkdir', 'desc': 'Make directories', 'subcommand': mkdir_subcommand},
-    {'name': 'rm', 'desc': 'Remove files and directories', 'subcommand': rm_subcommand},
-    {'name': 'mv', 'desc': 'Move files', 'subcommand': mv_subcommand},
-    {'name': 'fetch', 'desc': 'Remote data fetching and configuration', 'subcommand': fetch_subcommand},
-    {'name': 'up', 'desc': 'Upload files', 'subcommand': up_subcommand},
-    {'name': 'down', 'desc': 'Download files', 'subcommand': down_subcommand},
-    {'name': 'globus', 'desc': 'Manage Globus uploads and downloads', 'subcommand': globus_subcommand},
-    {'name': 'versions', 'desc': 'List file versions', 'subcommand': versions_subcommand},
-    # {'name': 'proc', 'desc': 'List processes', 'subcommand': ProcSubcommand()},
-    # {'name': 'samp', 'desc': 'List samples', 'subcommand': SampSubcommand()},
-    {'name': 'config', 'desc': 'Configure `mc`', 'subcommand': config_subcommand}
-]
-standard_interfaces = {d['name']: d for d in standard_usage}
-
-def make_parser():
-
-    usage_help = StringIO()
-    usage_help.write("mc <command> [<args>]\n\n")
-    usage_help.write("The standard mc commands are:\n")
-
-    for name, interface in standard_interfaces.items():
-        usage_help.write("  {:10} {:40}\n".format(name, interface['desc']))
-
-    parser = argparse.ArgumentParser(
-        description='Materials Commons command line interface',
-        usage=usage_help.getvalue())
-    parser.add_argument('command', help='Subcommand to run')
-
-    return parser
-
-
-def main(argv=None, working_dir=None):
-    if argv is None:
-        argv = sys.argv
-    if working_dir is None:
-        working_dir = os.getcwd()
-    try:
-
-        config = Config()
-        if config.REST_logging:
-            mcapi.Client.set_debug_on()
-            pass
-
-        parser = make_parser()
-
-        if len(argv) < 2:
-            parser.print_help()
-            return
-
-        # parse_args defaults to [1:] for args, but you need to
-        # exclude the rest of the args too, or validation will fail
-        args = parser.parse_args(argv[1:2])
-
-        if args.command in standard_interfaces:
-            result = standard_interfaces[args.command]['subcommand'](argv[2:], working_dir)
-            return result
-
-        else:
-            print('Unrecognized command')
-            parser.print_help()
-            return 1
-
-    except MissingRemoteException as e:
-        print("Error:", e)
-        clifuncs.print_remote_help()
-        return 1
-
-    except MultipleRemoteException as e:
-        print("Error:", e)
-        print('** Please edit .mc/config.json to include `"remote":{"mcurl": "' + data['remote_url']
-            + '", "email": "YOUR_EMAIL_HERE"}` **')
-        return 1
-
-    except NoDefaultRemoteException as e:
-        print("Error:", e)
-        print("Set the default remote with:")
-        print("    mc remote --set-default EMAIL URL")
-        clifuncs.print_remote_help()
-        return 1
-
-    except MCCLIException as e:
-        print("CLI Error:", e)
-        return 1
-
-    except mcapi.MCAPIError as e:
-        import json
-        print("API Error:", e)
-        print("Writing error message to 'mcapi_error.json'")
-        with open('mcapi_error.json', 'w') as f:
-            json.dump(e.response.json(), f, indent=2)
-        return 1