meerschaum 2.3.6__py3-none-any.whl → 2.4.0__py3-none-any.whl

meerschaum/api/dash/components.py

@@ -7,27 +7,24 @@ Custom components are defined here.
 """
 
 from __future__ import annotations
-from meerschaum.utils.venv import Venv
+
 from meerschaum.utils.packages import attempt_import, import_dcc, import_html
 from meerschaum.utils.typing import SuccessTuple, List
 from meerschaum.config.static import STATIC_CONFIG
 from meerschaum.utils.misc import remove_ansi
 from meerschaum._internal.shell.Shell import get_shell_intro
 from meerschaum.api import endpoints, CHECK_UPDATE
-from meerschaum.connectors import instance_types
+from meerschaum.connectors import instance_types, _load_builtin_custom_connectors
 from meerschaum.utils.misc import get_connector_labels
 from meerschaum.config import __doc__ as doc
 dbc = attempt_import('dash_bootstrap_components', lazy=False, check_update=CHECK_UPDATE)
 html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
 dex = attempt_import('dash_extensions', lazy=False, check_update=CHECK_UPDATE)
 dash_ace = attempt_import('dash_ace', lazy=False, check_update=CHECK_UPDATE)
-
-component_ids = {
-
-}
+_load_builtin_custom_connectors()
 
 go_button = dbc.Button('Execute', id='go-button', color='primary', style={'width': '100%'})
-test_button = dbc.Button('Test', id='test-button', color='danger', style={'display' : 'none'})
+test_button = dbc.Button('Test', id='test-button', color='danger', style={'display': 'none'})
 get_items_menu = dbc.DropdownMenu(
     label='More', id='get-items-menu', children=[
         dbc.DropdownMenuItem("Plugins", id='get-plugins-button'),
@@ -42,21 +39,21 @@ get_items_menu = dbc.DropdownMenu(
 )
 show_pipes_button = dbc.Button(
     'Pipes',
-    id = 'get-pipes-button',
-    color = 'info',
-    style = {'width': '100%'},
+    id='get-pipes-button',
+    color='info',
+    style={'width': '100%'},
 )
 show_jobs_button = dbc.Button(
     'Jobs',
-    id = 'get-jobs-button',
-    color = 'success',
-    style = {'width': '100%'},
+    id='get-jobs-button',
+    color='success',
+    style={'width': '100%'},
 )
 cancel_button = dbc.Button(
     'Terminal',
-    id = 'cancel-button',
-    color = 'dark',
-    style = {'width': '100%', 'background-color': 'black', 'display': 'none'},
+    id='cancel-button',
+    color='dark',
+    style={'width': '100%', 'background-color': 'black', 'display': 'none'},
 )
 bottom_buttons_content = dbc.Card(
     dbc.CardBody(
@@ -70,28 +67,26 @@ bottom_buttons_content = dbc.Card(
     )
 )
 console_div = html.Div(
-    id = 'console-div',
-    children = [html.Pre(get_shell_intro(), id='console-pre')],
+    id='console-div',
+    children=[html.Pre(get_shell_intro(), id='console-pre')],
 )
 
-location = dcc.Location(id='location', refresh=False)
+location = dcc.Location(id='mrsm-location', refresh=False)
 
 search_parameters_editor = dash_ace.DashAceEditor(
-    id = 'search-parameters-editor',
-    theme = 'monokai',
-    mode = 'json',
-    tabSize = 2,
-    placeholder = (
+    id='search-parameters-editor',
+    theme='monokai',
+    mode='json',
+    tabSize=2,
+    placeholder=(
         'Additional search parameters. ' +
         'Simple dictionary format or JSON accepted.'
     ),
-    style = {'height' : 100},
+    style={'height': 100},
 )
 
 sidebar = dbc.Offcanvas(
-    children=[
-    
-    ],
+    children=[],
     title='Pages',
 )
 
@@ -99,13 +94,13 @@ download_dataframe = dcc.Download(id='download-dataframe-csv')
 download_logs = dcc.Download(id='download-logs')
 
 instance_select = dbc.Select(
-    id = 'instance-select',
-    size = 'sm',
-    options = [
+    id='instance-select',
+    size='sm',
+    options=[
         {'label': i, 'value': i}
         for i in get_connector_labels(*instance_types)
     ],
-    class_name = 'dbc_dark custom-select custom-select-sm',
+    class_name='dbc_dark custom-select custom-select-sm',
 )
 
 
@@ -116,17 +111,17 @@ navbar = dbc.Navbar(
                 dbc.Row(
                     [
                         dbc.Col(
-                                html.Img(
-                                    src = endpoints['dash'] + "/assets/logo_48x48.png",
-                                    title = doc,
-                                ),
+                            html.Img(
+                                src=endpoints['dash'] + "/assets/logo_48x48.png",
+                                title=doc,
+                            ),
                         ),
                     ],
-                    align = 'center',
-                    className = 'g-0 navbar-logo-row',
+                    align='center',
+                    className='g-0 navbar-logo-row',
                 ),
-                href = '/docs',
-                style = {"textDecoration": "none"},
+                href='/docs',
+                style={"textDecoration": "none"},
             ),
             dbc.NavbarToggler(id="navbar-toggler", n_clicks=0),
             dbc.Collapse(
@@ -136,30 +131,30 @@ navbar = dbc.Navbar(
                         dbc.Col(
                             dbc.Button(
                                 "Sign out",
-                                color = 'link',
-                                style = {'margin-left': '30px'},
-                                id = 'sign-out-button',
+                                color='link',
+                                style={'margin-left': '30px'},
+                                id='sign-out-button',
                             ),
                         ),
                     ],
-                    className = "g-0 ms-auto flex-nowrap mt-3 mt-md-0",
+                    className="g-0 ms-auto flex-nowrap mt-3 mt-md-0",
                 ),
-                id = 'navbar-collapse',
-                is_open = False,
-                navbar = True,
+                id='navbar-collapse',
+                is_open=False,
+                navbar=True,
             ),
         ],
-        style = {'max-width': '96%'},
+        style={'max-width': '96%'},
     ),
-    color = 'dark', dark=True,
-    style = {'width': '100% !important'},
+    color='dark', dark=True,
+    style={'width': '100% !important'},
 )
 
 refresh_jobs_interval = dcc.Interval(
-    id = 'refresh-jobs-interval',
-    interval = 1 * 1000,
-    n_intervals = 0,
-    disabled = False,
+    id='refresh-jobs-interval',
+    interval=(1 * 1000),
+    n_intervals=0,
+    disabled=False,
 )
 
 def alert_from_success_tuple(success: SuccessTuple) -> dbc.Alert:
@@ -169,11 +164,11 @@ def alert_from_success_tuple(success: SuccessTuple) -> dbc.Alert:
     return dbc.Alert('', is_open=False) if not isinstance(success, tuple) else (
         dbc.Alert(
             remove_ansi(success[1]),
-            id = 'success-alert',
-            dismissable = True,
-            fade = True,
-            is_open = not (success[1] in STATIC_CONFIG['system']['success']['ignore']),
-            color = 'success' if success[0] else 'danger',
+            id='success-alert',
+            dismissable=True,
+            fade=True,
+            is_open=(success[1] not in STATIC_CONFIG['system']['success']['ignore']),
+            color='success' if success[0] else 'danger',
         )
     )
 

meerschaum/api/dash/jobs.py

@@ -7,24 +7,20 @@ Functions for interacting with jobs via the web interface.
 """
 
 from __future__ import annotations
