taskbadger 1.3.4__tar.gz → 1.5.0__tar.gz

taskbadger-1.5.0/.gitignore

@@ -0,0 +1,25 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+.envrc
+.env.integration
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

{taskbadger-1.3.4 → taskbadger-1.5.0}/PKG-INFO

@@ -1,37 +1,32 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: taskbadger
-Version: 1.3.4
+Version: 1.5.0
 Summary: The official Python SDK for Task Badger
-Home-page: https://taskbadger.net/
-License: Apache-2.0
-Requires-Python: >=3.8,<4.0
+Project-URL: Changelog, https://github.com/taskbadger/taskbadger-python/releases
+Project-URL: homepage, https://taskbadger.net/
+Project-URL: repository, https://github.com/taskbadger/taskbadger-python
+Project-URL: documentation, https://docs.taskbadger.net/
+License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: attrs>=21.3.0
+Requires-Dist: httpx<0.28.0,>=0.20.0
+Requires-Dist: importlib-metadata>=1.0; python_version < '3.8'
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: tomlkit>=0.12.5
+Requires-Dist: typer[all]<0.10.0
+Requires-Dist: typing-extensions>=4.7.1; python_version <= '3.9'
 Provides-Extra: celery
-Requires-Dist: attrs (>=21.3.0)
-Requires-Dist: celery (>=4.0.0,<6.0.0) ; extra == "celery"
-Requires-Dist: httpx (>=0.20.0,<0.28.0)
-Requires-Dist: importlib-metadata (>=1.0,<2.0) ; python_version < "3.8"
-Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
-Requires-Dist: tomlkit (>=0.12.5,<0.13.0)
-Requires-Dist: typer[all] (<0.10.0)
-Requires-Dist: typing-extensions (>=4.7.1,<5.0.0) ; python_version == "3.9"
-Project-URL: Changelog, https://github.com/taskbadger/taskbadger-python/releases
-Project-URL: Documentation, https://docs.taskbadger.net/
-Project-URL: Repository, https://github.com/taskbadger/taskbadger-python
+Requires-Dist: celery<6.0.0,>=4.0.0; extra == 'celery'
 Description-Content-Type: text/markdown
 
 # Task Badger Python Client
