phable-cli 0.1.3__tar.gz → 0.1.4__tar.gz

{phable_cli-0.1.3 → phable_cli-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: phable-cli
-Version: 0.1.3
+Version: 0.1.4
 Summary: Manage Phabricator tasks from the comfort of your terminal
 License: MIT
 Author: Balthazar Rouberol

{phable_cli-0.1.3 → phable_cli-0.1.4}/phable_cli/cli.py

@@ -1,6 +1,7 @@
 import atexit
 import json
 import re
+from pathlib import Path
 from typing import Optional
 
 import click
@@ -41,7 +42,7 @@ class Task(int):
     default="plain",
     help="Output format",
 )
-@click.argument("task-id", type=Task.from_str)
+@click.argument("task-id", type=Task.from_str, required=True)
 def show_task(task_id: int, format: str = "plain"):
     """Show task details
 
@@ -112,6 +113,14 @@ def show_task(task_id: int, format: str = "plain"):
     "--description",
     help="Task description or path to a file containing the description body. If not provided, an editor will be opened.",
 )
+@click.option(
+    "--template",
+    type=Path,
+    help=(
+        "Task description template file. If provided, the --description flag will be ignored "
+        "and an editor will be opened, pre-filled with the template file content"
+    ),
+)
 @click.option(
     "--priority",
     type=click.Choice(["unbreaknow", "high", "normal", "low", "needs-triage"]),
@@ -120,15 +129,18 @@ def show_task(task_id: int, format: str = "plain"):
 )
 @click.option("--parent-id", type=Task.from_str, help="ID of parent task")
 @click.option("--tags", multiple=True, help="Tags to associate to the task")
+@click.option("--cc", multiple=True, help="Subscribers to associate to the task")
 @click.option("--owner", help="The username of the task owner")
 @click.pass_context
 def create_task(
     ctx,
     title: str,
     description: Optional[str],
+    template: Path,
     priority: str,
     parent_id: Optional[str],
     tags: list[str],
+    cc: list[str],
     owner: Optional[str],
 ):
     """Create a new task
@@ -145,6 +157,9 @@ def create_task(
     # Create a task with associated title, priority and desription
     $ phable create --title 'Do the thing!' --priority high --description 'Address the thing right now'
     \b
+    # Create a task with associated description template
+    $ phable create --title 'Do the thing!' --template ./template.md
+    \b
     # Create a task with a given parent
     $ phable create --title 'A subtask' --description 'Subtask description' --parent-id T123456
     \b
@@ -156,10 +171,24 @@ def create_task(
     \b
     # Create a task with an associated owner
     $ phable create --title 'A task' --owner brouberol
+    \b
+    # Create a task with an associated subscriber
+    $ phable create --title 'A task' --cc brouberol
 
     """
     client = PhabricatorClient()
-    description = text_from_cli_arg_or_fs_or_editor(description)
+    if template:
+        if template.exists():
+            description = template
+            force_editor = True
+        else:
+            ctx.fail(f"Template file {template} does not exist")
+    else:
+        force_editor = False
+    description = text_from_cli_arg_or_fs_or_editor(
+        description, force_editor=force_editor
+    )
+
     task_params = {
         "title": title,
         "description": description,
@@ -191,7 +220,6 @@ def create_task(
             tag_projects_phids.append(project["phid"])
         else:
             ctx.fail(f"Project {tag} not found")
-
     if tag_projects_phids:
         task_params["projects.add"] = tag_projects_phids
 
@@ -205,6 +233,15 @@ def create_task(
         parent = client.show_task(parent_id)
         task_params["parents.set"] = [parent["phid"]]
 
+    cc_phids = []
+    for username in cc:
+        if user := client.find_user_by_username(username=username):
+            cc_phids.appedn(user["phid"])
+        else:
+            ctx.fail(f"User {owner} not found")
+    if cc_phids:
+        task_params["subscribers.set"] = cc_phids
+
     task = client.create_or_edit_task(task_params)
     ctx.invoke(show_task, task_id=task["result"]["object"]["id"])
 
@@ -215,7 +252,7 @@ def create_task(
     required=False,
     help="The username to assign the task to. Self-assign the task if not provided.",
 )
-@click.argument("task-ids", type=Task.from_str, nargs=VARIADIC)
+@click.argument("task-ids", type=Task.from_str, nargs=VARIADIC, required=True)
 @click.pass_context
 def assign_task(ctx, task_ids: list[int], username: Optional[str]):
     """Assign one or multiple task ids to a username
@@ -252,7 +289,7 @@ def assign_task(ctx, task_ids: list[int], username: Optional[str]):
         "milestone board, instead of the project board itself"
     ),
 )
