meerschaum 2.9.5__py3-none-any.whl → 3.0.0__py3-none-any.whl

meerschaum/actions/api.py

@@ -6,7 +6,10 @@ Start the Meerschaum WebAPI with the `api` action.
 """
 
 from __future__ import annotations
+
 import os
+
+import meerschaum as mrsm
 from meerschaum.utils.typing import SuccessTuple, Optional, List, Any
 
 
@@ -93,9 +96,11 @@ def _api_start(
     action: Optional[List[str]] = None,
     host: Optional[str] = None,
     port: Optional[int] = None,
+    webterm_port: Optional[int] = None,
     workers: Optional[int] = None,
     mrsm_instance: Optional[str] = None,
     no_dash: bool = False,
+    no_webterm: bool = False,
     no_auth: bool = False,
     private: bool = False,
     secure: bool = False,
@@ -118,6 +123,10 @@ def _api_start(
         The address to bind to.
         If `None`, use '0.0.0.0'.
 
+    webterm_port: Optional[int], default None
+        Port to bind the webterm server to.
+        If `None`, use 8765.
+
     workers: Optional[int], default None
         How many worker threads to run.
         If `None`, defaults to the number of CPU cores or 1 on Android.
@@ -148,8 +157,6 @@ def _api_start(
 
     from meerschaum.utils.packages import (
         attempt_import,
-        venv_contains_package,
-        pip_install,
         run_python_package,
     )
     from meerschaum.utils.misc import is_int, filter_keywords
@@ -163,10 +170,11 @@ def _api_start(
         API_UVICORN_CONFIG_PATH,
         CACHE_RESOURCES_PATH,
         PACKAGE_ROOT_PATH,
+        ROOT_DIR_PATH,
     )
     from meerschaum.config._patch import apply_patch_to_config
-    from meerschaum.config._environment import get_env_vars
-    from meerschaum.config.static import STATIC_CONFIG, SERVER_ID
+    from meerschaum.config.environment import get_env_vars
+    from meerschaum._internal.static import STATIC_CONFIG, SERVER_ID
     from meerschaum.connectors.parse import parse_instance_keys
     from meerschaum.utils.pool import get_pool
 
@@ -186,9 +194,9 @@ def _api_start(
     uvicorn_config_path = API_UVICORN_RESOURCES_PATH / SERVER_ID / 'config.json'
     uvicorn_env_path = API_UVICORN_RESOURCES_PATH / SERVER_ID / 'uvicorn.env'
 
-    api_config = deepcopy(get_config('system', 'api'))
+    api_config = deepcopy(get_config('api'))
     cf = _config()
-    forwarded_allow_ips = get_config('system', 'api', 'uvicorn', 'forwarded_allow_ips')
+    forwarded_allow_ips = get_config('api', 'uvicorn', 'forwarded_allow_ips')
     uvicorn_config = api_config['uvicorn']
     if port is None:
         ### default
@@ -222,7 +230,7 @@ def _api_start(
     instance_connector = parse_instance_keys(mrsm_instance, debug=debug)
     if instance_connector.type == 'api' and instance_connector.protocol != 'https':
         allow_http_parent = get_config(
-            'system', 'api', 'permissions', 'chaining', 'insecure_parent_instance'
+            'api', 'permissions', 'chaining', 'insecure_parent_instance'
         )
         if not allow_http_parent:
             return False, (
@@ -232,7 +240,7 @@ def _api_start(
                 f"  - Ensure that '{instance_connector}' is available over HTTPS, " +
                 "and with `edit config`,\n" +
                 f"    change the `protocol` for '{instance_connector}' to 'https'.\n\n" +
-                "  - Run `edit config system` and search for `permissions`.\n" +
+                "  - Run `edit config api` and search for `permissions`.\n" +
                 "    Under `api:permissions:chaining`, change the value of " +
                 "`insecure_parent_instance` to `true`,\n" +
                 "    then restart the API process."
@@ -243,7 +251,9 @@ def _api_start(
         'host': host,
         'env_file': str(uvicorn_env_path.as_posix()),
         'mrsm_instance': mrsm_instance,
+        'webterm_port': webterm_port,
         'no_dash': no_dash,
+        'no_webterm': no_webterm or no_auth,
         'no_auth': no_auth,
         'private': private,
         'production': production,
@@ -259,11 +269,33 @@ def _api_start(
     uvicorn_config['use_colors'] = (not nopretty) if nopretty else ANSI
 
     api_config['uvicorn'] = uvicorn_config
-    cf['system']['api']['uvicorn'] = uvicorn_config
+    cf['api']['uvicorn'] = uvicorn_config
     if secure:
-        cf['system']['api']['permissions']['actions']['non_admin'] = False
+        cf['api']['permissions']['actions']['non_admin'] = False
+
+    if not uvicorn_config['no_webterm']:
+        from meerschaum._internal.term.tools import is_webterm_running
+        if webterm_port is None:
+            webterm_port = int(mrsm.get_config('api', 'webterm', 'port'))
+        if is_webterm_running(port=webterm_port):
+            return (
+                False,
+                (
+                    f"Webterm is running on port {webterm_port}. "
+                    "Start the API again with `--webterm-port`."
+                )
+            )
 
-    custom_keys = ['mrsm_instance', 'no_dash', 'no_auth', 'private', 'debug', 'production']
+    custom_keys = [
+        'mrsm_instance',
+        'no_dash',
+        'no_webterm',
+        'no_auth',
+        'private',
+        'debug',
+        'production',
+        'webterm_port',
+    ]
 
     ### write config to a temporary file to communicate with uvicorn threads
     try:
@@ -289,6 +321,7 @@ def _api_start(
         MRSM_SERVER_ID: SERVER_ID,
         MRSM_RUNTIME: 'api',
         MRSM_CONFIG: json.loads(os.environ.get(MRSM_CONFIG, '{}')),
+        MRSM_ROOT_DIR: ROOT_DIR_PATH.as_posix(),
         'FORWARDED_ALLOW_IPS': forwarded_allow_ips,
         'TERM': os.environ.get('TERM', 'screen-256color'),
         'SHELL': os.environ.get('SHELL', '/bin/bash'),
@@ -302,6 +335,8 @@ def _api_start(
             )
         ),
         'HOSTNAME': os.environ.get('HOSTNAME', 'api'),
+        'XDG_RUNTIME_DIR': os.environ.get('XDG_RUNTIME_DIR', ''),
+        'DBUS_SESSION_BUS_ADDRESS': os.environ.get('DBUS_SESSION_BUS_ADDRESS', ''),
     })
     for env_var in get_env_vars():
         if env_var in env_dict:
@@ -316,10 +351,10 @@ def _api_start(
     env_text = ''
     for key, val in env_dict.items():
         value = str(
-            json.dumps(val, default=json_serialize_value)
+            json.dumps(val, default=json_serialize_value, separators=(',', ':'))
             if isinstance(val, (dict))
             else val
-        ).replace('\\', '\\\\').replace("'", "'\\''")
+        ).replace('\\', '\\\\').replace("'", "\\'")
         env_text += f"{key}='{value}'\n"
     with open(uvicorn_env_path, 'w+', encoding='utf-8') as f:
         if debug:
@@ -384,11 +419,16 @@ def _api_start(
         except KeyboardInterrupt:
             pass
 
+    old_stdin = sys.stdin
+    sys.stdin = None
+
     if production:
         _run_gunicorn()
     else:
         _run_uvicorn()
 
+    sys.stdin = old_stdin
+
     ### Cleanup
     if uvicorn_config_path.parent.exists():
         shutil.rmtree(uvicorn_config_path.parent)

meerschaum/actions/attach.py

@@ -9,6 +9,7 @@ Attach to running jobs.
 import meerschaum as mrsm
 from meerschaum.utils.typing import Optional, List, Any, SuccessTuple
 
+
 def attach(
     action: Optional[List[str]] = None,
     executor_keys: Optional[str] = None,

meerschaum/actions/bootstrap.py

@@ -10,7 +10,7 @@ Functions for bootstrapping elements
 from __future__ import annotations
 
 import meerschaum as mrsm
-from meerschaum.utils.typing import Union, Any, Sequence, SuccessTuple, Optional, Tuple, List
+from meerschaum.utils.typing import Union, Any, SuccessTuple, Optional, Tuple, List
 
 
 def bootstrap(
@@ -249,7 +249,7 @@ def _bootstrap_connectors(
     from meerschaum.config._edit import write_config
     from meerschaum.utils.formatting import pprint
     from meerschaum.utils.formatting._shell import clear_screen
-    from meerschaum.connectors import attributes as connector_attributes
+    from meerschaum.config._default import CONNECTOR_ATTRIBUTES
     from meerschaum.utils.warnings import warn, info
     from meerschaum.utils.misc import is_int
 
@@ -314,7 +314,7 @@ def _bootstrap_connectors(
     cls_required_attrs = getattr(cls, 'REQUIRED_ATTRIBUTES', [])
     cls_optional_attrs = getattr(cls, 'OPTIONAL_ATTRIBUTES', [])
     cls_default_attrs = getattr(cls, 'DEFAULT_ATTRIBUTES', {})
-    type_attributes = connector_attributes.get(
+    type_attributes = CONNECTOR_ATTRIBUTES.get(
         _type,
         {
             'required': cls_required_attrs,
@@ -330,16 +330,16 @@ def _bootstrap_connectors(
                 f"Flavor for connector '{_type}:{_label}':",
                 sorted(list(type_attributes['flavors'])),
                 default = (
-                    'timescaledb'
-                    if 'timescaledb' in type_attributes['flavors']
+                    'postgresql'
+                    if 'postgresql' in type_attributes['flavors']
                     else None
                 )
             )
         except KeyboardInterrupt:
             return abort_tuple
         new_attributes['flavor'] = flavor
-        required = sorted(list(connector_attributes[_type]['flavors'][flavor]['requirements']))
-        optional = sorted(list(connector_attributes[_type]['flavors'][flavor].get('optional', {})))
+        required = sorted(list(CONNECTOR_ATTRIBUTES[_type]['flavors'][flavor]['requirements']))
+        optional = sorted(list(CONNECTOR_ATTRIBUTES[_type]['flavors'][flavor].get('optional', {})))
         default = type_attributes['flavors'][flavor].get('defaults', {})
     else:
         required = sorted(list(type_attributes.get('required', {})))
@@ -429,7 +429,7 @@ def _bootstrap_plugins(
         action = [prompt("Enter the name of your new plugin:")]
 
     for plugin_name in action:
-        bootstrap_success, bootstrap_msg = bootstrap_plugin(plugin_name)
+        bootstrap_success, bootstrap_msg = bootstrap_plugin(plugin_name, debug=debug)
         if not bootstrap_success:
             return bootstrap_success, bootstrap_msg
 

meerschaum/actions/delete.py

@@ -18,7 +18,7 @@ def delete(
     Delete an element.
 
     Command:
-        `delete {config, pipes, plugins, users, connectors, jobs}`
+        `delete {config, pipes, plugins, users, connectors, jobs, venvs}`
 
     """
     from meerschaum.actions import choose_subaction