@@ -143,4 +138,3 @@ $ taskbadger run "demo task" --action error email to:me@test.com -- path/to/scri
 
 Task created: https://taskbadger.net/public/tasks/xyz/
 ```
-

taskbadger-1.5.0/pyproject.toml

@@ -0,0 +1,100 @@
+[project]
+name = "taskbadger"
+version = "1.5.0"
+description = "The official Python SDK for Task Badger"
+requires-python = ">=3.9"
+authors = []
+readme = "README.md"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+dependencies = [
+    "httpx >=0.20.0,<0.28.0",
+    "attrs >=21.3.0",
+    "python-dateutil >=2.8.0",
+    "typer[all] <0.10.0",
+    "tomlkit >=0.12.5",
+    "importlib-metadata >=1.0; python_version < '3.8'",
+    "typing-extensions >=4.7.1; python_version <= '3.9'",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "taskbadger",
+  "taskbadger/internal/py.typed",
+]
+
+[project.optional-dependencies]
+celery = [
+    "celery>=4.0.0,<6.0.0",
+]
+
+[tool.uv]
+package = true
+
+[project.urls]
+"Changelog" = "https://github.com/taskbadger/taskbadger-python/releases"
+homepage = "https://taskbadger.net/"
+repository = "https://github.com/taskbadger/taskbadger-python"
+documentation = "https://docs.taskbadger.net/"
+
+
+[dependency-groups]
+dev = [
+    "black",
+    "isort",
+    "pre-commit",
+    "pytest",
+    "pytest-httpx",
+    "invoke",
+    "pytest-celery",
+    "redis",
+    "openapi-python-client",
+]
+
+[project.scripts]
+taskbadger = "taskbadger.cli_main:app"
+
+[tool.pytest.ini_options]
+# don't run integration tests unless specifically requested
+norecursedirs = ".* integration_tests"
+
+
+[tool.ruff]
+exclude = [
+    ".venv",
+    ".git",
+    ".ruff_cache",
+]
+line-length = 120
+indent-width = 4
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "DJ", "PT"]
+fixable = ["ALL"]
+unfixable = []
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint.per-file-ignores]
+"taskbadger/internal/*" = ["E501"]

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/__init__.py

@@ -5,6 +5,24 @@ from .mug import Badger, Session
 from .safe_sdk import create_task_safe, update_task_safe
 from .sdk import DefaultMergeStrategy, Task, create_task, get_task, init, update_task
 
+__all__ = [
+    "track",
+    "Action",
+    "EmailIntegration",
+    "WebhookIntegration",
+    "StatusEnum",
+    "Badger",
+    "Session",
+    "create_task_safe",
+    "update_task_safe",
+    "DefaultMergeStrategy",
+    "Task",
+    "create_task",
+    "get_task",
+    "init",
+    "update_task",
+]
+
 try:
     import importlib.metadata as importlib_metadata
 except ModuleNotFoundError:

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/celery.py

@@ -1,9 +1,17 @@
 import collections
 import functools
+import json
 import logging
 
 import celery
-from celery.signals import before_task_publish, task_failure, task_prerun, task_retry, task_success
+from celery.signals import (
+    before_task_publish,
+    task_failure,
+    task_prerun,
+    task_retry,
+    task_success,
+)
+from kombu import serialization
 
 from .internal.models import StatusEnum
 from .mug import Badger
@@ -12,10 +20,15 @@ from .sdk import DefaultMergeStrategy, get_task
 
 KWARG_PREFIX = "taskbadger_"
 TB_KWARGS_ARG = f"{KWARG_PREFIX}kwargs"
-IGNORE_ARGS = {TB_KWARGS_ARG, f"{KWARG_PREFIX}task", f"{KWARG_PREFIX}task_id"}
+IGNORE_ARGS = {TB_KWARGS_ARG, f"{KWARG_PREFIX}task", f"{KWARG_PREFIX}task_id", f"{KWARG_PREFIX}record_task_args"}
 TB_TASK_ID = f"{KWARG_PREFIX}task_id"
 
-TERMINAL_STATES = {StatusEnum.SUCCESS, StatusEnum.ERROR, StatusEnum.CANCELLED, StatusEnum.STALE}
+TERMINAL_STATES = {
+    StatusEnum.SUCCESS,
+    StatusEnum.ERROR,
+    StatusEnum.CANCELLED,
+    StatusEnum.STALE,
+}
 
 log = logging.getLogger("taskbadger")
 
@@ -113,6 +126,8 @@ class Task(celery.Task):
         if Badger.is_configured():
             headers["taskbadger_track"] = True
             headers[TB_KWARGS_ARG] = tb_kwargs
+            if "record_task_args" in tb_kwargs:
+                headers["taskbadger_record_task_args"] = tb_kwargs.pop("record_task_args")
 
         result = super().apply_async(*args, **kwargs)
 
@@ -176,6 +191,20 @@ def task_publish_handler(sender=None, headers=None, body=None, **kwargs):
     kwargs["status"] = StatusEnum.PENDING
     name = kwargs.pop("name", headers["task"])
 
+    global_record_task_args = celery_system and celery_system.record_task_args
+    if headers.get("taskbadger_record_task_args", global_record_task_args):
+        data = {
+            "celery_task_args": body[0],
+            "celery_task_kwargs": body[1],
+        }
+        try:
+            _, _, value = serialization.dumps(data, serializer="json")
+            data = json.loads(value)
+        except Exception:
+            log.error("Error serializing task arguments for task '%s'", name)
+        else:
+            kwargs.setdefault("data", {}).update(data)
+
     task = create_task_safe(name, **kwargs)
     if task:
         meta = {TB_TASK_ID: task.id}

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/cli/__init__.py

@@ -1,3 +1,5 @@
 from .basics import create, get, update
 from .list_tasks import list_tasks_command
 from .wrapper import run
+
+__all__ = ["create", "get", "update", "list_tasks_command", "run"]

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/cli/basics.py

@@ -1,13 +1,18 @@
 import csv
 import json
 import sys
-from typing import Tuple
 
 import typer
 from rich import print
 
 from taskbadger import StatusEnum, create_task, get_task, update_task
-from taskbadger.cli.utils import OutputFormat, configure_api, err_console, get_actions, get_metadata
+from taskbadger.cli.utils import (
+    OutputFormat,
+    configure_api,
+    err_console,
+    get_actions,
+    merge_kv_json,
+)
 
 
 def get(
@@ -29,14 +34,22 @@ def get(
     elif output_format == OutputFormat.csv:
         writer = csv.writer(sys.stdout)
         writer.writerow("Task ID,Created,Name,Status,Percent".split(","))
-        writer.writerow([task.id, task.created.isoformat(), task.name, task.status, str(task.value_percent)])
+        writer.writerow(
+            [
+                task.id,
+                task.created.isoformat(),
+                task.name,
+                task.status,
+                str(task.value_percent),
+            ]
+        )
 
 
 def create(
     ctx: typer.Context,
     name: str = typer.Argument(..., show_default=False, help="The task name."),
     monitor_id: str = typer.Option(None, help="Associate this task with a monitor."),
-    action_def: Tuple[str, str, str] = typer.Option(
+    action_def: tuple[str, str, str] = typer.Option(
         (None, None, None),
         "--action",
         "-a",
@@ -52,14 +65,27 @@ def create(
         help="Metadata 'key=value' pair to associate with the task. Can be specified multiple times.",
     ),
     metadata_json: str = typer.Option(
-        None, show_default=False, help="Metadata to associate with the task. Must be valid JSON."
+        None,
+        show_default=False,
+        help="Metadata to associate with the task. Must be valid JSON.",
+    ),
+    tag: list[str] = typer.Option(
+        None,
+        show_default=False,
+        help="Metadata 'key=value' pair to associate with the task. Can be specified multiple times.",
+    ),
+    tags_json: str = typer.Option(
+        None,
+        show_default=False,
+        help="Tags to associate with the task. Must be valid JSON mapping name -> value.",
     ),
     quiet: bool = typer.Option(False, "--quiet", "-q", help="Minimal output. Only the Task ID."),
 ):
     """Create a task."""
     configure_api(ctx)
     actions = get_actions(action_def)
-    metadata = get_metadata(metadata, metadata_json)
+    metadata = merge_kv_json(metadata, metadata_json)
+    tags = merge_kv_json(tag, tags_json)
 
     try:
         task = create_task(
@@ -69,6 +95,7 @@ def create(
             data=metadata,
             actions=actions,
             monitor_id=monitor_id,
+            tags=tags,
         )
     except Exception as e:
         err_console.print(f"Error creating task: {e}")
@@ -83,7 +110,7 @@ def update(
     ctx: typer.Context,
     task_id: str = typer.Argument(..., show_default=False, help="The ID of the task to update."),
     name: str = typer.Option(None, show_default=False, help="Update the name of the task."),
-    action_def: Tuple[str, str, str] = typer.Option(
+    action_def: tuple[str, str, str] = typer.Option(
         (None, None, None),
         "--action",
         "-a",
@@ -100,14 +127,27 @@ def update(
         help="Metadata 'key=value' pair to associate with the task. Can be specified multiple times.",
     ),
     metadata_json: str = typer.Option(
-        None, show_default=False, help="Metadata to associate with the task. Must be valid JSON."
+        None,
+        show_default=False,
+        help="Metadata to associate with the task. Must be valid JSON.",
+    ),
+    tag: list[str] = typer.Option(
+        None,
+        show_default=False,
+        help="Metadata 'key=value' pair to associate with the task. Can be specified multiple times.",
+    ),
+    tags_json: str = typer.Option(
+        None,
+        show_default=False,
+        help="Tags to associate with the task. Must be valid JSON mapping name -> value.",
     ),
     quiet: bool = typer.Option(False, "--quiet", "-q", help="No output."),
 ):
     """Update a task."""
     configure_api(ctx)
     actions = get_actions(action_def)
-    metadata = get_metadata(metadata, metadata_json)
+    metadata = merge_kv_json(metadata, metadata_json)
+    tags = merge_kv_json(tag, tags_json)
 
     try:
         task = update_task(
@@ -118,6 +158,7 @@ def update(
             value_max=value_max,
             data=metadata,
             actions=actions,
+            tags=tags,
         )
     except Exception as e:
         err_console.print(f"Error creating task: {e}")

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/cli/list_tasks.py

@@ -47,7 +47,13 @@ def _render_pretty(ctx, result):
     table.add_column("Percent", no_wrap=True)
 
     for task in result.results:
-        table.add_row(task.id, task.created.isoformat(), task.name, task.status, str(task.value_percent))
+        table.add_row(
+            task.id,
+            task.created.isoformat(),
+            task.name,
+            task.status,
+            str(task.value_percent),
+        )
     Console().print(table)
 
     cursor = _get_cursor(result.next_)
@@ -59,7 +65,15 @@ def _render_csv(ctx, result):
     writer = csv.writer(sys.stdout)
     writer.writerow("Task ID,Created,Name,Status,Percent".split(","))
     for task in result.results:
-        writer.writerow([task.id, task.created.isoformat(), task.name, task.status, str(task.value_percent)])
+        writer.writerow(
+            [
+                task.id,
+                task.created.isoformat(),
+                task.name,
+                task.status,
+                str(task.value_percent),
+            ]
+        )
 
     cursor = _get_cursor(result.next_)
     if cursor:

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/cli/utils.py

@@ -28,7 +28,7 @@ def get_actions(action_def: tuple[str, str, str]) -> list[Action]:
     return []
 
 
-def get_metadata(metadata_kv: list[str], metadata_json: str) -> dict:
+def merge_kv_json(metadata_kv: list[str], metadata_json: str) -> dict:
     metadata = {}
     for kv in metadata_kv:
         k, v = kv.strip().split("=", 1)

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/cli/wrapper.py

@@ -1,10 +1,8 @@
-from typing import Tuple
-
 import typer
 from rich import print
 
 from taskbadger import DefaultMergeStrategy, Session, StatusEnum, Task
-from taskbadger.cli.utils import configure_api, err_console, get_actions
+from taskbadger.cli.utils import configure_api, err_console, get_actions, merge_kv_json
 from taskbadger.process import ProcessRunner
 
 
@@ -13,7 +11,7 @@ def run(
     name: str = typer.Argument(..., show_default=False, help="The task name"),
     monitor_id: str = typer.Option(None, help="Associate this task with a monitor."),
     update_frequency: int = typer.Option(5, metavar="SECONDS", min=5, max=300, help="Seconds between updates."),
-    action_def: Tuple[str, str, str] = typer.Option(
+    action_def: tuple[str, str, str] = typer.Option(
         (None, None, None),
         "--action",
         "-a",
@@ -21,6 +19,11 @@ def run(
         show_default=False,
         help="Action definition e.g. 'success,error email to:me@email.com'",
     ),
+    tag: list[str] = typer.Option(
+        None,
+        show_default=False,
+        help="Tags: 'name=value' pair to associate with the task. Can be specified multiple times.",
+    ),
     capture_output: bool = typer.Option(False, help="Capture stdout and stderr."),
 ):
     """Execute a command using the CLI and create a Task to track its outcome.
@@ -36,6 +39,7 @@ def run(
     """
     configure_api(ctx)
     actions = get_actions(action_def)
+    tags = merge_kv_json(tag, "")
     stale_timeout = update_frequency * 2
     with Session():
         try:
@@ -45,6 +49,7 @@ def run(
                 stale_timeout=stale_timeout,
                 actions=actions,
                 monitor_id=monitor_id,
+                tags=tags,
             )
         except Exception as e:
             err_console.print(f"Error creating task: {e}")
@@ -53,7 +58,12 @@ def run(
             print(f"Task created: {task.public_url}")
         env = {"TASKBADGER_TASK_ID": task.id} if task else None
         try:
-            process = ProcessRunner(ctx.args, env, capture_output=capture_output, update_frequency=update_frequency)
+            process = ProcessRunner(
+                ctx.args,
+                env,
+                capture_output=capture_output,
+                update_frequency=update_frequency,
+            )
             for output in process.run():
                 _update_task(task, **(output or {}))
         except Exception as e:

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/cli_main.py

@@ -30,9 +30,9 @@ def version_callback(value: bool):
 def configure(ctx: typer.Context):
     """Update CLI configuration."""
     config = ctx.meta["tb_config"]
-    config.organization_slug = typer.prompt(f"Organization slug", default=config.organization_slug)
-    config.project_slug = typer.prompt(f"Project slug", default=config.project_slug)
-    config.token = typer.prompt(f"API Key", default=config.token)
+    config.organization_slug = typer.prompt("Organization slug", default=config.organization_slug)
+    config.project_slug = typer.prompt("Project slug", default=config.project_slug)
+    config.token = typer.prompt("API Key", default=config.token)
     path = write_config(config)
     print(f"Config written to [green]{path}[/green]")
 
@@ -71,7 +71,11 @@ def main(
         help="Project Slug. This will override values from the config file and environment variables.",
     ),
     version: Optional[bool] = typer.Option(  # noqa
-        None, "--version", callback=version_callback, is_eager=True, help="Show CLI Version"
+        None,
+        "--version",
+        callback=version_callback,
+        is_eager=True,
+        help="Show CLI Version",
     ),
 ):
     """

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/config.py

@@ -1,6 +1,6 @@
 import dataclasses
-import inspect
 import os
+import textwrap
 from pathlib import Path
 
 import tomlkit
@@ -18,6 +18,7 @@ class Config:
     organization_slug: str = None
     project_slug: str = None
     host: str = _TB_HOST
+    tags: dict = None
 
     def is_valid(self):
         return bool(self.token and self.organization_slug and self.project_slug)
@@ -51,18 +52,26 @@ class Config:
             organization_slug=overrides.get("org") or _from_env("ORG", defaults.get("org")),
             project_slug=overrides.get("project") or _from_env("PROJECT", defaults.get("project")),
             host=overrides.get("host") or auth.get("host"),
+            tags=config_dict.get("tags", {}),
         )
 
     def __str__(self):
         host = ""
-        if self.host != _TB_HOST:
-            host = f"\n            Host: {self.host}"
-        return inspect.cleandoc(
-            f"""
-            Organization slug: {self.organization_slug or '-'}
-            Project slug: {self.project_slug or '-'}
-            Auth token: {self.token or '-'}{host}
+        if self.host and self.host != _TB_HOST:
+            host = f"Host: {self.host or '-'}\n"
+        tags = ""
+        if self.tags:
+            tags = "Tags:\n  " + "\n  ".join(f"{k}: {v}" for k, v in self.tags.items())
+        return (
+            textwrap.dedent(
+                f"""
+            Organization slug: {self.organization_slug or "-"}
+            Project slug: {self.project_slug or "-"}
+            Auth token: {self.token or "-"}
             """
+            )
+            + host
+            + tags
         )
 
 
@@ -73,9 +82,17 @@ def _from_env(name, default=None, prefix="TASKBADGER_"):
 def write_config(config):
     doc = document()
 
-    doc.add("defaults", table().add("org", config.organization_slug).add("project", config.project_slug))
+    doc.add(
+        "defaults",
+        table().add("org", config.organization_slug).add("project", config.project_slug),
+    )
 
     doc.add("auth", table().add("token", config.token))
+    if config.tags:
+        tags = table()
+        for key, value in config.tags.items():
+            tags.add(key, value)
+        doc.add("tags", tags)
 
     config_path = _get_config_path()
     if not config_path.parent.exists():

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/decorators.py

@@ -8,7 +8,14 @@ from .sdk import StatusEnum
 log = logging.getLogger("taskbadger")
 
 
-def track(func=None, *, name: str = None, monitor_id: str = None, max_runtime: int = None, **kwargs):
+def track(
+    func=None,
+    *,
+    name: str = None,
+    monitor_id: str = None,
+    max_runtime: int = None,
+    **task_kwargs,
+):
     """
     Decorator to track a function as a task.
 
@@ -39,12 +46,21 @@ def track(func=None, *, name: str = None, monitor_id: str = None, max_runtime: i
         @Session()
         def _inner(*args, **kwargs):
             task = create_task_safe(
-                task_name, status=StatusEnum.PROCESSING, max_runtime=max_runtime, monitor_id=monitor_id, **kwargs
+                task_name,
+                status=StatusEnum.PROCESSING,
+                max_runtime=max_runtime,
+                monitor_id=monitor_id,
+                **task_kwargs,
             )
             try:
                 result = func(*args, **kwargs)
             except Exception as e:
-                _update_task(task, status=StatusEnum.ERROR, data={"exception": str(e)}, data_merge_strategy="default")
+                _update_task(
+                    task,
+                    status=StatusEnum.ERROR,
+                    data={"exception": str(e)},
+                    data_merge_strategy="default",
+                )
                 raise
 
             _update_task(task, status=StatusEnum.SUCCESS)

{taskbadger-1.3.4 → taskbadger-1.5.0}/taskbadger/exceptions.py

@@ -1,4 +1,8 @@
 class ConfigurationError(Exception):
+    pass
+
+
+class MissingConfiguration(ConfigurationError):
     def __init__(self, **kwargs):
         self.missing = [name for name, arg in kwargs.items() if arg is None]