-@click.argument("task-ids", type=Task.from_str, nargs=VARIADIC)
+@click.argument("task-ids", type=Task.from_str, nargs=VARIADIC, required=True)
 @click.pass_context
 def move_task(
     ctx: Context, task_ids: list[int], column: Optional[str], milestone: bool
@@ -306,7 +343,7 @@ def comment_on_task(task_id: int, comment: Optional[str]):
 
 
 @cli.command(name="subscribe")
-@click.argument("task-ids", type=Task.from_str, nargs=VARIADIC)
+@click.argument("task-ids", type=Task.from_str, nargs=VARIADIC, required=True)
 @click.pass_context
 def subscribe_to_task(ctx, task_ids: list[int]):
     """Subscribe to one or multiple task ids
@@ -325,5 +362,9 @@ def subscribe_to_task(ctx, task_ids: list[int]):
         client.add_user_to_task_subscribers(task_id=task_id, user_phid=user["phid"])
 
 
+def runcli():
+    cli(max_content_width=120)
+
+
 if __name__ == "__main__":
-    cli()
+    runcli()

{phable_cli-0.1.3 → phable_cli-0.1.4}/phable_cli/config.py

@@ -1,15 +1,16 @@
 import os
-import sys
 from dataclasses import dataclass, field
 from functools import partial
 
+import click
+
+_warnings = []
+
 
 def os_getenv_or_raise(env_var_name: str):
     if val := os.getenv(env_var_name):
         return val
-    sys.stderr.write(f"{env_var_name} is not set and is required\n")
-    sys.stderr.flush()
-    sys.exit(1)
+    _warnings.append(f"Required environment variable {env_var_name} is not set")
 
 
 def field_with_default_from_env(env_var_name):
@@ -24,5 +25,10 @@ class Config:
         "PHABRICATOR_DEFAULT_PROJECT_PHID"
     )
 
+    def __post_init__(self):
+        for warn in _warnings:
+            click.echo(click.style(warn, fg="yellow"), err=True)
+        return len(_warnings) == 0
+
 
 config = Config()

{phable_cli-0.1.3 → phable_cli-0.1.4}/phable_cli/utils.py

@@ -4,7 +4,7 @@ import os
 from pathlib import Path
 
 
-def text_from_cli_arg_or_fs_or_editor(body_or_path: str) -> str:
+def text_from_cli_arg_or_fs_or_editor(body_or_path: str, force_editor: bool) -> str:
     """Return argument text/file content, or return prompted input text.
 
     If some argument text is passed, and it matches a file path, return the file content.
@@ -14,15 +14,22 @@ def text_from_cli_arg_or_fs_or_editor(body_or_path: str) -> str:
 
     """
     try:
-        if body_or_path is not None and (local_file := Path(body_or_path)).exists():
+        if (
+            not force_editor
+            and body_or_path is not None
+            and (local_file := Path(body_or_path)).exists()
+        ):
             return local_file.read_text()
     except OSError:
         pass
 
-    if not body_or_path:
+    if not body_or_path or force_editor:
         txt_tmpfile = tempfile.NamedTemporaryFile(
             encoding="utf-8", mode="w", suffix=".md"
         )
+        if force_editor:
+            txt_tmpfile.write(body_or_path.read_text())
+            txt_tmpfile.flush()
         subprocess.run([os.environ["EDITOR"], txt_tmpfile.name])
         return Path(txt_tmpfile.name).read_text()
     return body_or_path

{phable_cli-0.1.3 → phable_cli-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "phable-cli"
-version = "0.1.3"
+version = "0.1.4"
 description = "Manage Phabricator tasks from the comfort of your terminal"
 authors = ["Balthazar Rouberol <br@imap.cc>"]
 license = "MIT"
@@ -12,7 +12,7 @@ requests = "^2.32.3"
 click = "^8.1.8"
 
 [tool.poetry.scripts]
-phable = 'phable_cli.cli:cli'
+phable = 'phable_cli.cli:runcli'
 
 [build-system]
 requires = ["poetry-core"]