meerschaum 2.2.5.dev3__py3-none-any.whl → 2.2.7__py3-none-any.whl

meerschaum/config/_paths.py

@@ -34,12 +34,29 @@ if ENVIRONMENT_ROOT_DIR in os.environ:
             f"Invalid root directory '{str(_ROOT_DIR_PATH)}' set for " +
             f"environment variable '{ENVIRONMENT_ROOT_DIR}'.\n" +
             f"Please enter a valid path for {ENVIRONMENT_ROOT_DIR}.",
-            file = sys.stderr,
+            file=sys.stderr,
         )
         sys.exit(1)
 else:
     _ROOT_DIR_PATH = DEFAULT_ROOT_DIR_PATH
 
+
+ENVIRONMENT_CONFIG_DIR = STATIC_CONFIG['environment']['config_dir']
+if ENVIRONMENT_CONFIG_DIR in os.environ:
+    _CONFIG_DIR_PATH = Path(os.environ[ENVIRONMENT_CONFIG_DIR]).resolve()
+    if not _CONFIG_DIR_PATH.exists():
+        print(
+            (
+                f"Invalid configuration directory '{_CONFIG_DIR_PATH}' set"
+                + f" for environment variable '{ENVIRONMENT_CONFIG_DIR}'\n"
+                + f"Please enter a valid path for {ENVIRONMENT_CONFIG_DIR}."
+            ),
+            file=sys.stderr,
+        )
+        sys.exit(1)
+else:
+    _CONFIG_DIR_PATH = _ROOT_DIR_PATH / 'config'
+
 ENVIRONMENT_PLUGINS_DIR = STATIC_CONFIG['environment']['plugins']
 if ENVIRONMENT_PLUGINS_DIR in os.environ:
     try:
