datatailr 0.1.6__py3-none-any.whl → 0.1.8__py3-none-any.whl

datatailr/user.py

@@ -8,15 +8,23 @@
 #  of this file, in parts or full, via any medium is strictly prohibited.
 # *************************************************************************
 
+from __future__ import annotations
+import sys
 from typing import Optional
 
-from datatailr import dt__User, mock_cli_tool
+from datatailr.wrapper import dt__User, mock_cli_tool
+
+# Datatailr User API Client
+__client__ = dt__User()
 
 
 class User:
-    """Representing a Datatailr User
+    """
+    Representing a Datatailr User.
+
     This class provides methods to interact with the Datatailr User API.
     It allows you to create, update, delete, and manage users within the Datatailr platform.
+
     Attributes:
         first_name (str): The first name of the user.
         last_name (str): The last name of the user.
@@ -25,6 +33,7 @@ class User:
         user_id (int): The unique identifier for the user.
         primary_group_id (int): The primary group of the user.
         is_system_user (bool): Indicates if the user is a system user.
+
     Static Methods:
         signed_user() -> Optional['User']:
             Retrieve the currently signed-in user, if available.
@@ -38,14 +47,12 @@ class User:
             List all users available in the Datatailr platform.
         remove(name: str) -> None:
             Remove a user by their username.
+
     Instance Methods:
         verify() -> None:
             Refresh the user information from the Datatailr API.
     """
 
-    # Datatailr User API Client
-    __client__ = dt__User()
-
     def __init__(self, name):
         self.__name = name
         self.__first_name = None
@@ -86,9 +93,11 @@ class User:
     def __refresh__(self):
         if not self.name:
             raise ValueError("Name is not set. Cannot refresh user.")
-        if isinstance(User.__client__, mock_cli_tool):
+        if isinstance(__client__, mock_cli_tool) or any(
+            "unit" in arg for arg in sys.argv
+        ):
             return
-        user = self.__client__.get(self.name)
+        user = __client__.get(self.name)
         if user:
             self.__name = user["name"]
             self.__first_name = user["first_name"]
@@ -135,22 +144,26 @@ class User:
         return self.__is_system_user
 
     @staticmethod
-    def get(name: str) -> Optional["User"]:
+    def get(name: str) -> User:
         return User(name)
 
     @staticmethod
-    def signed_user() -> "User":
-        if isinstance(User.__client__, mock_cli_tool):
-            user = User(name="mock_user")
+    def signed_user() -> User:
+        if isinstance(__client__, mock_cli_tool) or any(
+            "unit" in arg for arg in sys.argv
+        ):
+            user = User(name="test_user")
             user.__expiry__ = "mock_expiry"
             user.__signature__ = "mock_signature"
             return user
-        user_signature_and_expiry = User.__client__.signed_user()
+
+        user_signature_and_expiry = __client__.signed_user()
         if user_signature_and_expiry:
             user = User(name=user_signature_and_expiry["name"])
             user.__expiry__ = user_signature_and_expiry["expiry"]
             user.__signature__ = user_signature_and_expiry["signature"]
             return user
+
         raise PermissionError(
             "No signed user found. Please ensure you are signed in to Datatailr."
         )
@@ -179,7 +192,7 @@ class User:
                 system=is_system_user,
             )
         else:
-            User.__client__.add(
+            __client__.add(
                 name,
                 first_name=first_name,
                 last_name=last_name,
@@ -192,17 +205,17 @@ class User:
 
     @staticmethod
     def exists(name: str) -> bool:
-        return User.__client__.exists(name)
+        return __client__.exists(name)
 
     @staticmethod
     def ls() -> list:
-        users = User.__client__.ls()
+        users = __client__.ls()
         return [User.get(user["name"]) for user in users]
 
     @staticmethod
     def remove(name: str) -> None:
-        User.__client__.rm(name)
+        __client__.rm(name)
         return None
 
     def verify(self) -> None:
-        return self.__client__.verify(self.name, self.__expiry__, self.__signature__)
+        return __client__.verify(self.name, self.__expiry__, self.__signature__)

datatailr/utils.py

@@ -10,6 +10,8 @@
 
 import shutil
 from enum import Enum
+import subprocess
+from typing import Tuple
 
 
 class Environment(Enum):
@@ -33,3 +35,21 @@ def is_dt_installed():
     Check if DataTailr is installed by looking for the 'dt' command in the system PATH.
     """
     return shutil.which("dt") is not None
