taskbadger 1.6.3__tar.gz → 2.0.0__tar.gz

taskbadger-2.0.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: taskbadger
+Version: 2.0.0
+Summary: The official Python SDK for Task Badger
+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: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: attrs>=21.3.0
+Requires-Dist: httpx>=0.20.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: tomlkit>=0.12.5
+Provides-Extra: celery
+Requires-Dist: celery<6.0.0,>=4.0.0; extra == 'celery'
+Provides-Extra: cli
+Requires-Dist: rich>=13.0; extra == 'cli'
+Requires-Dist: typer>=0.12; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# Task Badger Python Client
+
+This is the official Python SDK for [Task Badger](https://taskbadger.net/).
+
+For full documentation go to https://docs.taskbadger.net/python/.
+
+![Integration Tests](https://github.com/taskbadger/taskbadger-python/actions/workflows/integration_tests.yml/badge.svg)
+
+---
+
+## Getting Started
+
+### Install
+
+```bash
+pip install taskbadger
+```
+
+To use the `taskbadger` command-line tool, install the `cli` extra:
+
+```bash
+pip install 'taskbadger[cli]'
+```
+
+### Client Usage
+
+```python
+import taskbadger
+from taskbadger.systems import CelerySystemIntegration
+
+taskbadger.init(
+    token="***",
+    systems=[CelerySystemIntegration()],
+    tags={"environment": "production"}
+)
+```
+
+### CLI Usage
+
+```shell
+$ export TASKBADGER_API_KEY=***
+$ taskbadger run "nightly-backup" -- ./backup.sh
+```

taskbadger-2.0.0/README.md

@@ -0,0 +1,43 @@
+# Task Badger Python Client
+
+This is the official Python SDK for [Task Badger](https://taskbadger.net/).
+
+For full documentation go to https://docs.taskbadger.net/python/.
+
+![Integration Tests](https://github.com/taskbadger/taskbadger-python/actions/workflows/integration_tests.yml/badge.svg)
+
+---
+
+## Getting Started
+
+### Install
+
+```bash
+pip install taskbadger
+```
+
+To use the `taskbadger` command-line tool, install the `cli` extra:
+
+```bash
+pip install 'taskbadger[cli]'
+```
+
+### Client Usage
+
+```python
+import taskbadger
+from taskbadger.systems import CelerySystemIntegration
+
+taskbadger.init(
+    token="***",
+    systems=[CelerySystemIntegration()],
+    tags={"environment": "production"}
+)
+```
+
+### CLI Usage
+
+```shell
+$ export TASKBADGER_API_KEY=***
+$ taskbadger run "nightly-backup" -- ./backup.sh
+```

{taskbadger-1.6.3 → taskbadger-2.0.0}/pyproject.toml

@@ -1,8 +1,8 @@
 [project]
 name = "taskbadger"
-version = "1.6.3"
+version = "2.0.0"
 description = "The official Python SDK for Task Badger"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 authors = []
 readme = "README.md"
 classifiers = [
@@ -11,10 +11,11 @@ classifiers = [
     "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",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 
@@ -22,10 +23,7 @@ dependencies = [
     "httpx >=0.20.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]
@@ -42,6 +40,10 @@ include = [
 celery = [
     "celery>=4.0.0,<6.0.0",
 ]
+cli = [
+    "typer >=0.12",
+    "rich >=13.0",
+]
 
 [tool.uv]
 package = true
@@ -55,8 +57,6 @@ documentation = "https://docs.taskbadger.net/"
 
 [dependency-groups]
 dev = [
-    "black",
-    "isort",
     "pre-commit",
     "pytest",
     "pytest-httpx",
@@ -64,6 +64,7 @@ dev = [
     "pytest-celery",
     "redis",
     "openapi-python-client",
+    "taskbadger[cli]",
 ]
 
 [project.scripts]
@@ -82,7 +83,7 @@ exclude = [
 ]
 line-length = 120
 indent-width = 4
-target-version = "py39"
+target-version = "py310"
 
 [tool.ruff.lint]
 select = ["E", "F", "I", "UP", "DJ", "PT"]
@@ -97,4 +98,5 @@ skip-magic-trailing-comma = false
 line-ending = "auto"
 
 [tool.ruff.lint.per-file-ignores]
-"taskbadger/internal/*" = ["E501"]
+# taskbadger/internal/ is generated by openapi-python-client; lint is best-effort
+"taskbadger/internal/*" = ["E501", "UP", "F"]

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/__init__.py

@@ -23,15 +23,11 @@ __all__ = [
     "update_task",
 ]
 
-try:
-    import importlib.metadata as importlib_metadata
-except ModuleNotFoundError:
-    import importlib_metadata
-
+from importlib.metadata import PackageNotFoundError, version
 
 try:
-    __version__ = importlib_metadata.version(__name__)
-except importlib_metadata.PackageNotFoundError:
+    __version__ = version(__name__)
+except PackageNotFoundError:
     __version__ = "dev"
 
 

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/celery.py

@@ -131,7 +131,8 @@ class Task(celery.Task):
 
         result = super().apply_async(*args, **kwargs)
 
-        tb_task_id = result.info.get(TB_TASK_ID) if result.info else None
+        info = result.info
+        tb_task_id = info.get(TB_TASK_ID) if isinstance(info, dict) else None
         setattr(result, TB_TASK_ID, tb_task_id)
 
         _get_task = functools.partial(get_task, tb_task_id) if tb_task_id else lambda: None
@@ -262,7 +263,7 @@ def _maybe_create_task(signal_sender):
             inner_task = celery.current_app.tasks.get(task_name)
         items = signal_sender.request.kwargs.get("it", [])
         # Convert to list if needed for counting and potential recording
-        items_list = list(items) if not isinstance(items, (list, tuple)) else items
+        items_list = list(items) if not isinstance(items, list | tuple) else items
         item_count = len(items_list)
         # Append canvas type and item count to task name
         task_name = f"{task_name} ({canvas_type} {item_count})"

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/cli/utils.py

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

taskbadger-2.0.0/taskbadger/cli_main.py

@@ -0,0 +1,107 @@
+import sys
+from typing import Optional
+
+try:
+    import typer
+    from rich import print
+except ImportError as exc:
+    _missing = exc.name or "typer"
+
+    def app() -> None:
+        sys.stderr.write(
+            f"The Task Badger CLI requires the '{_missing}' package, which is not installed.\n"
+            "Install the CLI extras with:\n\n"
+            "    pip install 'taskbadger[cli]'\n"
+        )
+        sys.exit(1)
+else:
+    from taskbadger import __version__
+    from taskbadger.cli import create, get, list_tasks_command, run, update
+    from taskbadger.config import get_config, write_config
+    from taskbadger.sdk import _parse_token
+
+    app = typer.Typer(
+        rich_markup_mode="rich",
+        context_settings={"help_option_names": ["-h", "--help"]},
+    )
+
+    app.command(context_settings={"allow_extra_args": True, "ignore_unknown_options": False})(run)
+    app.command(context_settings={"ignore_unknown_options": False})(get)
+    app.command(context_settings={"ignore_unknown_options": False})(create)
+    app.command(context_settings={"ignore_unknown_options": False})(update)
+    app.command("list", context_settings={"ignore_unknown_options": False})(list_tasks_command)
+
+    def version_callback(value: bool):
+        if value:
+            print(f"Task Badger CLI Version: {__version__}")
+            raise typer.Exit()
+
+    @app.command()
+    def configure(ctx: typer.Context):
+        """Update CLI configuration."""
+        config = ctx.meta["tb_config"]
+        token = typer.prompt("API Key", default=config.token)
+        parsed = _parse_token(token)
+        if parsed:
+            org_slug, project_slug, api_key = parsed
+            print(
+                f"Project key detected — organization: [green]{org_slug}[/green], "
+                f"project: [green]{project_slug}[/green]"
+            )
+            config.organization_slug = org_slug
+            config.project_slug = project_slug
+            config.token = token
+        else:
+            config.organization_slug = typer.prompt("Organization slug", default=config.organization_slug)
+            config.project_slug = typer.prompt("Project slug", default=config.project_slug)
+            config.token = token
+        path = write_config(config)
+        print(f"Config written to [green]{path}[/green]")
+
+    @app.command()
+    def docs():
+        """Open Task Badger docs in a browser."""
+        typer.launch("https://docs.taskbadger.net")
+
+    @app.command()
+    def info(ctx: typer.Context):
+        """Show CLI configuration."""
+        config = ctx.meta["tb_config"]
+        print(str(config))
+
+    @app.callback()
+    def main(
+        ctx: typer.Context,
+        org: str | None = typer.Option(
+            None,
+            "--org",
+            "-o",
+            metavar="TASKBADGER_ORG",
+            show_default=False,
+            help="Organization Slug. This will override values from the config file and environment variables.",
+        ),
+        project: str | None = typer.Option(
+            None,
+            "--project",
+            "-p",
+            show_envvar=False,
+            metavar="TASKBADGER_PROJECT",
+            show_default=False,
+            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",
+        ),
+    ):
+        """
+        Task Badger CLI
+        """
+        config = get_config(org=org, project=project)
+        ctx.meta["tb_config"] = config
+
+    if __name__ == "__main__":
+        app()

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/config.py

@@ -7,7 +7,7 @@ import tomlkit
 import typer
 from tomlkit import document, table
 
-from taskbadger.sdk import _TB_HOST, _init
+from taskbadger.sdk import _TB_HOST, _init, _parse_token
 
 APP_NAME = "taskbadger"
 
@@ -47,10 +47,20 @@ class Config:
         """
         defaults = config_dict.get("defaults", {})
         auth = config_dict.get("auth", {})
+        token = overrides.get("token") or _from_env("API_KEY", auth.get("token"))
+        organization_slug = overrides.get("org") or _from_env("ORG", defaults.get("org"))
+        project_slug = overrides.get("project") or _from_env("PROJECT", defaults.get("project"))
+
+        if token:
+            parsed = _parse_token(token)
+            if parsed:
+                organization_slug = parsed[0]
+                project_slug = parsed[1]
+
         return Config(
-            token=overrides.get("token") or _from_env("API_KEY", auth.get("token")),
-            organization_slug=overrides.get("org") or _from_env("ORG", defaults.get("org")),
-            project_slug=overrides.get("project") or _from_env("PROJECT", defaults.get("project")),
+            token=token,
+            organization_slug=organization_slug,
+            project_slug=project_slug,
             host=overrides.get("host") or auth.get("host"),
             tags=config_dict.get("tags", {}),
         )

taskbadger-2.0.0/taskbadger/internal/api/action_endpoints/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/action_endpoints/action_cancel.py

@@ -26,6 +26,7 @@ def _get_kwargs(
 def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
     if response.status_code == 204:
         return None
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/action_endpoints/action_create.py

@@ -24,9 +24,8 @@ def _get_kwargs(
         "url": f"/api/{organization_slug}/{project_slug}/tasks/{task_id}/actions/",
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers
@@ -38,6 +37,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         response_201 = Action.from_dict(response.json())
 
         return response_201
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/action_endpoints/action_get.py

@@ -29,6 +29,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         response_200 = Action.from_dict(response.json())
 
         return response_200
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/action_endpoints/action_list.py

@@ -34,6 +34,7 @@ def _parse_response(
             response_200.append(response_200_item)
 
         return response_200
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/action_endpoints/action_partial_update.py

@@ -26,9 +26,8 @@ def _get_kwargs(
         "url": f"/api/{organization_slug}/{project_slug}/tasks/{task_id}/actions/{id}/",
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers
@@ -40,6 +39,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         response_200 = Action.from_dict(response.json())
 
         return response_200
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/action_endpoints/action_update.py

@@ -26,9 +26,8 @@ def _get_kwargs(
         "url": f"/api/{organization_slug}/{project_slug}/tasks/{task_id}/actions/{id}/",
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers
@@ -40,6 +39,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         response_200 = Action.from_dict(response.json())
 
         return response_200
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

taskbadger-2.0.0/taskbadger/internal/api/task_endpoints/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/task_endpoints/task_cancel.py

@@ -25,6 +25,7 @@ def _get_kwargs(
 def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
     if response.status_code == 204:
         return None
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/task_endpoints/task_create.py

@@ -27,9 +27,8 @@ def _get_kwargs(
         "url": f"/api/{organization_slug}/{project_slug}/tasks/",
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers
@@ -41,6 +40,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         response_201 = Task.from_dict(response.json())
 
         return response_201
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/task_endpoints/task_get.py

@@ -28,6 +28,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         response_200 = Task.from_dict(response.json())
 
         return response_200
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/task_endpoints/task_list.py

@@ -40,6 +40,7 @@ def _parse_response(
         response_200 = PaginatedTaskList.from_dict(response.json())
 
         return response_200
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/task_endpoints/task_partial_update.py

@@ -25,9 +25,8 @@ def _get_kwargs(
         "url": f"/api/{organization_slug}/{project_slug}/tasks/{id}/",
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers
@@ -39,6 +38,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         response_200 = Task.from_dict(response.json())
 
         return response_200
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/api/task_endpoints/task_update.py

@@ -25,9 +25,8 @@ def _get_kwargs(
         "url": f"/api/{organization_slug}/{project_slug}/tasks/{id}/",
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers
@@ -39,6 +38,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         response_200 = Task.from_dict(response.json())
 
         return response_200
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/models/action.py

@@ -1,4 +1,5 @@
 import datetime
+from collections.abc import Mapping
 from typing import Any, TypeVar, Union
 
 from attrs import define as _attrs_define
@@ -70,8 +71,8 @@ class Action:
         return field_dict
 
     @classmethod
-    def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
-        d = src_dict.copy()
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
         id = d.pop("id")
 
         task = d.pop("task")

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/models/action_request.py

@@ -1,3 +1,4 @@
+from collections.abc import Mapping
 from typing import Any, TypeVar, Union
 
 from attrs import define as _attrs_define
@@ -43,8 +44,8 @@ class ActionRequest:
         return field_dict
 
     @classmethod
-    def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
-        d = src_dict.copy()
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
         trigger = d.pop("trigger")
 
         integration = d.pop("integration")

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/models/paginated_task_list.py

@@ -1,3 +1,4 @@
+from collections.abc import Mapping
 from typing import TYPE_CHECKING, Any, TypeVar, Union, cast
 
 from attrs import define as _attrs_define
@@ -59,10 +60,10 @@ class PaginatedTaskList:
         return field_dict
 
     @classmethod
-    def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
         from ..models.task import Task
 
-        d = src_dict.copy()
+        d = dict(src_dict)
         results = []
         _results = d.pop("results")
         for results_item_data in _results:

{taskbadger-1.6.3 → taskbadger-2.0.0}/taskbadger/internal/models/patched_action_request.py

@@ -1,3 +1,4 @@
+from collections.abc import Mapping
 from typing import Any, TypeVar, Union
 
 from attrs import define as _attrs_define
@@ -42,8 +43,8 @@ class PatchedActionRequest:
         return field_dict
 
     @classmethod
-    def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
-        d = src_dict.copy()
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
         trigger = d.pop("trigger", UNSET)
 
         integration = d.pop("integration", UNSET)