meerschaum 2.2.5.dev2__tar.gz → 2.2.5.dev3__tar.gz

{meerschaum-2.2.5.dev2/meerschaum.egg-info → meerschaum-2.2.5.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meerschaum
-Version: 2.2.5.dev2
+Version: 2.2.5.dev3
 Summary: Sync Time-Series Pipes with Meerschaum
 Home-page: https://meerschaum.io
 Author: Bennett Meares

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum/_internal/arguments/_parser.py

@@ -158,7 +158,6 @@ groups['actions'].add_argument(
     '-d', '--daemon', action='store_true',
     help = "Run an action as a background daemon."
 )
-
 groups['actions'].add_argument(
     '--rm', action='store_true', help="Delete a job once it has finished executing."
 )

meerschaum-2.2.5.dev3/meerschaum/_internal/docs/index.py

@@ -0,0 +1,40 @@
+#! /usr/bin/env python
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+
+"""
+<img src="https://meerschaum.io/assets/banner_1920x320.png" alt="Meerschaum banner" style="width: 100%;"/>
+
+# Meerschaum Python API
+
+Welcome to the Meerschaum Python API technical documentation!
+
+- `meerschaum.actions`  
+  Access functions for actions and subactions.
+- `meerschaum.connectors`
+- `meerschaum.utils`  
+  Utility functions are available in several submodules, such as functions for:
+  - `meerschaum.utils.daemon`  
+    Managing background processes.\n
+  - `meerschaum.utils.dataframe`  
+    Manipulating dataframes.\n
+  - `meerschaum.utils.dtypes`  
+    Working with data types.\n
+  - `meerschaum.utils.formatting`  
+    Formatting output text.\n
+  - `meerschaum.utils.misc`  
+    Miscellaneous utility functions (e.g. `meerschaum.utils.misc.round_time()`).\n
+  - `meerschaum.utils.packages`  
+    Managing Python packages.\n
+  - `meerschaum.utils.prompt`  
+    Reading input from the user.\n
+  - `meerschaum.utils.schedule`  
+    Scheduling processes and threads.\n
+  - `meerschaum.utils.sql`  
+    Building SQL queries.\n
+  - `meerschaum.utils.venv`  
+    Managing virtual environments.\n
+  - `meerschaum.utils.warnings`  
+    Print warnings, errors, info, and debug messages.
+
+"""

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum/actions/show.py

@@ -219,15 +219,24 @@ def _show_connectors(
     from meerschaum.config import get_config
     from meerschaum.utils.formatting import make_header
     from meerschaum.utils.formatting import pprint
+
+    conn_type = action[0].split(':')[0] if action else None
+
     if not nopretty:
-        print(make_header("\nConfigured connectors:"))
-    pprint(get_config('meerschaum', 'connectors'), nopretty=nopretty)
-    if not nopretty:
+        print(make_header(
+            f"""\nConfigured {"'" + (conn_type + "' ") if conn_type else ''}Connectors:"""
+        ))
+
+    keys = ['meerschaum', 'connectors']
+    if conn_type:
+        keys.append(conn_type)
+    pprint(get_config(*keys), nopretty=nopretty)
+    if not nopretty and not conn_type:
         print(make_header("\nActive connectors:"))
         pprint(connectors, nopretty=nopretty)
 
     from meerschaum.connectors.parse import parse_instance_keys
-    if action:
+    if action and ':' in action[0]:
         attr, keys = parse_instance_keys(action[0], construct=False, as_tuple=True, debug=debug)
         if attr:
             if not nopretty:

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum/actions/stack.py

@@ -7,7 +7,7 @@ Functions for running the Docker Compose stack
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import SuccessTuple, Any, List, Optional
+from meerschaum.utils.typing import SuccessTuple, Any, List, Optional, Union
 
 def stack(
         action: Optional[List[str]] = None,
@@ -19,7 +19,7 @@ def stack(
         debug: bool = False,
         _capture_output: bool = False,
         **kw: Any
-    ) -> SuccessTuple:
+    ) -> Union[SuccessTuple, 'subprocess.Popen']:
     """
     Control the Meerschaum stack with Docker Compose.
     Usage: `stack {command}`
@@ -147,18 +147,18 @@ def stack(
             ['docker', 'compose'] if has_builtin_compose
             else ['docker-compose']
         ) + cmd_list,
-        cwd = STACK_COMPOSE_PATH.parent,
-        stdout = stdout,
-        stderr = stderr,
-        env = stack_env_dict,
+        cwd=STACK_COMPOSE_PATH.parent,
+        stdout=stdout,
+        stderr=stderr,
+        env=stack_env_dict,
     ) if (has_builtin_compose or has_binary_compose) else run_python_package(
         'compose',
-        args = cmd_list,
-        cwd = STACK_COMPOSE_PATH.parent,
-        venv = _compose_venv,
-        capture_output = _capture_output,
-        as_proc = True,
-        env = stack_env_dict,
+        args=cmd_list,
+        cwd=STACK_COMPOSE_PATH.parent,
+        venv=_compose_venv,
+        capture_output=_capture_output,
+        as_proc=True,
+        env=stack_env_dict,
     )
     try:
         rc = proc.wait() if proc is not None else 1

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum/api/__init__.py

@@ -237,4 +237,3 @@ for module_name, functions_list in _api_plugins.items():
                 + f"when executing function '{function.__name__}' with exception:\n{e}",
                 stack=False,
             )
-

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum/api/dash/__init__.py

@@ -50,7 +50,6 @@ stylesheets = [
     '/static/css/bootstrap.min.css',
     '/static/css/dbc_dark.css',
     '/static/css/dash.css',
-    #  '/static/js/node_modules/xterm/css/xterm.css',
 ]
 scripts = ['/static/js/node_modules/xterm/lib/xterm.js']
 dash_app = enrich.DashProxy(

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum/api/dash/callbacks/custom.py

@@ -21,7 +21,7 @@ def init_dash_plugins():
         for _function in _functions:
             try:
                 _function(dash_app)
-            except Exception as e:
+            except Exception:
                 warn(
                     f"Failed to load function '{_function.__name__}' "
                     + f"from plugin '{_module_name}':\n"

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum/api/dash/plugins.py

@@ -7,7 +7,7 @@ Functions for interacting with plugins via the web interface.
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import List, Tuple, SuccessTuple
+from meerschaum.utils.typing import List, Tuple, SuccessTuple, Optional, WebState, Dict, Any
 from meerschaum.utils.packages import import_dcc, import_html
 from meerschaum.api import get_api_connector, endpoints, CHECK_UPDATE
 html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
@@ -17,10 +17,10 @@ from meerschaum.api.dash import dash_app, debug, active_sessions
 
 
 def get_plugins_cards(
-        state: Optional[WebState] = None,
-        search_term: Optional[str] = None,
-        session_data: Optional[Dict[str, Any]] = None,
-    ) -> Tuple[List[dbc.Card], List[SuccessTuple]]:
+    state: Optional[WebState] = None,
+    search_term: Optional[str] = None,
+    session_data: Optional[Dict[str, Any]] = None,
+) -> Tuple[List[dbc.Card], List[SuccessTuple]]:
     """
     Return the cards and alerts for plugins.
     """
@@ -96,4 +96,3 @@ def is_plugin_owner(plugin_name: str, session_data: Dict['str', Any]) -> bool:
         _username is not None
         and _username == _plugin_username
     )
-

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum/config/_version.py

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

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum/utils/warnings.py

@@ -8,6 +8,7 @@ Handle all things warnings and errors here
 
 from __future__ import annotations
 from meerschaum.utils.typing import Any, Union
+from meerschaum.utils.debug import dprint
 
 import sys
 import warnings

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3/meerschaum.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meerschaum
-Version: 2.2.5.dev2
+Version: 2.2.5.dev3
 Summary: Sync Time-Series Pipes with Meerschaum
 Home-page: https://meerschaum.io
 Author: Bennett Meares

{meerschaum-2.2.5.dev2 → meerschaum-2.2.5.dev3}/meerschaum.egg-info/SOURCES.txt

@@ -33,7 +33,6 @@ meerschaum/_internal/term/__init__.py
 meerschaum/_internal/term/tools.py
 meerschaum/actions/__init__.py
 meerschaum/actions/api.py
-meerschaum/actions/backup.py
 meerschaum/actions/bootstrap.py
 meerschaum/actions/clear.py
 meerschaum/actions/copy.py

meerschaum-2.2.5.dev2/meerschaum/_internal/docs/index.py

@@ -1,134 +0,0 @@
-#! /usr/bin/env python
-# -*- coding: utf-8 -*-
-# vim:fenc=utf-8
-
-"""
-<img src="https://meerschaum.io/assets/banner_1920x320.png" alt="Meerschaum banner" style="width: 100%;"/>
-
-| PyPI | GitHub | Info | Stats |
-|---|---|---|---|
-| ![PyPI]( https://img.shields.io/pypi/v/meerschaum?color=%2300cc66&label=Version ) | ![GitHub Repo stars](https://img.shields.io/github/stars/bmeares/Meerschaum?style=social) | ![License](https://img.shields.io/github/license/bmeares/Meerschaum?label=License) | ![Number of plugins]( https://img.shields.io/badge/dynamic/json?color=3098c1&label=Public%20Plugins&query=num_plugins&url=https%3A%2F%2Fapi.mrsm.io%2Finfo ) |
-| ![PyPI - Python Version]( https://img.shields.io/pypi/pyversions/meerschaum?label=Python&logo=python&logoColor=%23ffffff ) | ![GitHub Sponsors](https://img.shields.io/github/sponsors/bmeares?color=eadf15&label=Sponsors) | [![meerschaum Tutorials](https://badges.openbase.com/python/tutorials/meerschaum.svg?token=2Yi8Oav9UZYWocO1ncwnIOnpUN5dTnUMWai7lAKTB+k=)](https://openbase.com/python/meerschaum?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge) | ![Number of registered users]( https://img.shields.io/badge/dynamic/json?color=3098c1&label=Registered%20Users&query=num_users&url=https%3A%2F%2Fapi.mrsm.io%2Finfo ) |
-
-<p align="center">
-<img src="https://meerschaum.io/files/images/demo.gif" alt="Meerschaum demo" style="width: 100%;">
-</p>
-
-## What is Meerschaum?
-Meerschaum is a tool for quickly synchronizing time-series data streams called **pipes**. With Meerschaum, you can have a data visualization stack running in minutes.
-
-<p align="center">
-<img src="https://meerschaum.io/assets/screenshots/weather_pipes.png" style="width: 100%;"/>
-</p>
-
-## Why Meerschaum?
-
-If you've worked with time-series data, you know the headaches that come with ETL.
-Data engineering often gets in analysts' way, and when work needs to get done, every minute spent on pipelining is time taken away from real analysis.
-
-Rather than copy / pasting your ETL scripts, simply build pipes with Meerschaum! [Meerschaum gives you the tools to design your data streams how you like](https://towardsdatascience.com/easy-time-series-etl-for-data-scientists-with-meerschaum-5aade339b398) ― and don't worry — you can always incorporate Meerschaum into your existing systems!
-
-## Features
-
-- 📊 **Built for Data Scientists and Analysts**  
-    - Integrate with Pandas, Grafana and other popular [data analysis tools](https://meerschaum.io/reference/data-analysis-tools/).
-    - Persist your dataframes and always get the latest data.
-- ⚡️ **Production-Ready, Batteries Included**  
-    - [Synchronization engine](https://meerschaum.io/reference/pipes/syncing/) concurrently updates many time-series data streams.
-    - One-click deploy a [TimescaleDB and Grafana stack](https://meerschaum.io/reference/stack/) for prototyping.
-    - Serve data to your entire organization through the power of `uvicorn`, `gunicorn`, and `FastAPI`.
-- 🔌 **Easily Expandable**  
-    -  Ingest any data source with a simple [plugin](https://meerschaum.io/reference/plugins/writing-plugins/). Just return a DataFrame, and Meerschaum handles the rest.
-    - [Add any function as a command](https://meerschaum.io/reference/plugins/types-of-plugins/#action-plugins) to the Meerschaum system.
-    - Include Meerschaum in your projects with its [easy-to-use Python API](https://docs.meerschaum.io).
-- ✨ **Tailored for Your Experience**  
-    - Rich CLI makes managing your data streams surprisingly enjoyable!
-    - Web dashboard for those who prefer a more graphical experience.
-    - Manage your database connections with [Meerschaum connectors](https://meerschaum.io/reference/connectors/)
-    - Utility commands with sensible syntax let you control many pipes with grace.
-- 💼 **Portable from the Start**  
-    - The environment variables `$MRSM_ROOT_DIR`, `$MRSM_PLUGINS_DIR`, and `$MRSM_VENVS_DIR` let you emulate multiple installations and group together your [instances](https://meerschaum.io/reference/connectors/#instances-and-repositories).
-    - No dependencies required; anything needed will be installed into virtual environments.
-    - [Specify required packages for your plugins](https://meerschaum.io/reference/plugins/writing-plugins/), and users will get those packages in a virtual environment.
-
-## Installation
-
-For a more thorough setup guide, visit the [Getting Started](https://meerschaum.io/get-started/) page at [meerschaum.io](https://meerschaum.io).
-
-### TL;DR
-
-```bash
-pip install -U --user meerschaum
-mrsm stack up -d db grafana
-mrsm bootstrap pipes
-```
-
-## Usage Documentation
-
-Please visit [meerschaum.io](https://meerschaum.io) for setup, usage, and troubleshooting information. You can find technical documentation at [docs.meerschaum.io](https://docs.meerschaum.io), and here is a complete list of the [Meerschaum actions](https://meerschaum.io/reference/actions/).
-
-```python
->>> import meerschaum as mrsm
->>> pipe = mrsm.Pipe("plugin:noaa", "weather")
->>> cols_to_select = ['timestamp', 'station', 'temperature (degC)']
->>> df = pipe.get_data(cols_to_select, begin='2023-11-15', end='2023-11-20')
->>> df
-              timestamp station  temperature (degC)
-0   2023-11-15 00:52:00    KATL                16.1
-1   2023-11-15 00:52:00    KCLT                11.7
-2   2023-11-15 00:53:00    KGMU                15.0
-3   2023-11-15 00:54:00    KCEU                13.9
-4   2023-11-15 01:52:00    KATL                15.6
-..                  ...     ...                 ...
-535 2023-11-19 22:54:00    KCEU                15.6
-536 2023-11-19 23:52:00    KATL                16.7
-537 2023-11-19 23:52:00    KCLT                13.9
-538 2023-11-19 23:53:00    KGMU                15.6
-539 2023-11-19 23:54:00    KCEU                15.0
-
-[540 rows x 3 columns]
->>>
-```
-
-## Plugins
-
-Check out the [Awesome Meerschaum list](https://github.com/bmeares/awesome-meerschaum) for a list of community plugins as well as the [public plugins repository](https://api.mrsm.io/dash/plugins).
-
-For details on installing, using, and writing plugins, check out the [plugins documentation](https://meerschaum.io/reference/plugins/types-of-plugins) at [meerschaum.io](https://meerschaum.io).
-
-#### Example Plugin
-
-```python
-# ~/.config/meerschaum/plugins/example.py
-__version__ = '0.0.1'
-required = []
-
-def register(pipe, **kw):
-    return {
-        'columns': {
-            'datetime': 'dt',
-            'id': 'id',
-            'value': 'val',
-        }
-    }
-
-def fetch(pipe, **kw):
-    import random
-    from datetime import datetime
-    docs = [
-        {
-            'dt': datetime.now(),
-            'id': i,
-            'val': random.ranint(0, 200),
-        }
-        for i in range(random.randint(0, 100))
-    ]
-    return docs
-```
-
-## Support Meerschaum's Development
-
-For consulting services and to support Meerschaum's development, please considering sponsoring me on [GitHub sponsors](https://github.com/sponsors/bmeares).
-
-Additionally, you can always [buy me a coffee☕](https://www.buymeacoffee.com/bmeares)!
-"""

meerschaum-2.2.5.dev2/meerschaum/actions/backup.py

@@ -1,43 +0,0 @@
-#! /usr/bin/env python3
-# -*- coding: utf-8 -*-
-# vim:fenc=utf-8
-
-"""
-Backup the stack database.
-"""
-
-from __future__ import annotations
-from meerschaum.utils.typing import SuccessTuple, Any, List, Optional, Union
-
-def backup(
-        action: Optional[List[str]] = None,
-        **kwargs: Any
-    ) -> SuccessTuple:
-    """
-    Backup the stack database.
-    """
-    from meerschaum.actions import choose_subaction
-    options = {
-        'database'        : _backup_database,
-    }
-    return choose_subaction(action, options, **kwargs)
-
-
-def _backup_database(
-        action: Optional[List[str]] = None,
-    ) -> SuccessTuple:
-    """
-    Backup the stack's database to a sql file.
-    """
-    from meerschaum.actions import get_action
-    from meerschaum.config.paths import BACKUP_RESOURCES_PATH
-    do_stack = get_action('stack')
-    cmd_list = ['exec', 'db', 'pg']
-    stack_success, stack_msg = do_stack(['exec'])
-    return True, "Success"
-
-### NOTE: This must be the final statement of the module.
-###       Any subactions added below these lines will not
-###       be added to the `help` docstring.
-from meerschaum.utils.misc import choices_docstring as _choices_docstring
-backup.__doc__ += _choices_docstring('backup')