meerschaum 2.2.6__tar.gz → 2.3.0.dev1__tar.gz

{meerschaum-2.2.6/meerschaum.egg-info → meerschaum-2.3.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meerschaum
-Version: 2.2.6
+Version: 2.3.0.dev1
 Summary: Sync Time-Series Pipes with Meerschaum
 Home-page: https://meerschaum.io
 Author: Bennett Meares
@@ -60,7 +60,7 @@ Requires-Dist: packaging>=21.3.0; extra == "core"
 Requires-Dist: prompt-toolkit>=3.0.39; extra == "core"
 Requires-Dist: more-itertools>=8.7.0; extra == "core"
 Requires-Dist: python-daemon>=0.2.3; extra == "core"
-Requires-Dist: fasteners>=0.18.0; extra == "core"
+Requires-Dist: fasteners>=0.19.0; extra == "core"
 Requires-Dist: psutil>=5.8.0; extra == "core"
 Requires-Dist: watchfiles>=0.21.0; extra == "core"
 Requires-Dist: dill>=0.3.3; extra == "core"
@@ -69,7 +69,7 @@ Requires-Dist: APScheduler>=4.0.0a5; extra == "core"
 Requires-Dist: uv>=0.2.11; extra == "core"
 Provides-Extra: drivers
 Requires-Dist: cryptography>=38.0.1; extra == "drivers"
-Requires-Dist: psycopg[binary]>=3.1.18; extra == "drivers"
+Requires-Dist: psycopg[binary]>=3.2.1; extra == "drivers"
 Requires-Dist: PyMySQL>=0.9.0; extra == "drivers"
 Requires-Dist: aiomysql>=0.0.21; extra == "drivers"
 Requires-Dist: sqlalchemy-cockroachdb>=2.0.0; extra == "drivers"
@@ -131,7 +131,7 @@ Requires-Dist: databases>=0.4.0; extra == "sql"
 Requires-Dist: aiosqlite>=0.16.0; extra == "sql"
 Requires-Dist: asyncpg>=0.21.0; extra == "sql"
 Requires-Dist: cryptography>=38.0.1; extra == "sql"
-Requires-Dist: psycopg[binary]>=3.1.18; extra == "sql"
+Requires-Dist: psycopg[binary]>=3.2.1; extra == "sql"
 Requires-Dist: PyMySQL>=0.9.0; extra == "sql"
 Requires-Dist: aiomysql>=0.0.21; extra == "sql"
 Requires-Dist: sqlalchemy-cockroachdb>=2.0.0; extra == "sql"
@@ -154,7 +154,7 @@ Requires-Dist: packaging>=21.3.0; extra == "sql"
 Requires-Dist: prompt-toolkit>=3.0.39; extra == "sql"
 Requires-Dist: more-itertools>=8.7.0; extra == "sql"
 Requires-Dist: python-daemon>=0.2.3; extra == "sql"
-Requires-Dist: fasteners>=0.18.0; extra == "sql"
+Requires-Dist: fasteners>=0.19.0; extra == "sql"
 Requires-Dist: psutil>=5.8.0; extra == "sql"
 Requires-Dist: watchfiles>=0.21.0; extra == "sql"
 Requires-Dist: dill>=0.3.3; extra == "sql"
@@ -190,7 +190,7 @@ Requires-Dist: databases>=0.4.0; extra == "api"
 Requires-Dist: aiosqlite>=0.16.0; extra == "api"
 Requires-Dist: asyncpg>=0.21.0; extra == "api"
 Requires-Dist: cryptography>=38.0.1; extra == "api"
-Requires-Dist: psycopg[binary]>=3.1.18; extra == "api"
+Requires-Dist: psycopg[binary]>=3.2.1; extra == "api"
 Requires-Dist: PyMySQL>=0.9.0; extra == "api"
 Requires-Dist: aiomysql>=0.0.21; extra == "api"
 Requires-Dist: sqlalchemy-cockroachdb>=2.0.0; extra == "api"
@@ -213,7 +213,7 @@ Requires-Dist: packaging>=21.3.0; extra == "api"
 Requires-Dist: prompt-toolkit>=3.0.39; extra == "api"
 Requires-Dist: more-itertools>=8.7.0; extra == "api"
 Requires-Dist: python-daemon>=0.2.3; extra == "api"
-Requires-Dist: fasteners>=0.18.0; extra == "api"
+Requires-Dist: fasteners>=0.19.0; extra == "api"
 Requires-Dist: psutil>=5.8.0; extra == "api"
 Requires-Dist: watchfiles>=0.21.0; extra == "api"
 Requires-Dist: dill>=0.3.3; extra == "api"
@@ -262,7 +262,7 @@ Requires-Dist: packaging>=21.3.0; extra == "full"
 Requires-Dist: prompt-toolkit>=3.0.39; extra == "full"
 Requires-Dist: more-itertools>=8.7.0; extra == "full"
 Requires-Dist: python-daemon>=0.2.3; extra == "full"
-Requires-Dist: fasteners>=0.18.0; extra == "full"
+Requires-Dist: fasteners>=0.19.0; extra == "full"
 Requires-Dist: psutil>=5.8.0; extra == "full"
 Requires-Dist: watchfiles>=0.21.0; extra == "full"
 Requires-Dist: dill>=0.3.3; extra == "full"
@@ -270,7 +270,7 @@ Requires-Dist: virtualenv>=20.1.0; extra == "full"
 Requires-Dist: APScheduler>=4.0.0a5; extra == "full"
 Requires-Dist: uv>=0.2.11; extra == "full"
 Requires-Dist: cryptography>=38.0.1; extra == "full"
-Requires-Dist: psycopg[binary]>=3.1.18; extra == "full"
+Requires-Dist: psycopg[binary]>=3.2.1; extra == "full"
 Requires-Dist: PyMySQL>=0.9.0; extra == "full"
 Requires-Dist: aiomysql>=0.0.21; extra == "full"
 Requires-Dist: sqlalchemy-cockroachdb>=2.0.0; extra == "full"

{meerschaum-2.2.6 → meerschaum-2.3.0.dev1}/meerschaum/__init__.py

@@ -20,15 +20,16 @@ limitations under the License.
 
 import atexit
 from meerschaum.utils.typing import SuccessTuple
+from meerschaum.utils.packages import attempt_import
 from meerschaum.core.Pipe import Pipe
 from meerschaum.plugins import Plugin
 from meerschaum.utils.venv import Venv
+from meerschaum.utils.jobs import Job
 from meerschaum.connectors import get_connector, Connector, make_connector
 from meerschaum.utils import get_pipes
 from meerschaum.utils.formatting import pprint
 from meerschaum._internal.docs import index as __doc__
 from meerschaum.config import __version__, get_config
-from meerschaum.utils.packages import attempt_import
 from meerschaum.__main__ import _close_pools
 
 atexit.register(_close_pools)
@@ -42,6 +43,8 @@ __all__ = (
     "Plugin",
     "Venv",
     "Plugin",
+    "Job",
+    "Daemon",
     "pprint",
     "attempt_import",
     "actions",

{meerschaum-2.2.6 → meerschaum-2.3.0.dev1}/meerschaum/__main__.py

@@ -19,9 +19,15 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
-import sys, os, copy
+import sys
+import os
+import copy
 
-def main(sysargs: list = None) -> None:
+from meerschaum.utils.typing import List, Optional
+from meerschaum.utils.formatting import print_tuple as _print_tuple
+
+
+def main(sysargs: Optional[List[str]] = None) -> None:
     """Main CLI entry point."""
     if sysargs is None:
         sysargs = copy.deepcopy(sys.argv[1:])
@@ -41,7 +47,7 @@ def main(sysargs: list = None) -> None:
 
     if ('-d' in sysargs or '--daemon' in sysargs) and ('stack' not in sysargs):
         from meerschaum.utils.daemon import daemon_entry
-        daemon_entry(sysargs)
+        _print_tuple(daemon_entry(sysargs), upper_padding=1)
         return _exit(old_cwd=old_cwd)
 
     from meerschaum._internal.entry import entry, get_shell
@@ -57,8 +63,7 @@ def main(sysargs: list = None) -> None:
     return_tuple = entry(sysargs)
     rc = 0
     if isinstance(return_tuple, tuple) and '--nopretty' not in sysargs:
-        from meerschaum.utils.formatting import print_tuple
-        print_tuple(return_tuple, upper_padding=1)
+        _print_tuple(return_tuple, upper_padding=1)
         rc = 0 if (return_tuple[0] is True) else 1
 
     return _exit(rc, old_cwd=old_cwd)

{meerschaum-2.2.6 → meerschaum-2.3.0.dev1}/meerschaum/_internal/arguments/_parser.py

@@ -62,7 +62,24 @@ def parse_datetime(dt_str: str) -> Union[datetime, int, str]:
     return dt
 
 
-def parse_help(sysargs : Union[List[str], Dict[str, Any]]) -> None:
+def parse_executor_keys(executor_keys_str: str) -> Union[str, None]:
+    """
+    Ensure that only API keys are provided for executor_keys.
+    """
+    if executor_keys_str == 'local':
+        return executor_keys_str
+
+    if executor_keys_str.lower() == 'none':
+        return 'local'
+
+    if not executor_keys_str.startswith('api:'):
+        from meerschaum.utils.warnings import error
+        error(f"Invalid exectutor keys '{executor_keys_str}'.", stack=False)
+
+    return executor_keys_str
+
+
+def parse_help(sysargs: Union[List[str], Dict[str, Any]]) -> None:
     """Parse the `--help` flag to determine which help message to print."""
     from meerschaum._internal.arguments._parse_arguments import parse_arguments, parse_line
     from meerschaum.actions import actions, get_subactions
@@ -135,6 +152,7 @@ _seen_plugin_args = {}
 
 groups = {}
 groups['actions'] = parser.add_argument_group(title='Actions options')
+groups['jobs'] = parser.add_argument_group(title='Jobs options')
 groups['pipes'] = parser.add_argument_group(title='Pipes options')
 groups['sync'] = parser.add_argument_group(title='Sync options')
 groups['api'] = parser.add_argument_group(title='API options')
@@ -166,18 +184,25 @@ groups['actions'].add_argument(
     help="Automatically choose the defaults answers to questions. Does not result in data loss.",
 )
 groups['actions'].add_argument(
-    '-d', '--daemon', action='store_true',
-    help = "Run an action as a background daemon."
+    '-A', '--sub-args', nargs=argparse.REMAINDER,
+    help = (
+        "Provide a list of arguments for subprocesses. " +
+        "You can also type sub-arguments in [] instead." +
+        " E.g. `stack -A='--version'`, `ls [-lh]`, `echo -A these are sub-arguments`"
+    )
 )
-groups['actions'].add_argument(
-    '--rm', action='store_true', help="Delete a job once it has finished executing."
+
+### Jobs options
+groups['jobs'].add_argument(
+    '-d', '--daemon', action='store_true',
+    help = "Run an action as a background daemon to create a job."
 )
-groups['actions'].add_argument(
+groups['jobs'].add_argument(
     '--name', '--job-name', type=parse_name, help=(
         "Assign a name to a job. If no name is provided, a random name will be assigned."
     ),
 )
-groups['actions'].add_argument(
+groups['jobs'].add_argument(
     '-s', '--schedule', '--cron', type=str,
     help = (
         "Continue executing the action according to a schedule (e.g. 'every 1 seconds'). \n"
@@ -185,15 +210,19 @@ groups['actions'].add_argument(
         + "https://red-engine.readthedocs.io/en/stable/condition_syntax/index.html"
     )
 )
-groups['actions'].add_argument(
-    '-A', '--sub-args', nargs=argparse.REMAINDER,
-    help = (
-        "Provide a list of arguments for subprocesses. " +
-        "You can also type sub-arguments in [] instead." +
-        " E.g. `stack -A='--version'`, `ls [-lh]`, `echo -A these are sub-arguments`"
-    )
+groups['jobs'].add_argument(
+    '--restart', action='store_true',
+    help=("Restart a job if not stopped manually."),
+)
+groups['jobs'].add_argument(
+    '--executor-keys', '--executor', '-e', type=parse_executor_keys,
+    help=(
+        "Remotely execute jobs on an API instance."
+    ),
+)
+groups['jobs'].add_argument(
+    '--rm', action='store_true', help="Delete a job once it has finished executing."
 )
-
 ### Pipes options
 groups['pipes'].add_argument(
     '-c', '-C', '--connector-keys', nargs='+',

{meerschaum-2.2.6 → meerschaum-2.3.0.dev1}/meerschaum/_internal/entry.py

@@ -8,20 +8,15 @@ The entry point for launching Meerschaum actions.
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import SuccessTuple, List, Optional, Dict
+from meerschaum.utils.typing import SuccessTuple, List, Optional, Dict, Callable, Any
 
 def entry(sysargs: Optional[List[str]] = None) -> SuccessTuple:
-    """Parse arguments and launch a Meerschaum action.
-    The `action` list removes the first element.
-    
-    Examples of action:
-        'show actions' -> ['actions']
-        'show' -> []
+    """
+    Parse arguments and launch a Meerschaum action.
 
     Returns
     -------
-    A `SuccessTuple` indicating success. If `schedule` is provided, this will never return.
-
+    A `SuccessTuple` indicating success.
     """
     from meerschaum._internal.arguments import parse_arguments
     from meerschaum.config.static import STATIC_CONFIG
@@ -51,14 +46,15 @@ def entry(sysargs: Optional[List[str]] = None) -> SuccessTuple:
 
 
 def entry_with_args(
-        _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
-        **kw
-    ) -> SuccessTuple:
+    _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
+    **kw
+) -> SuccessTuple:
     """Execute a Meerschaum action with keyword arguments.
     Use `_entry()` for parsing sysargs before executing.
     """
     import sys
     import functools
+    import inspect
     from meerschaum.actions import get_action, get_main_action_name
     from meerschaum._internal.arguments import remove_leading_action
     from meerschaum.utils.venv import Venv, active_venvs, deactivate_venv
@@ -72,6 +68,25 @@ def entry_with_args(
     ):
         return get_shell().cmdloop()
 
+    skip_schedule = False
+
+    executor_keys = kw.get('executor_keys', None)
+    if executor_keys is None:
+        executor_keys = 'local'
+
+    if executor_keys.startswith('api:'):
+        intended_action_function = get_action(kw['action'], _actions=_actions)
+        function_accepts_executor_keys = (
+            'executor_keys' in inspect.signature(intended_action_function).parameters
+            if intended_action_function is not None
+            else False
+        )
+        if not function_accepts_executor_keys:
+            api_label = executor_keys.split(':')[-1]
+            kw['action'].insert(0, 'api')
+            kw['action'].insert(1, api_label)
+            skip_schedule = True
+
     action_function = get_action(kw['action'], _actions=_actions)
 
     ### If action does not exist, execute in a subshell.
@@ -86,7 +101,6 @@ def entry_with_args(
         ) else None
     )
 
-    skip_schedule = False
     if (
         kw['action']
         and kw['action'][0] == 'start'
@@ -96,7 +110,14 @@ def entry_with_args(
 
     kw['action'] = remove_leading_action(kw['action'], _actions=_actions)
 
-    do_action = functools.partial(_do_action_wrapper, action_function, plugin_name, **kw)
+    do_action = functools.partial(
+        _do_action_wrapper,
+        action_function,
+        plugin_name,
+        **kw
+    )
+
+
     if kw.get('schedule', None) and not skip_schedule:
         from meerschaum.utils.schedule import schedule_function
         from meerschaum.utils.misc import interval_str