+
+
+def run_shell_command(command: str) -> Tuple[str, int]:
+    """
+    Run a shell command.
+
+    This function executes a shell command and returns the output.
+
+    Args:
+        command (str): The shell command to execute.
+
+    Returns:
+        str: The output of the executed command.
+    """
+    result = subprocess.run(command, shell=True, capture_output=True, text=True)
+    if result.returncode != 0:
+        raise RuntimeError(f"Command '{command}' failed with error: {result.stderr}")
+    return result.stdout.strip(), result.returncode

datatailr/wrapper.py

@@ -194,12 +194,6 @@ dt__Blob = globals().get("dt__Blob", mock_cli_tool)
 dt__Dns = globals().get("dt__Dns", mock_cli_tool)
 dt__System = globals().get("dt__System", mock_cli_tool)
 dt__Sms = globals().get("dt__Sms", mock_cli_tool)
-dt__Group = globals().get("dt__Group", mock_cli_tool)
-dt__Job = globals().get("dt__Job", mock_cli_tool)
-dt__Blob = globals().get("dt__Blob", mock_cli_tool)
-dt__Dns = globals().get("dt__Dns", mock_cli_tool)
-dt__System = globals().get("dt__System", mock_cli_tool)
-dt__Sms = globals().get("dt__Sms", mock_cli_tool)
 dt__Email = globals().get("dt__Email", mock_cli_tool)
 dt__Kv = globals().get("dt__Kv", mock_cli_tool)
 dt__Log = globals().get("dt__Log", mock_cli_tool)

