Merge pull request #22 from taskbadger/sk/basic-ops

basic CLI operations

Author: snopoke

poetry.lock

@@ -32,25 +32,30 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.8"
-httpx = ">=0.15.4,<0.24.0"
+httpx = ">=0.20.0,<0.25.0"
 attrs = ">=21.3.0"
 python-dateutil = "^2.8.0"
-typer = {extras = ["all"], version = "^0.7.0"}
+typer = {extras = ["all"], version = "^0.9.0"}
 tomlkit = "^0.11.6"
 importlib-metadata = {version = "^1.0", python = "<3.8"}
-typing-extensions = {version = "^4.6.1", python = "3.9"}
+typing-extensions = {version = "^4.7.1", python = "3.9"}
+celery = {version = ">=4.0.0,<6.0.0", optional = true}
+
+[tool.poetry.extras]
+celery = ["celery"]
 
 [tool.poetry.group.dev.dependencies]
-openapi-python-client = "^0.13.1"
+openapi-python-client = "^0.15.1"
 pytest = "^7.2.1"
 isort = "^5.12.0"
 black = "^23.1.0"
 pre-commit = "^3.0.2"
 pytest-httpx = "^0.21.3"
 invoke = "^2.0.0"
+pytest-celery = "^0.0.0"
 
 [tool.poetry.scripts]
-taskbadger = "taskbadger.cli:app"
+taskbadger = "taskbadger.cli_main:app"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

pyproject.toml

@@ -1,7 +1,8 @@
 from .integrations import Action, EmailIntegration, WebhookIntegration
 from .internal.models import StatusEnum
+from .mug import Session
 from .safe_sdk import create_task_safe, update_task_safe
-from .sdk import Task, create_task, get_task, init, update_task
+from .sdk import DefaultMergeStrategy, Task, create_task, get_task, init, update_task
 
 try:
     import importlib.metadata as importlib_metadata

taskbadger/__init__.py

@@ -0,0 +1,3 @@
+from .basics import create, get, update
+from .list_tasks import list_tasks_command
+from .wrapper import run

taskbadger/cli.py

@@ -0,0 +1,126 @@
+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
+
+
+def get(
+    ctx: typer.Context,
+    task_id: str = typer.Argument(..., show_default=False, help="The ID of the task."),
+    output_format: OutputFormat = typer.Option(OutputFormat.pretty, "--format", "-f", help="Output format"),
+):
+    """Get a task."""
+    configure_api(ctx)
+    task = get_task(task_id)
+    if output_format == OutputFormat.pretty:
+        print(f"Task ID: {task.id}")
+        print(f"Created: {task.created.isoformat()}")
+        print(f"Name: {task.name}")
+        print(f"Status: {task.status}")
+        print(f"Percent: {task.value_percent}%")
+    elif output_format == OutputFormat.json:
+        print(json.dumps(task.to_dict(), indent=2))
+    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)])
+
+
+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(
+        (None, None, None),
+        "--action",
+        "-a",
+        metavar="<trigger integration config>",
+        show_default=False,
+        help="Action definition e.g. 'success,error email to:me@email.com'",
+    ),
+    status: StatusEnum = typer.Option(StatusEnum.PROCESSING, help="The initial status of the task."),
+    value_max: int = typer.Option(100, help="The maximum value for the task."),
+    metadata: list[str] = typer.Option(
+        None,
+        show_default=False,
+        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."
+    ),
+    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)
+
+    try:
+        task = create_task(
+            name,
+            status=status,
+            value_max=value_max,
+            data=metadata,
+            actions=actions,
+            monitor_id=monitor_id,
+        )
+    except Exception as e:
+        err_console.print(f"Error creating task: {e}")
+    else:
+        if quiet:
+            print(task.id)
+        else:
+            print(f"Task created: {task.public_url}")
+
+
+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(
+        (None, None, None),
+        "--action",
+        "-a",
+        metavar="<trigger integration config>",
+        show_default=False,
+        help="Action definition e.g. 'success,error email to:me@email.com'",
+    ),
+    status: StatusEnum = typer.Option(StatusEnum.PROCESSING, help="The status of the task."),
+    value: int = typer.Option(None, show_default=False, help="The current task value (progress)."),
+    value_max: int = typer.Option(None, show_default=False, help="The maximum value for the task."),
+    metadata: list[str] = typer.Option(
+        None,
+        show_default=False,
+        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."
+    ),
+    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)
+
+    try:
+        task = update_task(
+            task_id,
+            name=name,
+            status=status,
+            value=value,
+            value_max=value_max,
+            data=metadata,
+            actions=actions,
+        )
+    except Exception as e:
+        err_console.print(f"Error creating task: {e}")
+    else:
+        if not quiet:
+            print(f"Task updated: {task.public_url}")