@@ -100,12 +117,16 @@ paths = {
     'PACKAGE_ROOT_PATH'              : Path(__file__).parent.parent.resolve().as_posix(),
     'ROOT_DIR_PATH'                  : _ROOT_DIR_PATH.as_posix(),
     'VIRTENV_RESOURCES_PATH'         : _VENVS_DIR_PATH.as_posix(),
-    'CONFIG_DIR_PATH'                : ('{ROOT_DIR_PATH}', 'config'),
+    'CONFIG_DIR_PATH'                : _CONFIG_DIR_PATH.as_posix(),
     'DEFAULT_CONFIG_DIR_PATH'        : ('{ROOT_DIR_PATH}', 'default_config'),
     'PATCH_DIR_PATH'                 : ('{ROOT_DIR_PATH}', 'patch_config'),
     'PERMANENT_PATCH_DIR_PATH'       : ('{ROOT_DIR_PATH}', 'permanent_patch_config'),
     'INTERNAL_RESOURCES_PATH'        : ('{ROOT_DIR_PATH}', '.internal'),
 
+    'UPDATES_RESOURCES_PATH'         : ('{INTERNAL_RESOURCES_PATH}', 'updates'),
+    'UPDATES_CACHE_PATH'             : ('{UPDATES_RESOURCES_PATH}', 'cache.json'),
+    'UPDATES_LOCK_PATH'              : ('{UPDATES_RESOURCES_PATH}', '.updates.lock'),
+
     'STACK_RESOURCES_PATH'           : ('{ROOT_DIR_PATH}', 'stack'),
     'STACK_COMPOSE_FILENAME'         : 'docker-compose.yaml',
     'STACK_COMPOSE_PATH'             : ('{STACK_RESOURCES_PATH}', '{STACK_COMPOSE_FILENAME}'),
@@ -168,6 +189,7 @@ def set_root(root: Union[Path, str]):
         if isinstance(path_parts, tuple) and path_parts[0] == '{ROOT_DIR_PATH}':
             globals()[path_name] = __getattr__(path_name)
 
+
 def __getattr__(name: str) -> Path:
     if name not in paths:
         if name not in globals():

meerschaum/config/_shell.py

@@ -6,127 +6,139 @@
 Default configuration for the Meerschaum shell.
 """
 
-#  import platform
-#  default_cmd = 'cmd' if platform.system() != 'Windows' else 'cmd2'
 default_cmd = 'cmd'
 
 default_shell_config = {
-    'ansi'             : {
-        'intro'        : {
-            'rich'     : {
-                'style' : "bold bright_blue",
+    'ansi'               : {
+        'intro'          : {
+            'rich'       : {
+                'style'  : "bold bright_blue",
             },
-            'color'    : [
+            'color'      : [
                 'bold',
                 'bright blue',
             ],
         },
-        'close_message': {
-            'rich' : {
-                'style' : 'bright_blue',
+        'close_message'  : {
+            'rich'       : {
+                'style'  : 'bright_blue',
             },
-            'color'    : [
+            'color'      : [
                 'bright blue',
             ],
         },
-        'doc_header': {
-            'rich' : {
-                'style' : 'bright_blue',
+        'doc_header'     : {
+            'rich'       : {
+                'style'  : 'bright_blue',
             },
-            'color'    : [
+            'color'      : [
                 'bright blue',
             ],
         },
-        'undoc_header': {
-            'rich' : {
-                'style' : 'bright_blue',
+        'undoc_header'   : {
+            'rich'       : {
+                'style'  : 'bright_blue',
             },
-            'color'    : [
+            'color'      : [
                 'bright blue',
             ],
         },
-        'ruler': {
-            'rich' : {
-                'style' : 'bold bright_blue',
+        'ruler'          : {
+            'rich'       : {
+                'style'  : 'bold bright_blue',
             },
-            'color'    : [
+            'color'      : [
                 'bold',
                 'bright blue',
             ],
         },
-        'prompt': {
-            'rich' : {
-                'style' : 'green',
+        'prompt'         : {
+            'rich'       : {
+                'style'  : 'green',
             },
-            'color'    : [
+            'color'      : [
                 'green',
             ],
         },
-        'instance' : {
-            'rich' : {
-                'style' : 'cyan',
+        'instance'       : {
+            'rich'       : {
+                'style'  : 'cyan',
             },
-            'color'    : [
+            'color'      : [
                 'cyan',
             ],
         },
-        'repo' : {
-            'rich': {
-                'style': 'magenta',
+        'repo'           : {
+            'rich'       : {
+                'style'  : 'magenta',
             },
-            'color': [
+            'color'      : [
                 'magenta',
             ],
         },
-        'username' : {
-            'rich' : {
-                'style' : 'white',
+        'username'       : {
+            'rich'       : {
+                'style'  : 'white',
             },
-            'color'    : [
+            'color'      : [
                 'white',
             ],
         },
-        'connected' : {
-            'rich' : {
-                'style' : 'green',
+        'connected'      : {
+            'rich'       : {
+                'style'  : 'green',
             },
-            'color'    : [
+            'color'      : [
                 'green',
             ],
         },
-        'disconnected' : {
-            'rich' : {
-                'style' : 'red',
+        'disconnected'   : {
+            'rich'       : {
+                'style'  : 'red',
             },
-            'color'    : [
+            'color'      : [
+                'red',
+            ],
+        },
+        'update_message' : {
+            'rich'       : {
+                'style'  : 'red',
+            },
+            'color'      : [
                 'red',
             ],
         },
     },
-    'ascii'            : {
-        'intro'        : """       ___  ___  __   __   __
+    'ascii'              : {
+        'intro'          : r"""       ___  ___  __   __   __
  |\/| |__  |__  |__) /__` /  ` |__|  /\  |  |  |\/|
  |  | |___ |___ |  \ .__/ \__, |  | /~~\ \__/  |  |\n""",
-        'prompt'       : '\n [ {username}@{instance} ] > ',
-        'ruler'        : '-',
-        'close_message': 'Thank you for using Meerschaum!',
-        'doc_header'   : 'Meerschaum actions (`help <action>` for usage):',
-        'undoc_header' : 'Unimplemented actions:',
+        'prompt'         : '\n [ {username}@{instance} ] > ',
+        'ruler'          : '-',
+        'close_message'  : 'Thank you for using Meerschaum!',
+        'doc_header'     : 'Meerschaum actions (`help <action>` for usage):',
+        'undoc_header'   : 'Unimplemented actions:',
+        'update_message' : "Update available!",
     },
-    'unicode'          : {
-        'intro'        : """
+    'unicode'            : {
+        'intro'          : """
  █▄ ▄█ ██▀ ██▀ █▀▄ ▄▀▀ ▄▀▀ █▄█ ▄▀▄ █ █ █▄ ▄█
  █ ▀ █ █▄▄ █▄▄ █▀▄ ▄██ ▀▄▄ █ █ █▀█ ▀▄█ █ ▀ █\n""",
-        'prompt'       : '\n [ {username}@{instance} ] ➤ ',
-        'ruler'        : '─',
-        'close_message': ' MRSM{formatting:emoji:hand} Thank you for using Meerschaum! ',
-        'doc_header'   : 'Meerschaum actions (`help <action>` for usage):',
-        'undoc_header' : 'Unimplemented actions:',
+        'prompt'         : '\n [ {username}@{instance} ] ➤ ',
+        'ruler'          : '─',
+        'close_message'  : ' MRSM{formatting:emoji:hand} Thank you for using Meerschaum! ',
+        'doc_header'     : 'Meerschaum actions (`help <action>` for usage):',
+        'undoc_header'   : 'Unimplemented actions:',
+        'update_message' : "MRSM{formatting:emoji:announcement} Update available!",
+    },
+    'timeout'            : 60,
+    'max_history'        : 1000,
+    'clear_screen'       : True,
+    'bottom_toolbar'     : {
+        'enabled'        : True,
     },
-    'timeout'          : 60,
-    'max_history'      : 1000,
-    'clear_screen'     : True,
-    'bottom_toolbar'   : {
-        'enabled'      : True,
+    'updates'            : {
+        'check_remote'   : True,
+        'refresh_minutes': 180,
     },
 }

meerschaum/config/_version.py

@@ -2,4 +2,4 @@
 Specify the Meerschaum release version.
 """
 
-__version__ = "2.2.5.dev3"
+__version__ = "2.2.7"

meerschaum/config/paths.py

@@ -6,5 +6,24 @@
 External API for importing Meerschaum paths.
 """
 
-from meerschaum.config._paths import __getattr__, paths
-__all__ = tuple(paths.keys())
+import pathlib
+import inspect
+import meerschaum.config._paths as _paths
+
+
+def __getattr__(*args, **kwargs):
+    return _paths.__getattr__(*args, **kwargs)
+
+
+_globals_dict = inspect.getmembers(
+    _paths,
+    lambda member: not inspect.isroutine(member)
+)
+_all_caps_globals = [
+    name
+    for name, value in _globals_dict
+    if ('PATH' in name or 'FILE' in name) and not name.startswith('_')
+    and isinstance(value, pathlib.Path)
+]
+
+__all__ = tuple(_all_caps_globals + list(_paths.paths.keys()))

meerschaum/config/static/__init__.py

@@ -39,6 +39,7 @@ STATIC_CONFIG: Dict[str, Any] = {
             'token_expires_minutes': 720,
         },
         'webterm_job_name': '_webterm',
+        'default_timeout': 600,
     },
     'sql': {
         'internal_schema': '_mrsm_internal',
@@ -46,6 +47,7 @@ STATIC_CONFIG: Dict[str, Any] = {
     },
     'environment': {
         'config': 'MRSM_CONFIG',
+        'config_dir': 'MRSM_CONFIG_DIR',
         'patch': 'MRSM_PATCH',
         'root': 'MRSM_ROOT_DIR',
         'plugins': 'MRSM_PLUGINS_DIR',

meerschaum/connectors/Connector.py

@@ -18,7 +18,7 @@ class InvalidAttributesError(Exception):
 
 class Connector(metaclass=abc.ABCMeta):
     """
-    The base connector class to hold connection attributes,
+    The base connector class to hold connection attributes.
     """
     def __init__(
             self,
@@ -27,6 +27,8 @@ class Connector(metaclass=abc.ABCMeta):
             **kw: Any
         ):
         """
+        Set the given keyword arguments as attributes.
+
         Parameters
         ----------
         type: str
@@ -35,9 +37,12 @@ class Connector(metaclass=abc.ABCMeta):
         label: str
             The `label` for the connector.
 
+
+        Examples
+        --------
         Run `mrsm edit config` and to edit connectors in the YAML file:
 
-        ```
+        ```yaml
         meerschaum:
             connections:
                 {type}:

meerschaum/connectors/__init__.py

@@ -24,6 +24,7 @@ from meerschaum.connectors.api.APIConnector import APIConnector
 from meerschaum.connectors.sql._create_engine import flavor_configs as sql_flavor_configs
 
 __all__ = (
+    "make_connector",
     "Connector",
     "SQLConnector",
     "APIConnector",
@@ -290,13 +291,14 @@ def make_connector(
     --------
     >>> import meerschaum as mrsm
     >>> from meerschaum.connectors import make_connector, Connector
+    >>> 
+    >>> @make_connector
     >>> class FooConnector(Connector):
-    ...     def __init__(self, label: str, **kw):
-    ...         super().__init__('foo', label, **kw)
+    ...     REQUIRED_ATTRIBUTES: list[str] = ['username', 'password']
     ... 
-    >>> make_connector(FooConnector)
-    >>> mrsm.get_connector('foo', 'bar')
-    foo:bar
+    >>> conn = mrsm.get_connector('foo:bar', username='dog', password='cat')
+    >>> print(conn.username, conn.password)
+    dog cat
     >>> 
     """
     import re

meerschaum/connectors/api/APIConnector.py

@@ -83,12 +83,16 @@ class APIConnector(Connector):
         if 'uri' in kw:
             from_uri_params = self.from_uri(kw['uri'], as_dict=True)
             label = label or from_uri_params.get('label', None)
-            from_uri_params.pop('label', None)
+            _ = from_uri_params.pop('label', None)
             kw.update(from_uri_params)
 
         super().__init__('api', label=label, **kw)
         if 'protocol' not in self.__dict__:
-            self.protocol = 'http'
+            self.protocol = (
+                'https' if self.__dict__.get('uri', '').startswith('https')
+                else 'http'
+            )
+
         if 'uri' not in self.__dict__:
             self.verify_attributes(required_attributes)
         else:
@@ -97,6 +101,7 @@ class APIConnector(Connector):
             if 'host' not in conn_attrs:
                 raise Exception(f"Invalid URI for '{self}'.")
             self.__dict__.update(conn_attrs)
+
         self.url = (
             self.protocol + '://' +
             self.host

meerschaum/connectors/api/_actions.py

@@ -9,44 +9,31 @@ Functions to interact with /mrsm/actions
 from __future__ import annotations
 from meerschaum.utils.typing import SuccessTuple, Optional, List
 
-def get_actions(
-        self,
-    ) -> list:
-    """Get available actions from the API server"""
+def get_actions(self) -> list:
+    """Get available actions from the API instance."""
     from meerschaum.config.static import STATIC_CONFIG
     return self.get(STATIC_CONFIG['api']['endpoints']['actions'])
 
 
 def do_action(
-        self,
-        action: Optional[List[str]] = None,
-        sysargs: Optional[List[str]] = None,
-        debug: bool = False,
-        **kw
-    ) -> SuccessTuple:
+    self,
+    action: Optional[List[str]] = None,
+    sysargs: Optional[List[str]] = None,
+    debug: bool = False,
+    **kw
+) -> SuccessTuple:
     """Execute a Meerschaum action remotely.
-    
-    If sysargs is provided, parse those instead. Otherwise infer everything from keyword arguments.
-    
-    NOTE: The first index of `action` should NOT be removed!
-    Example: action = ['show', 'config']
-    
-    Returns: tuple (succeeded : bool, message : str)
 
-    Parameters
-    ----------
-    action: Optional[List[str]] :
-         (Default value = None)
-    sysargs: Optional[List[str]] :
-         (Default value = None)
-    debug: bool :
-         (Default value = False)
-    **kw :
-        
-
-    Returns
-    -------
+    If `sysargs` are provided, parse those instead.
+    Otherwise infer everything from keyword arguments.
 
+    Examples
+    --------
+    >>> conn = mrsm.get_connector('api:main')
+    >>> conn.do_action(['show', 'pipes'])
+    (True, "Success")
+    >>> conn.do_action(['show', 'arguments'], name='test')
+    (True, "Success")
     """
     import sys, json
     from meerschaum.utils.debug import dprint
@@ -63,7 +50,12 @@ def do_action(
     else:
         json_dict = kw
         json_dict['action'] = action
-        json_dict['debug'] = debug
+        if 'noask' not in kw:
+            json_dict['noask'] = True
+        if 'yes' not in kw:
+            json_dict['yes'] = True
+        if debug:
+            json_dict['debug'] = debug
 
     root_action = json_dict['action'][0]
     del json_dict['action'][0]

meerschaum/connectors/api/_misc.py

@@ -17,7 +17,7 @@ def get_mrsm_version(self, **kw) -> Optional[str]:
     try:
         j = self.get(
             STATIC_CONFIG['api']['endpoints']['version'] + '/mrsm',
-            use_token = True,
+            use_token=False,
             **kw
         ).json()
     except Exception as e:

meerschaum/connectors/api/_request.py

@@ -11,7 +11,7 @@ import urllib.parse
 import pathlib
 from meerschaum.utils.typing import Any, Optional, Dict, Union
 from meerschaum.utils.debug import dprint
-from meerschaum.utils.formatting import pprint
+from meerschaum.config.static import STATIC_CONFIG
 
 METHODS = {
     'GET',
@@ -23,15 +23,16 @@ METHODS = {
     'DELETE',
 }
 
+
 def make_request(
-        self,
-        method: str,
-        r_url: str,
-        headers: Optional[Dict[str, Any]] = None,
-        use_token: bool = True,
-        debug: bool = False,
-        **kwargs: Any
-    ) -> 'requests.Response':
+    self,
+    method: str,
+    r_url: str,
+    headers: Optional[Dict[str, Any]] = None,
+    use_token: bool = True,
+    debug: bool = False,
+    **kwargs: Any
+) -> 'requests.Response':
     """
     Make a request to this APIConnector's endpoint using the in-memory session.
 
@@ -84,6 +85,9 @@ def make_request(
     if use_token:
         headers.update({'Authorization': f'Bearer {self.token}'})
 
+    if 'timeout' not in kwargs:
+        kwargs['timeout'] = STATIC_CONFIG['api']['default_timeout']
+
     request_url = urllib.parse.urljoin(self.url, r_url)
     if debug:
         dprint(f"[{self}] Sending a '{method.upper()}' request to {request_url}")

meerschaum/connectors/api/_uri.py

@@ -11,11 +11,11 @@ from meerschaum.utils.warnings import warn, error
 
 @classmethod
 def from_uri(
-        cls,
-        uri: str,
-        label: Optional[str] = None,
-        as_dict: bool = False,
-    ) -> Union[
+    cls,
+    uri: str,
+    label: Optional[str] = None,
+    as_dict: bool = False,
+) -> Union[
         'meerschaum.connectors.APIConnector',
         Dict[str, Union[str, int]],
     ]:

meerschaum/core/Pipe/__init__.py

@@ -50,6 +50,7 @@ with correct credentials, as well as a network connection and valid permissions.
 """
 
 from __future__ import annotations
+import sys
 import copy
 from meerschaum.utils.typing import Optional, Dict, Any, Union, InstanceConnector, List
 from meerschaum.utils.formatting._pipes import pipe_repr
@@ -433,13 +434,16 @@ class Pipe:
             + str(self.instance_keys) + sep
         )
 
-    def __repr__(self, **kw) -> str:
-        return pipe_repr(self, **kw)
+    def __repr__(self, ansi: bool=True, **kw) -> str:
+        if not hasattr(sys, 'ps1'):
+            ansi = False
+
+        return pipe_repr(self, ansi=ansi, **kw)
 
     def __pt_repr__(self):
         from meerschaum.utils.packages import attempt_import
         prompt_toolkit_formatted_text = attempt_import('prompt_toolkit.formatted_text', lazy=False)
-        return prompt_toolkit_formatted_text.ANSI(self.__repr__())
+        return prompt_toolkit_formatted_text.ANSI(pipe_repr(self, ansi=True))
 
     def __getstate__(self) -> Dict[str, Any]:
         """

meerschaum/core/Pipe/_data.py

@@ -8,24 +8,32 @@ Retrieve Pipes' data from instances.
 
 from __future__ import annotations
 from datetime import datetime, timedelta
-from meerschaum.utils.typing import Optional, Dict, Any, Union, Generator, List, Tuple, Iterator
+
+import meerschaum as mrsm
+from meerschaum.utils.typing import (
+    Optional, Dict, Any, Union, List, Tuple, Iterator, TYPE_CHECKING,
+)
 from meerschaum.config import get_config
 
+if TYPE_CHECKING:
+    pd = mrsm.attempt_import('pandas')
+
+
 def get_data(
-        self,
-        select_columns: Optional[List[str]] = None,
-        omit_columns: Optional[List[str]] = None,
-        begin: Union[datetime, int, None] = None,
-        end: Union[datetime, int, None] = None,
-        params: Optional[Dict[str, Any]] = None,
-        as_iterator: bool = False,
-        as_chunks: bool = False,
-        as_dask: bool = False,
-        chunk_interval: Union[timedelta, int, None] = None,
-        fresh: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> Union['pd.DataFrame', Generator['pd.DataFrame'], None]:
+    self,
+    select_columns: Optional[List[str]] = None,
+    omit_columns: Optional[List[str]] = None,
+    begin: Union[datetime, int, None] = None,
+    end: Union[datetime, int, None] = None,
+    params: Optional[Dict[str, Any]] = None,
+    as_iterator: bool = False,
+    as_chunks: bool = False,
+    as_dask: bool = False,
+    chunk_interval: Union[timedelta, int, None] = None,
+    fresh: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> Union['pd.DataFrame', Iterator['pd.DataFrame'], None]:
     """
     Get a pipe's data from the instance connector.
 

meerschaum/core/Pipe/_deduplicate.py

@@ -8,7 +8,7 @@ Delete duplicate rows within a pipe's table.
 
 from __future__ import annotations
 from datetime import datetime, timedelta
-from meerschaum.utils.typing import SuccessTuple, Any, Optional, Dict, Tuple
+from meerschaum.utils.typing import SuccessTuple, Any, Optional, Dict, Tuple, Union
 
 
 def deduplicate(

meerschaum/core/Pipe/_dtypes.py

@@ -8,7 +8,12 @@ Enforce data types for a pipe's underlying table.
 
 from __future__ import annotations
 from io import StringIO
+import meerschaum as mrsm
 from meerschaum.utils.typing import Dict, Any, Optional
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    pd = mrsm.attempt_import('pandas')
 
 def enforce_dtypes(
         self,