{datatailr-0.1.6.dist-info → datatailr-0.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datatailr
-Version: 0.1.6
+Version: 0.1.8
 Summary: Ready-to-Use Platform That Drives Business Insights
 Author-email: Datatailr <info@datatailr.com>
 License-Expression: MIT
@@ -26,15 +26,27 @@ Requires-Dist: mypy; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
 Requires-Dist: toml; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints; extra == "dev"
+Requires-Dist: sphinx-autosummary; extra == "dev"
+Requires-Dist: sphinx-design; extra == "dev"
+Requires-Dist: sphinx-copybutton; extra == "dev"
+Requires-Dist: myst-parser; extra == "dev"
 Dynamic: license-file
 
-[![Datatailr Logo](https://framerusercontent.com/images/6CmFcG0o2ryoa5cMuDsvwESVWA.svg)](https://www.datatailr.com/)
+<div style="text-align: center;">
+  <a href="https://www.datatailr.com/" target="_blank">
+    <img src="https://s3.eu-west-1.amazonaws.com/datatailr.com/assets/datatailr-logo.svg" alt="Datatailr Logo" />
+  </a>
+</div>
+
+---
 
-___
 **Datatailr empowers your team to streamline analytics and data workflows
 from idea to production without infrastructure hurdles.**
 
-## What is Datatailr?
+# What is Datatailr?
 
 Datatailr is a platform that simplifies the process of building and deploying data applications.
 
@@ -69,7 +81,28 @@ print(datatailr.__provider__)
 
 
 ## Quickstart
+The following example shows how to create a simple data pipeline using the Datatailr Python package.
+
+```python
+from datatailr.scheduler import batch, Batch
+
+@batch()
+def func_no_args() -> str:
+    return "no_args"
+
+
+@batch()
+def func_with_args(a: int, b: float) -> str:
+    return f"args: {a}, {b}"
+
+with Batch(name="MY test DAG", local_run=True) as dag:
+    for n in range(2):
+        res1 = func_no_args().alias(f"func_{n}")
+        res2 = func_with_args(1, res1).alias(f"func_with_args_{n}")
+```
 
+Running this code will create a graph of jobs and execute it.
+Each node on the graph represents a job, which in turn is a call to a function decorated with `@batch()`.
 
 ___
 Visit [our website](https://www.datatailr.com/) for more!

datatailr-0.1.8.dist-info/RECORD

@@ -0,0 +1,30 @@
+datatailr/__init__.py,sha256=QTTG8X76BnlQwVx5N4ZQtSbLkgFipZ9NJGAbvtfuk_g,1051
+datatailr/acl.py,sha256=tlDy6VlHinSy5W1FbVxcNQNi7FliWUXy3ssIbzaPp28,4157
+datatailr/blob.py,sha256=xkXT6RZcMww4YfLVjOyqvvPxWc-Ku6fTJ_PeCXyBys4,3159
+datatailr/dt_json.py,sha256=3xmTqDBk68oPl2UW8UVOYPaBw4lAsVg6nDLwcen5nuo,2252
+datatailr/errors.py,sha256=p_e4ao3sFEfz1g4LvEDqw6bVzHJPJSINLjJ8H6_PqOo,751
+datatailr/group.py,sha256=34unhas6jQH_KgQSz7N42AIT-4wAHtS9T8x-_W7AkA8,4444
+datatailr/logging.py,sha256=IkucGsHfkxaiy8Ul4Qy6U3fHbqCq3mChTDoaBNovYeA,3403
+datatailr/user.py,sha256=uIRMDdR_vey2r0d7aVEoq5WHb6tKLP8jBtEPc2n-xBY,7046
+datatailr/utils.py,sha256=mqnnERMyHNAuAgFY4Ry4O4yW0ZjCRtJbjfI5fXVqt2s,1524
+datatailr/version.py,sha256=N9K8ZxlwFFSz8XSgbgaTWZY4k2J0JKfj698nZ_O2pIU,536
+datatailr/wrapper.py,sha256=K9ZD76cWey_ikA6C5sKejwRaYBDln4QMg-RcoRGiuFc,7991
+datatailr/build/__init__.py,sha256=_dA7b4L6wsaAFaSxUoYSJ1oaRqDHDMR20kqoCocSOss,487
+datatailr/build/image.py,sha256=xeYKPR6usg0pqJNpbhsYI8t_BB2iWxhY0KBNTWqpb_Q,4939
+datatailr/sbin/datatailr_run.py,sha256=3WuvzdRrRFA0nWX9v-nShwoqjOQSnvzgZRvRvWdKJPI,5756
+datatailr/sbin/datatailr_run_app.py,sha256=67Y3RQPCZ2N9LIErEdXOsnYQ_4UzTmQygjyIfMhEkyk,891
+datatailr/sbin/datatailr_run_batch.py,sha256=UWnp96j_G66R_Cape7Bb-rbK6UBLF7Y5_mTlWyGJAVQ,1818
+datatailr/scheduler/__init__.py,sha256=qydHYVtEP6SUWd2CQ6FRdTdRWNz3SbYPJy4FK_wOvMk,1772
+datatailr/scheduler/arguments_cache.py,sha256=CydYR9o2pqfa4KsPTA1mJSBN-0YF47Q6AmODm4zAJQ4,6254
+datatailr/scheduler/base.py,sha256=OkoMxTjSzpFIFikWRctN9kuZM85oJDbNET8xKe8YUQY,12558
+datatailr/scheduler/batch.py,sha256=CK57jS6MvFrSj14q9ZTrD15akoBdAeTJ130MFb_aIN4,16449
+datatailr/scheduler/batch_decorator.py,sha256=LqL1bsupWLn-YEQUvFJYae7R3ogrL5-VodyiiScrkRw,5806
+datatailr/scheduler/constants.py,sha256=5WWTsfwZ_BA8gVDOTa2AQX9DJ0NzfaWgtY3vrODS2-8,606
+datatailr/scheduler/schedule.py,sha256=vzXaBBKMVJeCGD0VxsRPeW80sYReJ83XxWzDHVgLibY,3734
+datatailr/scheduler/utils.py,sha256=up6oR2iwe6G52LkvgfO394xchXgCYNjOMGRQW3e8PQk,1082
+datatailr-0.1.8.dist-info/licenses/LICENSE,sha256=ikKP4_O-UD_b8FuNdKmbzTb6odd0JX085ZW_FAPN3VI,1066
+datatailr-0.1.8.dist-info/METADATA,sha256=rviYJtuu-teMbR_toxDPyC3ANi5sGzWeFFxH1PhijSM,3608
+datatailr-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+datatailr-0.1.8.dist-info/entry_points.txt,sha256=VVBtNTDhrPMkcqrU3XjTHrfEdPQXwbJW9kgH1C-rT7U,186
+datatailr-0.1.8.dist-info/top_level.txt,sha256=75gntW0X_SKpqxLL6hAPipvpk28GAhJBvoyqN_HohWU,10
+datatailr-0.1.8.dist-info/RECORD,,

datatailr-0.1.8.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+datatailr_run = datatailr.sbin.datatailr_run:main
+datatailr_run_app = datatailr.sbin.datatailr_run_app:run
+datatailr_run_batch = datatailr.sbin.datatailr_run_batch:run

datatailr-0.1.8.dist-info/top_level.txt

@@ -0,0 +1 @@
+datatailr

datatailr-0.1.6.dist-info/RECORD

@@ -1,29 +0,0 @@
-datatailr/__init__.py,sha256=god5oEAyJEGbEsxGZOwD6llaBkDNzKjCl8j2tOkiGgQ,1567
-datatailr/acl.py,sha256=gLuzw6FLFYLVoyXOS_oHMfd5uGKKzlDqR1WBdN_AGwQ,2862
-datatailr/blob.py,sha256=VImsbKBaYP6oG2Wiy4oPr6zxtUibEHpfI8p8nE1wj14,3195
-datatailr/dt_json.py,sha256=oos6hwC4UxT4TEbbXNSozQGhwnc_bfpo-Y2rj24ks9A,1422
-datatailr/errors.py,sha256=0CHvBOlzvDWoePk_preMy2qKlsztKCuQNdaQDbhNyaU,204
-datatailr/group.py,sha256=-DvNWBnzJ0H7RlJHWOyRiF2jbhjAsSpnJKasV1tkhfI,4481
-datatailr/logging.py,sha256=b3Uaumdo1ZZOaTnD-7iH1rlieWsllQSijNn9rX4svuo,3053
-datatailr/user.py,sha256=6oXSsH75iDI8RUM_HbTxgT6EH-2TBdheI5gnkTep-MU,6919
-datatailr/utils.py,sha256=eHXOc7VwIUR8ryn5jBmw5QI00ARERJwXV5oICdVRnmQ,937
-datatailr/version.py,sha256=N9K8ZxlwFFSz8XSgbgaTWZY4k2J0JKfj698nZ_O2pIU,536
-datatailr/wrapper.py,sha256=rcNqdATGsiLeyIz5bnKPIHgew5_0Z6NqJAehCjYw_AM,8303
-datatailr/build/__init__.py,sha256=_dA7b4L6wsaAFaSxUoYSJ1oaRqDHDMR20kqoCocSOss,487
-datatailr/build/image.py,sha256=P2MiGxpzuZ6hOm9JubkLoOq-RdzKYnXbKJHiryIbJeA,3103
-datatailr/sbin/run_job.py,sha256=B3H3UI3zpll7zVm7lZLsfPtnRlA6jjk8s_D_w89pvC4,2175
-datatailr/scheduler/__init__.py,sha256=YtCnv9vuX-EPGr3WBXvXJIlLsZ94mW1dBzI6h7Yjcu0,1009
-datatailr/scheduler/arguments_cache.py,sha256=8JKumnGvv2q2lXqbndaCkGgBoUtlg9iJ2FAs_daAHTs,5203
-datatailr/scheduler/base.py,sha256=IRduJjhng4Uuv3Y9vDqUNTbs636AgH2ZISWRbIP6LqQ,7826
-datatailr/scheduler/batch.py,sha256=yyXvYTFpPxJQsnYABWWD6ggztfMCw6GSz-TCK1ap2Jw,11182
-datatailr/scheduler/batch_decorator.py,sha256=BUiYupqtmSSXn0OzdFrD-gWazeJ99VqOgJkXTMa-LtE,4721
-datatailr/scheduler/constants.py,sha256=ISG5uMnVPbGbjaaulU0xdmSggnd-DMr9ed0WTAZSUmU,604
-datatailr/scheduler/utils.py,sha256=YHtAc5sCwfgiClr5G6R3hfAjdlrFdnNW2l-3XwPZLXM,1070
-datatailr-0.1.6.dist-info/licenses/LICENSE,sha256=ikKP4_O-UD_b8FuNdKmbzTb6odd0JX085ZW_FAPN3VI,1066
-test_module/__init__.py,sha256=OF9XaL3RKdbWD5Ug4L-ufLqbykSt_rTK6gqZr4uBJ8g,576
-test_module/test_submodule.py,sha256=O07fFbzJEy5rf1vdlYzPvs8v0IxHFg-CaYMqaHkskbc,1294
-datatailr-0.1.6.dist-info/METADATA,sha256=eGduuqdtOUocmi1XvIHG2gBLCXFTS7WzEGcktb5taxk,2510
-datatailr-0.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-datatailr-0.1.6.dist-info/entry_points.txt,sha256=4lNE9VXvztJdIQsODI308v9FRzkVgmMu-VKGEceNxJs,59
-datatailr-0.1.6.dist-info/top_level.txt,sha256=UZOKaWS1kZGGwV7hP476-EcSUJBNspxVSSp9WqtORzk,22
-datatailr-0.1.6.dist-info/RECORD,,

datatailr-0.1.6.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-run_dt_job = datatailr.sbin.run_job:main

datatailr-0.1.6.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-datatailr
-test_module

test_module/__init__.py

@@ -1,17 +0,0 @@
-# *************************************************************************
-#
-#  Copyright (c) 2025 - Datatailr Inc.
-#  All Rights Reserved.
-#
-#  This file is part of Datatailr and subject to the terms and conditions
-#  defined in 'LICENSE.txt'. Unauthorized copying and/or distribution
-#  of this file, in parts or full, via any medium is strictly prohibited.
-# *************************************************************************
-
-from .test_submodule import foo
-from .test_submodule import test_function as test_function
-
-__all__ = [
-    "test_function",
-    "foo",
-]

test_module/test_submodule.py

@@ -1,38 +0,0 @@
-# *************************************************************************
-#
-#  Copyright (c) 2025 - Datatailr Inc.
-#  All Rights Reserved.
-#
-#  This file is part of Datatailr and subject to the terms and conditions
-#  defined in 'LICENSE.txt'. Unauthorized copying and/or distribution
-#  of this file, in parts or full, via any medium is strictly prohibited.
-# *************************************************************************
-
-from datatailr.logging import DatatailrLogger
-from datatailr.scheduler import batch
-
-logger = DatatailrLogger(__name__).get_logger()
-
-
-@batch()
-def foo():
-    logger.info(f"Running foo from {__name__}")
-    return "Hello from foo in test_submodule"
-
-
-@batch()
-def test_function(a, b, rundate=None):
-    """Test function for the submodule."""
-    logger.info(f"Running test_function from test_submodule, {__name__}")
-    logger.info(f"Arguments: a={a}, b={b}, rundate={rundate}")
-
-    return f"args: ({a}, {b}, {rundate}), kwargs: {{}}"
-
-
-@batch()
-def another_test_function(x, y, z=None, rundate=None):
-    """Another test function for the submodule."""
-    logger.info(f"Running another_test_function from test_submodule, {__name__}")
-    logger.info(f"Arguments: x={x}, y={y}, z={z}, rundate={rundate}")
-
-    return f"args: ({x}, {y}, {z}), kwargs: {{}}"