meerschaum 2.3.0rc5__py3-none-any.whl → 2.3.2__py3-none-any.whl

meerschaum/__init__.py

@@ -24,7 +24,7 @@ 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.jobs import Job, Executor, make_executor
+from meerschaum.jobs import Job, make_executor
 from meerschaum.connectors import get_connector, Connector, make_connector
 from meerschaum.utils import get_pipes
 from meerschaum.utils.formatting import pprint
@@ -45,13 +45,12 @@ __all__ = (
     "Venv",
     "Plugin",
     "Job",
-    "Executor",
-    "make_executor",
     "pprint",
     "attempt_import",
     "actions",
     "config",
     "connectors",
+    "jobs",
     "plugins",
     "utils",
     "SuccessTuple",

meerschaum/_internal/arguments/_parse_arguments.py

@@ -106,8 +106,8 @@ def parse_arguments(sysargs: List[str]) -> Dict[str, Any]:
     for i, word in enumerate(sysargs):
         is_sub_arg = False
         if not found_begin_decorator:
-            found_begin_decorator = word.startswith(begin_decorator)
-            found_end_decorator = word.endswith(end_decorator)
+            found_begin_decorator = str(word).startswith(begin_decorator)
+            found_end_decorator = str(word).endswith(end_decorator)
 
         if found_begin_decorator:
             ### check if sub arg is ever closed
@@ -117,15 +117,15 @@ def parse_arguments(sysargs: List[str]) -> Dict[str, Any]:
                     found_begin_decorator = False
         elif found_end_decorator:
             for a in sysargs[:i]:
-                if a.startswith(begin_decorator):
+                if str(a).startswith(begin_decorator):
                     is_sub_arg = True
                     found_begin_decorator = False
         if is_sub_arg:
             ### remove decorators
             sa = word
-            if sa.startswith(begin_decorator):
+            if str(sa).startswith(begin_decorator):
                 sa = sa[len(begin_decorator):]
-            if sa.endswith(end_decorator):
+            if str(sa).endswith(end_decorator):
                 sa = sa[:-1 * len(end_decorator)]
             sub_arguments.append(sa)
             ### remove sub-argument from action list
@@ -144,7 +144,7 @@ def parse_arguments(sysargs: List[str]) -> Dict[str, Any]:
     except Exception as e:
         _action = []
         for a in filtered_sysargs:
-            if a.startswith('-'):
+            if str(a).startswith('-'):
                 break
             _action.append(a)
         args_dict = {'action': _action, 'sysargs': sysargs}
@@ -267,7 +267,7 @@ def parse_dict_to_sysargs(
     action = args_dict.get('action', None)
     sysargs: List[str] = []
     sysargs.extend(action or [])
-    allow_none_args = {'location_keys'}
+    allow_none_args = {'location_keys', 'begin', 'end', 'executor_keys'}
 
     triggers = get_arguments_triggers()
 
@@ -278,12 +278,18 @@ def parse_dict_to_sysargs(
         ### Add boolean flags
         if isinstance(args_dict[a], bool):
             if args_dict[a] is True:
-                sysargs += [t[0]]
+                sysargs.extend([t[0]])
         else:
             ### Add list flags
             if isinstance(args_dict[a], (list, tuple)):
                 if len(args_dict[a]) > 0:
-                    sysargs += [t[0]] + list(args_dict[a])
+                    sysargs.extend(
+                        [t[0]]
+                        + [
+                            str(item)
+                            for item in args_dict[a]
+                        ]
+                    )
 
             ### Add dict flags
             elif isinstance(args_dict[a], dict):
@@ -292,7 +298,7 @@ def parse_dict_to_sysargs(
 
             ### Account for None and other values
             elif (args_dict[a] is not None) or (args_dict[a] is None and a in allow_none_args):
-                sysargs += [t[0], args_dict[a]]
+                sysargs += [t[0], str(args_dict[a])]
 
     return sysargs
 

meerschaum/_internal/arguments/_parser.py

@@ -125,7 +125,7 @@ def parse_version(sysargs: List[str]):
     return print(doc)
 
 
-def parse_name(name_str: str) -> str:
+def parse_name(name_str: str) -> Union[str, None]:
     """
     Ensure that `--name` is not an empty string.
     """

meerschaum/_internal/docs/index.py

@@ -36,8 +36,9 @@ For your convenience, the following classes and functions may be imported from t
 <li><code>meerschaum.Connector</code></li>
 <li><code>meerschaum.Pipe</code></li>
 <li><code>meerschaum.Plugin</code></li>
-<li><code>meerschaum.SuccessTuple</code></li>
+<li><code>meerschaum.Job</code></li>
 <li><code>meerschaum.Venv</code></li>
+<li><code>meerschaum.SuccessTuple</code></li>
 </ul>
 
 </div>
@@ -54,6 +55,7 @@ For your convenience, the following classes and functions may be imported from t
 <li><code>meerschaum.make_connector()</code></li>
 <li><code>meerschaum.pprint()</code></li>
 <li><code>meerschaum.attempt_import()</code></li>
+<li><code>meerschaum.entry()</code></li>
 </ul>
 
 </div>
@@ -61,7 +63,10 @@ For your convenience, the following classes and functions may be imported from t
 
 ### Examples
 
-#### Build a Connector
+<details>
+    <summary><b>Build a Connector</b></summary>
+
+Get existing connectors or build a new one in-memory with the `meerschaum.get_connector()` factory function:
 
 ```python
 import meerschaum as mrsm
@@ -80,9 +85,14 @@ sql_conn.to_sql(df, 'foo')
 print(sql_conn.read('foo'))
 #    foo
 # 0    1
+
 ```
+</details>
+
+<details>
+    <summary><b>Create a Custom Connector Class</b></summary>
 
-#### Create a Custom Connector Class
+Decorate your connector classes with `meerschaum.make_connector()` to designate it as a custom connector:
 
 ```python
 from datetime import datetime, timezone
@@ -113,8 +123,12 @@ foo_conn = mrsm.get_connector(
 )
 docs = foo_conn.fetch()
 ```
+</details>
 
-#### Build a Pipe
+<details>
+    <summary><b>Build a Pipe</b></summary>
+
+Build a `meerschaum.Pipe` in-memory:
 
 ```python
 from datetime import datetime
@@ -135,7 +149,23 @@ print(df)
 # 2 2024-01-01   3  96
 ```
 
-#### Get Registered Pipes
+Add `temporary=True` to skip registering the pipe in the pipes table.
+
+</details>
+
+<details>
+    <summary><b>Get Registered Pipes</b></summary>
+
+The `meerschaum.get_pipes()` function returns a dictionary hierarchy of pipes by connector, metric, and location:
+
+```python
+import meerschaum as mrsm
+
+pipes = mrsm.get_pipes(instance='sql:temp')
+pipe = pipes['foo:bar']['demo'][None]
+```
+
+Add `as_list=True` to flatten the hierarchy:
 
 ```python
 import meerschaum as mrsm
@@ -148,8 +178,12 @@ pipes = mrsm.get_pipes(
 print(pipes)
 # [Pipe('foo:bar', 'demo', instance='sql:temp')]
 ```
+</details>
 
-#### Access a Plugin's Module
+<details>
+    <summary><b>Import Plugins</b></summary>
+
+You can import a plugin's module through `meerschaum.Plugin.module`:
 
 ```python
 import meerschaum as mrsm
@@ -157,10 +191,211 @@ import meerschaum as mrsm
 plugin = mrsm.Plugin('noaa')
 with mrsm.Venv(plugin):
     noaa = plugin.module
-    print(noaa.get_station_info('KGMU'))
-# {'name': 'Greenville Downtown Airport', 'geometry': {'type': 'Point', 'coordinates': [-82.35004, 34.84873]}}
 ```
 
+If your plugin has submodules, use `meerschaum.plugins.from_plugin_import`:
+
+```python
+from meerschaum.plugins import from_plugin_import
+get_defined_pipes = from_plugin_import('compose.utils.pipes', 'get_defined_pipes')
+```
+
+Import multiple plugins with `meerschaum.plugins.import_plugins`:
+
+```python
+from meerschaum.plugins import import_plugins
+noaa, compose = import_plugins('noaa', 'compose')
+```
+
+</details>
+
+<details>
+    <summary><b>Create a Job</b></summary>
+
+Create a `meerschaum.Job` with `name` and `sysargs`:
+
+```python
+import meerschaum as mrsm
+
+job = mrsm.Job('syncing-engine', 'sync pipes --loop')
+success, msg = job.start()
+```
+
+Pass `executor_keys` as the connectors keys of an API instance to create a remote job:
+
+```python
+import meerschaum as mrsm
+
+job = mrsm.Job(
+    'foo',
+    'sync pipes -s daily',
+    executor_keys='api:main',
+)
+```
+
+</details>
+
+<details>
+    <summary><b>Import from a Virtual Environment</b></summary>
+Use the `meerschaum.Venv` context manager to activate a virtual environment:
+```python
+import meerschaum as mrsm
+
+with mrsm.Venv('noaa'):
+    import requests
+
+print(requests.__file__)
+# /home/bmeares/.config/meerschaum/venvs/noaa/lib/python3.12/site-packages/requests/__init__.py
+```
+
+To import packages which may not be installed, use `meerschaum.attempt_import()`:
+
+```python
+import meerschaum as mrsm
+
+requests = mrsm.attempt_import('requests', venv='noaa')
+print(requests.__file__)
+# /home/bmeares/.config/meerschaum/venvs/noaa/lib/python3.12/site-packages/requests/__init__.py
+```
+
+</details>
+
+<details>
+    <summary><b>Run Actions</b></summary>
+
+Run `sysargs` with `meerschaum.entry()`:
+
+```python
+import meerschaum as mrsm
+
+success, msg = mrsm.entry('show pipes + show version : x2')
+```
+
+Use `meerschaum.actions.get_action()` to access an action function directly:
+
+```python
+from meerschaum.actions import get_action
+
+show_pipes = get_action(['show', 'pipes'])
+success, msg = show_pipes(connector_keys=['plugin:noaa'])
+```
+
+Get a dictionary of available subactions with `meerschaum.actions.get_subactions()`:
+
+```python
+from meerschaum.actions import get_subactions
+
+subactions = get_subactions('show')
+success, msg = subactions['pipes']()
+```
+
+</details>
+
+<details>
+    <summary><b>Create a Plugin</b></summary>
+
+Run `bootstrap plugin` to create a new plugin:
+
+```
+mrsm bootstrap plugin example
+```
+
+This will create `example.py` in your plugins directory (default `~/.config/meerschaum/plugins/`, Windows: `%APPDATA%\Meerschaum\plugins`). You may paste the example code from the "Create a Custom Action" example below.
+
+Open your plugin with `edit plugin`:
+
+```
+mrsm edit plugin example
+```
+
+*Run `edit plugin` and paste the example code below to try out the features.*
+
+See the [writing plugins guide](https://meerschaum.io/reference/plugins/writing-plugins/) for more in-depth documentation.
+
+</details>
+
+<details>
+    <summary><b>Create a Custom Action</b></summary>
+
+Decorate a function with `meerschaum.actions.make_action` to designate it as an action. Subactions will be automatically detected if not decorated:
+
+```python
+from meerschaum.actions import make_action
+
+@make_action
+def sing():
+    print('What would you like me to sing?')
+    return True, "Success"
+
+def sing_tune():
+    return False, "I don't know that song!"
+
+def sing_song():
+    print('Hello, World!')
+    return True, "Success"
+
+```
+
+Use `meerschaum.plugins.add_plugin_argument()` to create new parameters for your action:
+
+```python
+from meerschaum.plugins import make_action, add_plugin_argument
+
+add_plugin_argument(
+    '--song', type=str, help='What song to sing.',
+)
+
+@make_action
+def sing_melody(action=None, song=None):
+    to_sing = action[0] if action else song
+    if not to_sing:
+        return False, "Please tell me what to sing!"
+
+    return True, f'~I am singing {to_sing}~'
+```
+
+```
+mrsm sing melody lalala
+
+mrsm sing melody --song do-re-mi
+```
+
+</details>
+
+<details>
+    <summary><b>Add a Page to the Web Dashboard</b></summary>
+    Use the decorators `meerschaum.plugins.dash_plugin()` and `meerschaum.plugins.web_page()` to add new pages to the web dashboard:
+
+```python
+from meerschaum.plugins import dash_plugin, web_page
+
+@dash_plugin
+def init_dash(dash_app):
+
+    import dash.html as html
+    import dash_bootstrap_components as dbc
+    from dash import Input, Output, no_update
+
+    ### Routes to '/dash/my-page'
+    @web_page('/my-page', login_required=False)
+    def my_page():
+        return dbc.Container([
+            html.H1("Hello, World!"),
+            dbc.Button("Click me", id='my-button'),
+            html.Div(id="my-output-div"),
+        ])
+
+    @dash_app.callback(
+        Output('my-output-div', 'children'),
+        Input('my-button', 'n_clicks'),
+    )
+    def my_button_click(n_clicks):
+        if not n_clicks:
+            return no_update
+        return html.P(f'You clicked {n_clicks} times!')
+```
+</details>
+
 ## Submodules
 
 <details>
@@ -206,6 +441,28 @@ with mrsm.Venv(plugin):
 
 </details>
 
+<details>
+    <summary>
+    `meerschaum.jobs`<br>
+    Start background jobs.
+    </summary>
+
+  - `meerschaum.jobs.Job`
+  - `meerschaum.jobs.Executor`
+  - `meerschaum.jobs.systemd.SystemdExecutor`
+  - `meerschaum.jobs.get_jobs()`
+  - `meerschaum.jobs.get_filtered_jobs()`
+  - `meerschaum.jobs.get_running_jobs()`
+  - `meerschaum.jobs.get_stopped_jobs()`
+  - `meerschaum.jobs.get_paused_jobs()`
+  - `meerschaum.jobs.get_restart_jobs()`
+  - `meerschaum.jobs.make_executor()`
+  - `meerschaum.jobs.check_restart_jobs()`
+  - `meerschaum.jobs.start_check_jobs_thread()`
+  - `meerschaum.jobs.stop_check_jobs_thread()`
+
+</details>
+
 <details>
   <summary>
   `meerschaum.plugins`<br>

meerschaum/actions/__init__.py

@@ -11,6 +11,16 @@ from meerschaum.utils.typing import Callable, Any, Optional, Union, List, Dict,
 from meerschaum.utils.packages import get_modules_from_package
 _custom_actions = []
 
+__all__ = (
+    'get_action',
+    'get_subactions',
+    'make_action',
+    'pre_sync_hook',
+    'post_sync_hook',
+    'get_main_action_name',
+    'get_completer',
+)
+
 def get_subactions(
     action: Union[str, List[str]],
     _actions: Optional[Dict[str, Callable[[Any], Any]]] = None,
@@ -101,9 +111,9 @@ def get_action(
 
 
 def get_main_action_name(
-        action: Union[List[str], str],
-        _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
-    ) -> Union[str, None]:
+    action: Union[List[str], str],
+    _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
+) -> Union[str, None]:
     """
     Given an action list, return the name of the main function.
     For subactions, this will return the root function.
@@ -140,9 +150,9 @@ def get_main_action_name(
 
 
 def get_completer(
-        action: Union[List[str], str],
-        _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
-    ) -> Union[
+    action: Union[List[str], str],
+    _actions: Optional[Dict[str, Callable[[Any], SuccessTuple]]] = None,
+) -> Union[
         Callable[['meerschaum._internal.shell.Shell', str, str, int, int], List[str]], None
     ]:
     """Search for a custom completer function for an action."""
@@ -179,10 +189,10 @@ def get_completer(
 
 
 def choose_subaction(
-        action: Optional[List[str]] = None,
-        options: Optional[Dict[str, Any]] = None,
-        **kw
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    options: Optional[Dict[str, Any]] = None,
+    **kw
+) -> SuccessTuple:
     """
     Given a dictionary of options and the standard Meerschaum actions list,
     check if choice is valid and execute chosen function, else show available
@@ -247,7 +257,7 @@ def _get_subaction_names(action: str, globs: dict = None) -> List[str]:
     return subactions
 
 
-def choices_docstring(action: str, globs : Optional[Dict[str, Any]] = None) -> str:
+def choices_docstring(action: str, globs: Optional[Dict[str, Any]] = None) -> str:
     """
     Append the an action's available options to the module docstring.
     This function is to be placed at the bottom of each action module.

meerschaum/actions/restart.py

@@ -79,7 +79,13 @@ def _restart_jobs(
     action = action or []
 
     while True:
-        jobs = get_filtered_jobs(executor_keys, action, include_hidden=True, debug=debug)
+        jobs = get_filtered_jobs(
+            executor_keys or 'local',
+            action,
+            include_hidden=True,
+            combine_local_and_systemd=False,
+            debug=debug,
+        )
         restart_jobs = get_restart_jobs(executor_keys, jobs, debug=debug) if not action else jobs
         if not restart_jobs and not loop:
             return True, "No jobs need to be restarted."

meerschaum/actions/start.py

@@ -99,7 +99,7 @@ def _start_jobs(
     To start a stopped job, pass the job name after `start job`.
     
     You may also run a background job with the `-d` or `--daemon` flags.
-    
+
     Examples:
     
         Create new jobs:
@@ -108,9 +108,9 @@ def _start_jobs(
                 Run the action `sync pipes --loop` as a background job.
                 Generates a random name; e.g. 'happy_seal'.
     
-          - `start api --daemon --name api_server`
+          - `start api --daemon --name api-server`
                 Run the action `start api` as a background job, and assign the job
-                the name 'api_server'.
+                the name 'api-server'.
     
         Start stopped jobs:
     
@@ -119,7 +119,6 @@ def _start_jobs(
     
           - `start job --name happy_seal`
                 Start the job 'happy_seal' but via the `--name` flag.
-                This only applies when no text follows the words 'start job'.
     """
     from meerschaum.utils.warnings import warn, info
     from meerschaum.utils.daemon._names import get_new_daemon_name

meerschaum/api/routes/_jobs.py

@@ -128,7 +128,7 @@ def clean_sysargs(sysargs: List[str]) -> List[str]:
 @app.post(endpoints['jobs'] + '/{name}', tags=['Jobs'])
 def create_job(
     name: str,
-    sysargs: List[str],
+    metadata: Union[List[str], Dict[str, Any]],
     curr_user=(
         fastapi.Depends(manager) if not no_auth else None
     ),
@@ -136,7 +136,14 @@ def create_job(
     """
     Create and start a new job.
     """
-    job = Job(name, clean_sysargs(sysargs), executor_keys=EXECUTOR_KEYS)
+    sysargs = metadata if isinstance(metadata, list) else metadata['sysargs']
+    properties = metadata['properties'] if isinstance(metadata, dict) else None
+    job = Job(
+        name,
+        clean_sysargs(sysargs),
+        executor_keys=EXECUTOR_KEYS,
+        _properties=properties,
+    )
     if job.exists():
         raise fastapi.HTTPException(
             status_code=409,

meerschaum/config/_default.py

@@ -112,6 +112,7 @@ default_system_config = {
         'join_fetch': False,
         'inplace_sync': True,
         'uv_pip': True,
+        'systemd_healthcheck': False,
     },
 }
 default_pipes_config = {

meerschaum/config/_version.py

@@ -2,4 +2,4 @@
 Specify the Meerschaum release version.
 """
 
-__version__ = "2.3.0rc5"
+__version__ = "2.3.2"

meerschaum/connectors/__init__.py

@@ -377,5 +377,4 @@ def _load_builtin_custom_connectors():
     """
     Import custom connectors decorated with `@make_connector` or `@make_executor`.
     """
-    import meerschaum.jobs._SystemdExecutor
-    #  import meerschaum.jobs._LocalExecutor
+    import meerschaum.jobs.systemd

meerschaum/connectors/api/_jobs.py

@@ -12,7 +12,7 @@ import json
 from datetime import datetime
 
 import meerschaum as mrsm
-from meerschaum.utils.typing import Dict, Any, SuccessTuple, List, Union, Callable
+from meerschaum.utils.typing import Dict, Any, SuccessTuple, List, Union, Callable, Optional
 from meerschaum.jobs import Job
 from meerschaum.config.static import STATIC_CONFIG
 from meerschaum.utils.warnings import warn, dprint
@@ -184,11 +184,24 @@ def start_job(self, name: str, debug: bool = False) -> SuccessTuple:
     return tuple(response.json())
 
 
-def create_job(self, name: str, sysargs: List[str], debug: bool = False) -> SuccessTuple:
+def create_job(
+    self,
+    name: str,
+    sysargs: List[str],
+    properties: Optional[Dict[str, str]] = None,
+    debug: bool = False,
+) -> SuccessTuple:
     """
     Create a job.
     """
-    response = self.post(JOBS_ENDPOINT + f"/{name}", json=sysargs, debug=debug)
+    response = self.post(
+        JOBS_ENDPOINT + f"/{name}",
+        json={
+            'sysargs': sysargs,
+            'properties': properties,
+        },
+        debug=debug,
+    )
     if not response:
         if 'detail' in response.text:
             return False, response.json()['detail']

meerschaum/jobs/_Executor.py

@@ -10,7 +10,7 @@ from __future__ import annotations
 from abc import abstractmethod
 
 from meerschaum.connectors import Connector
-from meerschaum.utils.typing import List, Dict, SuccessTuple, TYPE_CHECKING
+from meerschaum.utils.typing import List, Dict, SuccessTuple, TYPE_CHECKING, Optional, Any
 
 if TYPE_CHECKING:
     from meerschaum.jobs import Job
@@ -33,7 +33,13 @@ class Executor(Connector):
         """
 
     @abstractmethod
-    def create_job(self, name: str, sysargs: List[str], debug: bool = False) -> SuccessTuple:
+    def create_job(
+        self,
+        name: str,
+        sysargs: List[str],
+        properties: Optional[Dict[str, Any]] = None,
+        debug: bool = False,
+    ) -> SuccessTuple:
         """
         Create a new job.
         """