meerschaum 2.3.5.dev0__py3-none-any.whl → 2.4.0__py3-none-any.whl

meerschaum/api/dash/callbacks/login.py

@@ -7,14 +7,17 @@ Callbacks for the login page.
 """
 
 from __future__ import annotations
-from meerschaum.api import endpoints, no_auth, CHECK_UPDATE
-from meerschaum.utils.packages import attempt_import, import_html, import_dcc
-dash = attempt_import('dash', lazy=False, check_update=CHECK_UPDATE)
 import uuid
+
+from meerschaum.api import CHECK_UPDATE
+from meerschaum.utils.packages import attempt_import, import_html, import_dcc
 from meerschaum.utils.typing import Optional
+
+dash = attempt_import('dash', lazy=False, check_update=CHECK_UPDATE)
 from dash.exceptions import PreventUpdate
 from dash.dependencies import Input, Output, State
-from meerschaum.api.dash import dash_app, debug, pipes, _get_pipes, active_sessions
+from meerschaum.api.dash import dash_app, debug, pipes, _get_pipes
+from meerschaum.api.dash.sessions import set_session
 from meerschaum.api.dash.connectors import get_web_connector
 from meerschaum.api.routes._login import login
 from meerschaum.api.dash.components import alert_from_success_tuple
@@ -23,6 +26,7 @@ from fastapi.exceptions import HTTPException
 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)
 
+
 @dash_app.callback(
     Output('user-registration-disabled-collapse', 'is_open'),
     Input('show-user-registration-disabled-button', 'n_clicks'),
@@ -36,18 +40,19 @@ def show_registration_disabled_collapse(n_clicks, is_open):
         return not is_open
     return is_open
 
+
 @dash_app.callback(
     Output('session-store', 'data'),
     Output('username-input', 'className'),
-    Output('location', 'pathname'),
+    Output('mrsm-location', 'pathname'),
     Output('login-alert-div', 'children'),
     Input('username-input', 'n_submit'),
     Input('password-input', 'n_submit'),
     Input('login-button', 'n_clicks'),
     State('username-input', 'value'),
     State('password-input', 'value'),
-    State('location', 'href'),
-    State('location', 'pathname'),
+    State('mrsm-location', 'href'),
+    State('mrsm-location', 'pathname'),
 )
 def login_button_click(
     username_submit,
@@ -69,11 +74,12 @@ def login_button_click(
 
     try:
         _ = login({'username': username, 'password': password})
+        session_id = str(uuid.uuid4())
         session_data = {
-            'session-id': str(uuid.uuid4()),
-            'location.href': location_href,
+            'session-id': session_id,
+            'mrsm-location.href': location_href,
         }
-        active_sessions[session_data['session-id']] = {'username': username}
+        set_session(session_id, {'username': username})
         alerts = []
     except HTTPException:
         form_class += ' is-invalid'

meerschaum/api/dash/callbacks/pipes.py

@@ -0,0 +1,41 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define callbacks for the `/dash/pipes/` page.
+"""
+
+from dash.dependencies import Input, Output
+from dash import no_update
+
+import meerschaum as mrsm
+from meerschaum.api.dash import dash_app
+from meerschaum.api.dash.pipes import build_pipe_card
+from meerschaum.api import CHECK_UPDATE
+from meerschaum.utils.packages import import_html, import_dcc
+html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
+
+
+@dash_app.callback(
+    Output('pipe-output-div', 'children'),
+    Input('pipes-location', 'pathname'),
+)
+def render_page_from_url(pathname):
+    if not str(pathname).startswith('/dash/pipes'):
+        return no_update
+
+    keys = pathname.replace('/dash/pipes', '').lstrip('/').rstrip('/').split('/')
+    if len(keys) not in (2, 3):
+        return no_update
+
+    ck = keys[0]
+    mk = keys[1]
+    lk = keys[2] if len(keys) == 3 else None
+
+    pipe = mrsm.Pipe(ck, mk, lk)
+    ### TODO Check if logged in
+    return [
+        html.Br(),
+        build_pipe_card(pipe, authenticated=False),
+        html.Br(),
+    ]

meerschaum/api/dash/callbacks/plugins.py

@@ -9,7 +9,7 @@ Callbacks for the plugins page.
 from __future__ import annotations
 import json
 from meerschaum.utils.typing import Optional, Dict, Any
-from meerschaum.api.dash import dash_app, debug, active_sessions
+from meerschaum.api.dash import dash_app, debug
 from meerschaum.api import get_api_connector, endpoints, CHECK_UPDATE
 from meerschaum.core import Plugin
 from meerschaum.utils.packages import attempt_import, import_dcc, import_html

meerschaum/api/dash/callbacks/register.py

@@ -8,7 +8,8 @@ Callbacks for the registration page.
 
 import uuid
 from meerschaum.api import get_api_connector, endpoints, CHECK_UPDATE
-from meerschaum.api.dash import dash_app, debug, active_sessions
+from meerschaum.api.dash import dash_app, debug
+from meerschaum.api.dash.sessions import set_session
 from dash.dependencies import Input, Output, State, ALL, MATCH
 from dash.exceptions import PreventUpdate
 from meerschaum.core import User
@@ -57,7 +58,7 @@ def validate_email(email):
 @dash_app.callback(
     Output('session-store', 'data'),
     Output('register-username-input', 'className'),
-    Output('location', 'pathname'),
+    Output('mrsm-location', 'pathname'),
     Input('register-username-input', 'n_submit'),
     Input('register-password-input', 'n_submit'),
     Input('register-button', 'n_clicks'),
@@ -66,13 +67,16 @@ def validate_email(email):
     State("register-email-input", "value"),
 )
 def register_button_click(
-        username_submit,
-        password_submit,
-        n_clicks,
-        username,
-        password,
-        email,
-    ):
+    username_submit,
+    password_submit,
+    n_clicks,
+    username,
+    password,
+    email,
+):
+    """
+    Register the user and redirect to the console.
+    """
     if not n_clicks:
         raise PreventUpdate
     form_class = 'form-control'
@@ -93,9 +97,9 @@ def register_button_click(
         form_class += ' is-invalid'
         return {}, form_class, dash.no_update
     try:
-        token_dict = login({'username': username, 'password': password})
+        _ = login({'username': username, 'password': password})
         session_data = {'session-id': str(uuid.uuid4())}
-        active_sessions[session_data['session-id']] = {'username': username}
+        set_session(session_data['session-id'], {'username': username})
     except HTTPException as e:
         form_class += ' is-invalid'
         session_data = None

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'),
+])