@@ -159,7 +159,9 @@ def _delete_config(
         answer = yes_no(
             "Are you sure you want to delete the following configuration files?" +
             f"{sep + sep.join([str(p) for p in paths])}\n",
-            default='n', noask=noask, yes=yes
+            default='n',
+            noask=noask,
+            yes=yes,
         )
 
     if answer or force:

meerschaum/actions/edit.py

@@ -27,6 +27,7 @@ def edit(
         'users'     : _edit_users,
         'plugins'   : _edit_plugins,
         'jobs'      : _edit_jobs,
+        'tokens'    : _edit_tokens,
     }
     return choose_subaction(action, options, **kw)
 
@@ -66,7 +67,12 @@ def _complete_edit(
     return default_action_completer(action=(['edit'] + action), **kw)
 
 
-def _edit_config(action: Optional[List[str]] = None, **kw : Any) -> SuccessTuple:
+def _edit_config(
+    action: Optional[List[str]] = None,
+    noask: bool = False,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Edit Meerschaum configuration files.
 
@@ -86,11 +92,26 @@ def _edit_config(action: Optional[List[str]] = None, **kw : Any) -> SuccessTuple
         ```
     """
     from meerschaum.config._edit import edit_config
-    if action is None:
-        action = []
-    if len(action) == 0:
-        action.append('meerschaum')
-    return edit_config(keys=action, **kw)
+    from meerschaum.config._read_config import get_possible_keys
+    from meerschaum.actions import actions
+    from meerschaum.utils.prompt import choose
+
+    if not action:
+        action = [
+            choose(
+                "Choose a configuration file to edit:",
+                get_possible_keys(),
+                default='meerschaum',
+                noask=noask,
+            )
+        ]
+
+    edit_success, edit_msg = edit_config(keys=action, debug=debug, **kwargs)
+    if not edit_success:
+        return edit_success, edit_msg
+
+    return actions['reload'](debug=debug)
+
 
 def _complete_edit_config(action: Optional[List[str]] = None, **kw: Any) -> List[str]:
     from meerschaum.config._read_config import get_possible_keys
@@ -104,14 +125,14 @@ def _complete_edit_config(action: Optional[List[str]] = None, **kw: Any) -> List
     return possibilities
 
 def _edit_pipes(
-        action: Optional[List[str]] = None,
-        params: Optional[Dict[str, Any]] = None,
-        yes: bool = False,
-        force: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    params: Optional[Dict[str, Any]] = None,
+    yes: bool = False,
+    force: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Open and edit pipes' configuration files.
     
@@ -218,7 +239,7 @@ def _edit_users(
     from meerschaum.utils.prompt import prompt, yes_no, get_password, get_email
     from meerschaum.utils.misc import edit_file
     from meerschaum.config._paths import USERS_CACHE_RESOURCES_PATH
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     from meerschaum.utils.yaml import yaml
     import os, pathlib
     instance_connector = parse_instance_keys(mrsm_instance)
@@ -235,7 +256,7 @@ def _edit_users(
                 minimum_length = STATIC_CONFIG['users']['min_password_length'],
             )
 
-        ## Make an admin
+        ### Make an admin
         _type = ''
         if yes_no(f"Change the user type for user '{username}'?", default='n', yes=yes, noask=noask):
             is_admin = yes_no(
@@ -248,15 +269,34 @@ def _edit_users(
         if yes_no(f"Change the email for user '{username}'?", default='n', yes=yes, noask=noask):
             email = get_email(username)
 
+        attributes = {}
+        ### Change the scopes.
+        attributes['scopes'] = prompt(
+            f"Scopes for user '{username}' (`*` to grant all scopes):",
+            default_editable=' '.join(User(
+                username,
+                instance=instance_connector,
+            ).get_scopes(refresh=True, debug=debug)),
+        ).split()
+        if attributes['scopes'] == ['*']:
+            attributes['scopes'] = list(STATIC_CONFIG['tokens']['scopes'])
+
         ### Change the attributes
-        attributes = None
         if yes_no(
-                f"Edit the attributes YAML file for user '{username}'?",
-                default='n', yes=yes, noask=noask
+            f"Edit the attributes YAML file for user '{username}'?",
+            default='n',
+            yes=yes,
+            noask=noask,
         ):
             attr_path = pathlib.Path(os.path.join(USERS_CACHE_RESOURCES_PATH, f'{username}.yaml'))
             try:
-                existing_attrs = instance_connector.get_user_attributes(User(username), debug=debug)
+                existing_attrs = instance_connector.get_user_attributes(
+                    User(
+                        username,
+                        instance=instance_connector,
+                    ),
+                    debug=debug,
+                )
                 with open(attr_path, 'w+') as f:
                     yaml.dump(existing_attrs, stream=f, sort_keys=False)
                 edit_file(attr_path)
@@ -271,7 +311,14 @@ def _edit_users(
                 attributes = None
 
         ### Submit changes
-        return User(username, password, email=email, type=_type, attributes=attributes)
+        return User(
+            username,
+            password,
+            email=email,
+            type=_type,
+            attributes=attributes,
+            instance=instance_connector,
+        )
 
     if not action:
         return False, "No users to edit."
@@ -301,14 +348,14 @@ def _edit_users(
         f"    ({succeeded} succeeded, {failed} failed)."
     )
     info(msg)
-    return True, msg
+    return succeeded > 0, msg
 
 
 def _edit_plugins(
     action: Optional[List[str]] = None,
     debug: bool = False,
     **kwargs: Any
-):
+) -> mrsm.SuccessTuple:
     """
     Edit a plugin's source code.
     """
@@ -316,7 +363,6 @@ def _edit_plugins(
     from meerschaum.utils.warnings import warn
     from meerschaum.utils.prompt import prompt, yes_no
     from meerschaum.utils.misc import edit_file
-    from meerschaum.utils.packages import reload_meerschaum
     from meerschaum.actions import actions
 
     if not action:
@@ -349,7 +395,7 @@ def _edit_plugins(
             continue
 
         edit_file(plugin_file_path)
-        reload_meerschaum(debug=debug)
+        actions['reload'](debug=debug)
 
     return True, "Success"
 
@@ -507,6 +553,106 @@ def _edit_jobs(
     return True, msg
 
 
+def _edit_tokens(
+    action: Optional[List[str]] = None,
+    mrsm_instance: Optional[str] = None,
+    debug: bool = False,
+) -> mrsm.SuccessTuple:
+    """
+    Edit tokens registered to an instance.
+    """
+    import uuid
+    from meerschaum.utils.warnings import warn
+    from meerschaum.utils.misc import is_uuid
+    from meerschaum.core import Token
+    from meerschaum.connectors.parse import parse_instance_keys
+    from meerschaum.utils.prompt import prompt, yes_no
+    from meerschaum._internal.static import STATIC_CONFIG
+    dateutil_parser = mrsm.attempt_import('dateutil.parser')
+
+    if not action:
+        return (
+            False, (
+                "Provide token labels or IDs for the tokens to edit\n"
+                "    (run `show tokens` to see registered tokens)."
+            )
+        )
+
+    conn = parse_instance_keys(mrsm_instance)
+
+    labels = [
+        label
+        for label in (action or [])
+        if not is_uuid(label)
+    ]
+    potential_token_ids = [
+        uuid.UUID(potential_id)
+        for potential_id in (action or [])
+        if is_uuid(potential_id)
+    ]
+
+    tokens = conn.get_tokens(
+        labels=(labels or None),
+        ids=(potential_token_ids or None),
+        debug=debug,
+    )
+
+    num_edited = 0
+    for token in tokens:
+        token_model = token.to_model(refresh=True)
+        if token_model is None:
+            warn(f"Token '{token.id}' does not exist.", stack=False)
+            continue
+
+        new_attrs = {}
+
+        new_attrs['label'] = prompt("Label:", default_editable=token_model.label)
+        new_expiration_str = prompt(
+            "Expiration (empty for no expiration):",
+            default_editable=('' if token.expiration is None else str(token_model.expiration)),
+        )
+        new_attrs['expiration'] = (
+            dateutil_parser.parse(new_expiration_str)
+            if new_expiration_str
+            else None
+        )
+        new_scopes_str = prompt(
+            "Scope (`*` to grant all permissions):",
+            default_editable=' '.join(token_model.scopes),
+        )
+        new_attrs['scopes'] = (
+            new_scopes_str.split(' ')
+            if new_scopes_str != '*'
+            else list(STATIC_CONFIG['tokens']['scopes'])
+        )
+        invalidate = (
+            yes_no("Do you want to invalidate this token?", default='n')
+            if token_model.is_valid
+            else True
+        )
+        new_attrs['is_valid'] = token_model.is_valid and not invalidate
+
+        new_token = Token(**{**dict(token_model), **new_attrs})
+        edit_success, edit_msg = new_token.edit(debug=debug)
+        if not edit_success:
+            return False, edit_msg
+
+        if invalidate:
+            invalidate_success, invalidate_msg = new_token.invalidate(debug=debug)
+            if not invalidate_success:
+                return False, invalidate_msg
+
+        num_edited += 1
+
+    msg = (
+        f"Successfully edited {num_edited} token"
+        + ('s' if num_edited != 1 else '')
+        + '.'
+    )
+
+    return True, msg
+
+
 ### NOTE: This must be the final statement of the module.
 ###       Any subactions added below these lines will not
 ###       be added to the `help` docstring.

meerschaum/actions/login.py

@@ -10,13 +10,13 @@ from __future__ import annotations
 from meerschaum.utils.typing import SuccessTuple, Optional, List, Any
 
 def login(
-        action: Optional[List[str]] = None,
-        connector_keys: Optional[List[str]] = None,
-        yes: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    connector_keys: Optional[List[str]] = None,
+    yes: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Log into a Meerschaum API instance.
     """
@@ -56,7 +56,7 @@ def login(
     for k in _keys:
         try:
             _connectors.append(parse_instance_keys(k))
-        except Exception as e:
+        except Exception:
             warn(f"Unable to build connector '{k}'. Is it registered?", stack=False)
 
     meerschaum_config = get_config('meerschaum')