meerschaum 2.2.5.dev2__py3-none-any.whl → 2.2.6__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. meerschaum/__init__.py +4 -1
  2. meerschaum/_internal/arguments/_parser.py +13 -3
  3. meerschaum/_internal/docs/index.py +513 -110
  4. meerschaum/_internal/term/__init__.py +2 -2
  5. meerschaum/actions/bootstrap.py +13 -14
  6. meerschaum/actions/python.py +11 -8
  7. meerschaum/actions/register.py +130 -32
  8. meerschaum/actions/show.py +92 -75
  9. meerschaum/actions/stack.py +12 -12
  10. meerschaum/actions/stop.py +11 -11
  11. meerschaum/api/__init__.py +0 -1
  12. meerschaum/api/dash/__init__.py +0 -1
  13. meerschaum/api/dash/callbacks/custom.py +1 -1
  14. meerschaum/api/dash/callbacks/login.py +21 -13
  15. meerschaum/api/dash/pages/login.py +2 -2
  16. meerschaum/api/dash/plugins.py +5 -6
  17. meerschaum/api/routes/_login.py +5 -5
  18. meerschaum/config/__init__.py +8 -1
  19. meerschaum/config/_paths.py +20 -2
  20. meerschaum/config/_version.py +1 -1
  21. meerschaum/config/paths.py +21 -2
  22. meerschaum/config/static/__init__.py +1 -0
  23. meerschaum/connectors/Connector.py +7 -2
  24. meerschaum/connectors/__init__.py +7 -5
  25. meerschaum/connectors/api/APIConnector.py +7 -2
  26. meerschaum/connectors/api/_actions.py +23 -31
  27. meerschaum/connectors/api/_uri.py +5 -5
  28. meerschaum/core/Pipe/__init__.py +7 -3
  29. meerschaum/core/Pipe/_data.py +23 -15
  30. meerschaum/core/Pipe/_deduplicate.py +1 -1
  31. meerschaum/core/Pipe/_dtypes.py +5 -0
  32. meerschaum/core/Pipe/_fetch.py +18 -16
  33. meerschaum/core/Pipe/_sync.py +20 -15
  34. meerschaum/plugins/_Plugin.py +6 -6
  35. meerschaum/plugins/__init__.py +1 -1
  36. meerschaum/utils/daemon/RotatingFile.py +15 -16
  37. meerschaum/utils/dataframe.py +12 -4
  38. meerschaum/utils/debug.py +9 -15
  39. meerschaum/utils/formatting/__init__.py +13 -12
  40. meerschaum/utils/misc.py +117 -11
  41. meerschaum/utils/packages/__init__.py +7 -1
  42. meerschaum/utils/typing.py +1 -0
  43. meerschaum/utils/venv/__init__.py +5 -1
  44. meerschaum/utils/warnings.py +9 -1
  45. meerschaum/utils/yaml.py +2 -2
  46. {meerschaum-2.2.5.dev2.dist-info → meerschaum-2.2.6.dist-info}/METADATA +1 -1
  47. {meerschaum-2.2.5.dev2.dist-info → meerschaum-2.2.6.dist-info}/RECORD +53 -54
  48. {meerschaum-2.2.5.dev2.dist-info → meerschaum-2.2.6.dist-info}/WHEEL +1 -1
  49. meerschaum/actions/backup.py +0 -43
  50. {meerschaum-2.2.5.dev2.dist-info → meerschaum-2.2.6.dist-info}/LICENSE +0 -0
  51. {meerschaum-2.2.5.dev2.dist-info → meerschaum-2.2.6.dist-info}/NOTICE +0 -0
  52. {meerschaum-2.2.5.dev2.dist-info → meerschaum-2.2.6.dist-info}/entry_points.txt +0 -0
  53. {meerschaum-2.2.5.dev2.dist-info → meerschaum-2.2.6.dist-info}/top_level.txt +0 -0
  54. {meerschaum-2.2.5.dev2.dist-info → meerschaum-2.2.6.dist-info}/zip-safe +0 -0
meerschaum/__init__.py CHANGED
@@ -23,7 +23,7 @@ from meerschaum.utils.typing import SuccessTuple
23
23
  from meerschaum.core.Pipe import Pipe
24
24
  from meerschaum.plugins import Plugin
25
25
  from meerschaum.utils.venv import Venv
26
- from meerschaum.connectors import get_connector
26
+ from meerschaum.connectors import get_connector, Connector, make_connector
27
27
  from meerschaum.utils import get_pipes
28
28
  from meerschaum.utils.formatting import pprint
29
29
  from meerschaum._internal.docs import index as __doc__
@@ -49,4 +49,7 @@ __all__ = (
49
49
  "connectors",
50
50
  "plugins",
51
51
  "utils",
52
+ "SuccessTuple",
53
+ "Connector",
54
+ "make_connector",
52
55
  )
@@ -61,6 +61,7 @@ def parse_datetime(dt_str: str) -> Union[datetime, int, str]:
61
61
  error(f"'{dt_str}' is not a valid datetime format.", stack=False)
62
62
  return dt
63
63
 
64
+
64
65
  def parse_help(sysargs : Union[List[str], Dict[str, Any]]) -> None:
65
66
  """Parse the `--help` flag to determine which help message to print."""
66
67
  from meerschaum._internal.arguments._parse_arguments import parse_arguments, parse_line
@@ -97,7 +98,8 @@ def parse_help(sysargs : Union[List[str], Dict[str, Any]]) -> None:
97
98
  doc = "No help available for '" + f"{args['action'][0]}" + "'."
98
99
  return print(textwrap.dedent(doc))
99
100
 
100
- def parse_version(sysargs : List[str]):
101
+
102
+ def parse_version(sysargs: List[str]):
101
103
  """Print the Meerschaum version."""
102
104
  from meerschaum.config import __version__ as version
103
105
  from meerschaum.config import __doc__ as doc
@@ -105,6 +107,15 @@ def parse_version(sysargs : List[str]):
105
107
  return print(version)
106
108
  return print(doc)
107
109
 
110
+
111
+ def parse_name(name_str: str) -> str:
112
+ """
113
+ Ensure that `--name` is not an empty string.
114
+ """
115
+ if not name_str:
116
+ return None
117
+ return name_str
118
+
108
119
  def get_arguments_triggers() -> Dict[str, Tuple[str]]:
109
120
  """ """
110
121
  triggers = {}
@@ -158,12 +169,11 @@ groups['actions'].add_argument(
158
169
  '-d', '--daemon', action='store_true',
159
170
  help = "Run an action as a background daemon."
160
171
  )
161
-
162
172
  groups['actions'].add_argument(
163
173
  '--rm', action='store_true', help="Delete a job once it has finished executing."
164
174
  )
165
175
  groups['actions'].add_argument(
166
- '--name', '--job-name', type=str, help=(
176
+ '--name', '--job-name', type=parse_name, help=(
167
177
  "Assign a name to a job. If no name is provided, a random name will be assigned."
168
178
  ),
169
179
  )