-from dash.dependencies import Input, Output, State
-from meerschaum.utils.typing import List, Optional, Dict, Any, Tuple, Union, WebState
+from meerschaum.utils.typing import List, Dict, WebState
 from meerschaum.utils.packages import attempt_import, import_html, import_dcc
-from meerschaum.api.dash.components import alert_from_success_tuple, build_cards_grid
-from meerschaum.api.dash.users import is_session_authenticated
+from meerschaum.api.dash.sessions import is_session_authenticated
 from meerschaum.api import CHECK_UPDATE
-dbc = attempt_import('dash_bootstrap_components', lazy=False, check_update=CHECK_UPDATE)
-html, dcc = import_html(), import_dcc()
 from meerschaum.jobs import (
     get_jobs,
-    get_running_jobs,
-    get_paused_jobs,
-    get_stopped_jobs,
     get_executor_keys_from_context,
     Job,
 )
 from meerschaum.config import get_config
 from meerschaum.utils.misc import sorted_dict
+from dash.dependencies import Input, Output, State
+dbc = attempt_import('dash_bootstrap_components', lazy=False, check_update=CHECK_UPDATE)
+html, dcc = import_html(), import_dcc()
 
 STATUS_EMOJI: Dict[str, str] = {
     'running': get_config('formatting', 'emoji', 'running'),

meerschaum/api/dash/pages/__init__.py

@@ -10,3 +10,4 @@ import meerschaum.api.dash.pages.login
 import meerschaum.api.dash.pages.dashboard
 import meerschaum.api.dash.pages.plugins
 import meerschaum.api.dash.pages.register
+import meerschaum.api.dash.pages.pipes

meerschaum/api/dash/pages/pipes.py

@@ -0,0 +1,19 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Display pipes via a shareable URL.
+"""
+
+from meerschaum.api import CHECK_UPDATE
+from meerschaum.utils.packages import import_html, import_dcc
+from meerschaum.api.dash.components import download_dataframe
+
+html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
+import dash_bootstrap_components as dbc
+
+layout = dbc.Container([
+    dcc.Location('pipes-location'),
+    download_dataframe,
+    html.Div(id='pipe-output-div'),
+])

meerschaum/api/dash/pipes.py

@@ -12,18 +12,16 @@ import shlex
 from textwrap import dedent
 from dash.dependencies import Input, Output, State
 from meerschaum.utils.typing import List, Optional, Dict, Any, Tuple, Union
-from meerschaum.utils.misc import string_to_dict, json_serialize_datetime
+from meerschaum.utils.misc import string_to_dict
 from meerschaum.utils.packages import attempt_import, import_dcc, import_html, import_pandas
 from meerschaum.utils.sql import get_pd_type
 from meerschaum.utils.yaml import yaml
 from meerschaum.connectors.sql._fetch import get_pipe_query
-from meerschaum.api import endpoints, CHECK_UPDATE
-from meerschaum.api.dash import (
-    dash_app, debug, _get_pipes
-)
+from meerschaum.api import CHECK_UPDATE
+from meerschaum.api.dash import debug, _get_pipes
 from meerschaum.api.dash.connectors import get_web_connector
 from meerschaum.api.dash.components import alert_from_success_tuple, build_cards_grid
-from meerschaum.api.dash.users import is_session_authenticated
+from meerschaum.api.dash.sessions import is_session_authenticated
 from meerschaum.config import get_config
 import meerschaum as mrsm
 dbc = attempt_import('dash_bootstrap_components', lazy=False, check_update=CHECK_UPDATE)
@@ -48,13 +46,14 @@ def pipe_from_ctx(ctx, trigger_property: str = 'n_clicks') -> Union[mrsm.Pipe, N
         return None
     return mrsm.Pipe(**meta)
 
+
 def keys_from_state(
-        state: Dict[str, Any],
-        with_params: bool = False
-    ) -> Union[
-        Tuple[List[str], List[str], List[str]],
-        Tuple[List[str], List[str], List[str], str],
-    ]:
+    state: Dict[str, Any],
+    with_params: bool = False
+) -> Union[
+    Tuple[List[str], List[str], List[str]],
+    Tuple[List[str], List[str], List[str], str],
+]:
     """
     Read the current state and return the selected keys lists.
     """
@@ -85,10 +84,11 @@ def keys_from_state(
         keys.append(params)
     return tuple(keys)
 
+
 def pipes_from_state(
-        state: Dict[str, Any],
-        **kw
-    ):
+    state: Dict[str, Any],
+    **kw
+):
     _ck, _mk, _lk, _params = keys_from_state(state, with_params=True)
     try:
         _pipes = _get_pipes(
@@ -103,10 +103,10 @@ def pipes_from_state(
 
 
 def build_pipe_card(
-        pipe: mrsm.Pipe,
-        authenticated: bool = False,
-        _build_children_num: int = 10,
-    ) -> 'dbc.Card':
+    pipe: mrsm.Pipe,
+    authenticated: bool = False,
+    _build_children_num: int = 10,
+) -> 'dbc.Card':
     """
     Return a card for the given pipe.
 
@@ -128,11 +128,11 @@ def build_pipe_card(
             dbc.Col(
                 (
                     dbc.DropdownMenu(
-                        label = "Manage",
-                        children = [
+                        label="Manage",
+                        children=[
                             dbc.DropdownMenuItem(
                                 'Open in Python',
-                                id = {
+                                id={
                                     'type': 'manage-pipe-button',
                                     'index': meta_str,
                                     'action': 'python',
@@ -140,7 +140,7 @@ def build_pipe_card(
                             ),
                             dbc.DropdownMenuItem(
                                 'Delete',
-                                id = {
+                                id={
                                     'type': 'manage-pipe-button',
                                     'index': meta_str,
                                     'action': 'delete',
@@ -148,7 +148,7 @@ def build_pipe_card(
                             ),
                             dbc.DropdownMenuItem(
                                 'Drop',
-                                id = {
+                                id={
                                     'type': 'manage-pipe-button',
                                     'index': meta_str,
                                     'action': 'drop',
@@ -156,7 +156,7 @@ def build_pipe_card(
                             ),
                             dbc.DropdownMenuItem(
                                 'Clear',
-                                id = {
+                                id={
                                     'type': 'manage-pipe-button',
                                     'index': meta_str,
                                     'action': 'clear',
@@ -164,7 +164,7 @@ def build_pipe_card(
                             ),
                             dbc.DropdownMenuItem(
                                 'Verify',
-                                id = {
+                                id={
                                     'type': 'manage-pipe-button',
                                     'index': meta_str,
                                     'action': 'verify',
@@ -172,56 +172,84 @@ def build_pipe_card(
                             ),
                             dbc.DropdownMenuItem(
                                 'Sync',
-                                id = {
+                                id={
                                     'type': 'manage-pipe-button',
                                     'index': meta_str,
                                     'action': 'sync',
                                 },
                             ),
                         ],
-                        direction = "up",
-                        menu_variant = "dark",
-                        size = 'sm',
-                        color = 'secondary',
+                        direction="up",
+                        menu_variant="dark",
+                        size='sm',
+                        color='secondary',
                     )
                 ) if authenticated else [],
-                width = 2,
+                width=2,
             ),
             dbc.Col(width=6),
             dbc.Col(
                 dbc.Button(
                     'Download CSV',
-                    size = 'sm',
-                    color = 'link',
-                    style = {'float': 'right'},
-                    id = {'type': 'pipe-download-csv-button', 'index': meta_str},
+                    size='sm',
+                    color='link',
+                    style={'float': 'right'},
+                    id={'type': 'pipe-download-csv-button', 'index': meta_str},
                 ),
-                width = 4,
+                width=4,
             ),
         ],
-        justify = 'start',
+        justify='start',
     )
     card_body_children = [
-        html.H5(
-            html.B(str(pipe)),
-            className = 'card-title',
-            style = {'font-family': ['monospace']}
-        ),
         html.Div(
             dbc.Accordion(
                 accordion_items_from_pipe(
                     pipe,
-                    authenticated = authenticated,
-                    _build_children_num = _build_children_num,
+                    authenticated=authenticated,
+                    _build_children_num=_build_children_num,
                 ),
-                flush = True,
-                start_collapsed = True,
-                id = {'type': 'pipe-accordion', 'index': meta_str},
+                flush=True,
+                start_collapsed=True,
+                id={'type': 'pipe-accordion', 'index': meta_str},
             )
         )
 
     ]
+
+    pipe_url = (
+        f"/dash/pipes/{pipe.connector_keys}/{pipe.metric_key}/{pipe.location_key}"
+    )
+
+    card_header_children = dbc.Row(
+        [
+            dbc.Col(
+                html.H5(
+                    html.B(str(pipe)),
+                    className='card-title',
+                    style={'font-family': ['monospace']}
+                ),
+                width=11,
+            ),
+            dbc.Col(
+                dbc.Button(
+                    "🔗",
+                    href=pipe_url,
+                    external_link=True,
+                    target="_blank",
+                    style={'float': 'right'},
+                    outline=True,
+                    color='link',
+                    id={'type': 'share-pipe-button', 'index': meta_str},
+                ),
+                width=1,
+            ),
+        ],
+        justify='start',
+    )
+
     return dbc.Card([
+        dbc.CardHeader(children=card_header_children),
         dbc.CardBody(children=card_body_children),
         dbc.CardFooter(children=footer_children),
     ])
@@ -270,11 +298,11 @@ def get_pipes_cards(*keys, session_data: Optional[Dict[str, Any]] = None):
 
 
 def accordion_items_from_pipe(
-        pipe: mrsm.Pipe,
-        active_items: Optional[List[str]] = None,
-        authenticated: bool = False,
-        _build_children_num: int = 10,
-    ) -> 'List[dbc.AccordionItem]':
+    pipe: mrsm.Pipe,
+    active_items: Optional[List[str]] = None,
+    authenticated: bool = False,
+    _build_children_num: int = 10,
+) -> 'List[dbc.AccordionItem]':
     """
     Build the accordion items for a given pipe.
     """
@@ -521,11 +549,11 @@ def accordion_items_from_pipe(
         backtrack_df = pipe.get_backtrack_data(debug=debug, limit=1)
         try:
             json_text = backtrack_df.fillna(pd.NA).to_json(
-                orient = 'records',
-                date_format = 'iso',
-                force_ascii = False,
-                indent = 4,
-                date_unit = 'ns',
+                orient='records',
+                date_format='iso',
+                force_ascii=False,
+                indent=4,
+                date_unit='ns',
             ) if backtrack_df is not None else '[]'
         except Exception as e:
             warn(e)

meerschaum/api/dash/plugins.py

@@ -13,7 +13,8 @@ from meerschaum.api import get_api_connector, endpoints, CHECK_UPDATE
 html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
 import dash_bootstrap_components as dbc
 from meerschaum.core import Plugin
-from meerschaum.api.dash import dash_app, debug, active_sessions
+from meerschaum.api.dash import dash_app, debug
+from meerschaum.api.dash.sessions import get_username_from_session
 
 
 def get_plugins_cards(
@@ -88,9 +89,10 @@ def is_plugin_owner(plugin_name: str, session_data: Dict['str', Any]) -> bool:
     Check whether the currently logged in user is the owner of a plugin.
     """
     plugin = Plugin(plugin_name)
-    _username = active_sessions.get(
-        session_data.get('session-id', None), {}
-    ).get('username', None)
+    session_id = session_data.get('session-id', None)
+    if session_id is None:
+        return False
+    _username = get_username_from_session(session_id)
     _plugin_username = get_api_connector().get_plugin_username(plugin, debug=debug)
     return (
         _username is not None