phable-cli 0.1.15__tar.gz → 0.1.17__tar.gz

{phable_cli-0.1.15 → phable_cli-0.1.17}/PKG-INFO

@@ -1,16 +1,14 @@
 Metadata-Version: 2.4
 Name: phable-cli
-Version: 0.1.15
+Version: 0.1.17
 Summary: Manage Phabricator tasks from the comfort of your terminal
 License: MIT
 License-File: LICENSE
 Author: Balthazar Rouberol
 Author-email: br@imap.cc
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.11,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-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.13
@@ -61,10 +59,11 @@ Commands:
   move               Move one or several task on their current project board
   parent             Manage task parents
   report-done-tasks  Print the details of all tasks in the `from` column and move them to the `to` column.
+  set                Set the fields of one or multiple tasks
   show               Show task details
-  status             Set the status of one or multiple tasks
+  status             Set the status of one or multiple tasks [DEPRECATED]
   subscribe          Subscribe to one or multiple task ids
-  tag                Add a tag on one or multiple tasks
+  tag                Add a tag on one or multiple tasks [DEPRECATED]
 ```
 
 ## Setup
@@ -105,7 +104,7 @@ $ phable config aliases list
 done = move --column 'Done' --milestone
 review = move --column 'Needs Review' --milestone
 wip = move --column 'In Progress' --milestone
-team-report = list --owner brouberol --column 'In Progress' --column 'Needs Review' --column 'Blocked/Waiting' --column Done --milestone --format html
+team-report = list --owner self --column 'In Progress' --column 'Needs Review' --column 'Blocked/Waiting' --column Done --milestone --format html
 ```
 
 ### Phabricator task IDs as clickable links in iTerm2

{phable_cli-0.1.15 → phable_cli-0.1.17}/README.md

@@ -39,10 +39,11 @@ Commands:
   move               Move one or several task on their current project board
   parent             Manage task parents
   report-done-tasks  Print the details of all tasks in the `from` column and move them to the `to` column.
+  set                Set the fields of one or multiple tasks
   show               Show task details
-  status             Set the status of one or multiple tasks
+  status             Set the status of one or multiple tasks [DEPRECATED]
   subscribe          Subscribe to one or multiple task ids
-  tag                Add a tag on one or multiple tasks
+  tag                Add a tag on one or multiple tasks [DEPRECATED]
 ```
 
 ## Setup
@@ -83,7 +84,7 @@ $ phable config aliases list
 done = move --column 'Done' --milestone
 review = move --column 'Needs Review' --milestone
 wip = move --column 'In Progress' --milestone
-team-report = list --owner brouberol --column 'In Progress' --column 'Needs Review' --column 'Blocked/Waiting' --column Done --milestone --format html
+team-report = list --owner self --column 'In Progress' --column 'Needs Review' --column 'Blocked/Waiting' --column Done --milestone --format html
 ```
 
 ### Phabricator task IDs as clickable links in iTerm2

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/cache.py

@@ -1,6 +1,7 @@
 import inspect
 import json
 import os
+import getpass
 import sys
 import tempfile
 import time
@@ -12,7 +13,7 @@ if not os.getenv("GITHUB_ACTIONS"):
     CACHE_HOME_PER_PLATFORM = {
         "darwin": Path.home() / "Library" / "Caches",
         "linux": Path(os.getenv("XDG_CACHE_HOME", f"{Path.home()}/.config")),
-        "windows": Path("c:/", "Users", os.getlogin(), "AppData", "Local", "Temp"),
+        "windows": Path("c:/", "Users", getpass.getuser(), "AppData", "Local", "Temp"),
     }
 else:
     CACHE_HOME_PER_PLATFORM = {}
@@ -27,7 +28,8 @@ class Cache:
         )
         self.cache_dir = cache_parent_dir / "phind"
         if not self.cache_dir.exists():
-            self.cache_dir.mkdir()
+            # create entire path if it doesn't exist
+            os.makedirs(self.cache_dir, exist_ok=True)
         self.cache_filepath = self.cache_dir / "cache.json"
         if self.cache_filepath.exists():
             try:

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/cli/assign.py

@@ -38,13 +38,16 @@ def assign_task(
     $ phable assign T123456
     \b
     # assign to username
-    $ phable assign T123456  --usernamme brouberol
+    $ phable assign T123456 --username brouberol
     \b
-    # assign to a secondary owner
-    $ phable assign T123456  --usernamme brouberol --secondary
+    # assign current user as a secondary owner
+    $ phable assign T123456 --username self --secondary
+    \b
+    # assign multiple tasks to current user
+    $ phable assign T123456 T234567 --usernamme self
 
     """
-    if not username:
+    if not username or (username == "self"):
         user = client.current_user()
     else:
         user = client.find_user_by_username(username)

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/cli/create.py

@@ -78,6 +78,9 @@ def create_task(
     # Create a task with an associated owner
     $ phable create --title 'A task' --owner brouberol
     \b
+    # Create a task with an associated owner set to the current user
+    $ phable create --title 'A task' --owner self
+    \b
     # Create a task with an associated subscriber
     $ phable create --title 'A task' --cc brouberol
 

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/cli/list.py

@@ -6,7 +6,7 @@ from phable.cli.utils import find_project_phid_by_title, project_phid_option
 from phable.config import config
 from phable.display import TaskFormat, display_tasks
 from phable.phabricator import PhabricatorClient
-
+from phable.task import TaskStatus
 
 @click.command(name="list")
 @click.option(
@@ -30,6 +30,13 @@ from phable.phabricator import PhabricatorClient
         "milestone board, instead of the project board itself"
     ),
 )
+@click.option(
+    "--status",
+    required=False,
+    type=click.Choice(TaskStatus._member_names_), help="Task(s) status",
+    default=[TaskStatus.open, TaskStatus.progress, TaskStatus.stalled],
+    multiple=True,
+)
 @click.option(
     "--format",
     required=False,
@@ -46,6 +53,7 @@ def list_tasks(
     project: Optional[str],
     owner: Optional[str] = None,
     milestone: bool = False,
+    status: list[str] = None,
     format: TaskFormat = TaskFormat.PLAIN,
 ):
     """Lists and filter tasks
@@ -60,6 +68,9 @@ def list_tasks(
     \b
     # List all tasks owner by brouberol in the Done column of the default board latest milestone
     $ phable list --milestone --owner brouberol --column Done
+    \b
+    # List all tasks owner by the current user in the Done column of the default board latest milestone
+    $ phable list --milestone --owner self --column Done
 
     """
     if owner:
@@ -85,12 +96,16 @@ def list_tasks(
     else:
         column_phids = []
     tasks = client.find_tasks(
-        column_phids=column_phids, owner_phid=owner_user, project_phid=project_phid
+        column_phids=column_phids,
+        owner_phid=owner_user,
+        project_phid=project_phid,
+        status=status,
     )
     tasks += client.find_tasks(
         column_phids=column_phids,
         backup_owner_phid=owner_user,
         project_phid=project_phid,
+        status=status,
     )
     tasks = [client.enrich_task(task) for task in tasks]
     display_tasks(tasks=tasks, format=format)

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/cli/main.py

@@ -13,6 +13,7 @@ from phable.cli.list import list_tasks
 from phable.cli.move import move_task
 from phable.cli.parent import parent
 from phable.cli.report import report_done_tasks
+from phable.cli.set import set_task_fields
 from phable.cli.show import show_task
 from phable.cli.status import set_task_status
 from phable.cli.subscribe import subscribe_to_task
@@ -102,6 +103,7 @@ cli.add_command(list_tasks)
 cli.add_command(tag_task)
 cli.add_command(parent)
 cli.add_command(set_task_status)
+cli.add_command(set_task_fields)
 
 
 def runcli():

phable_cli-0.1.17/phable/cli/set.py

@@ -0,0 +1,58 @@
+from typing import Optional
+
+import click
+
+from phable.cli.utils import VARIADIC
+from phable.phabricator import PhabricatorClient
+from phable.task import TASK_ID, TaskPriority, TaskStatus
+
+
+@click.command(name="set")
+@click.option(
+    "--priority",
+    type=click.Choice(TaskPriority._member_names_),
+    help="Task(s) priority",
+)
+@click.option(
+    "--status", type=click.Choice(TaskStatus._member_names_), help="Task(s) status"
+)
+@click.option("--tags", type=str, multiple=True, help="Task(s) tag(s)")
+@click.argument("task-ids", type=TASK_ID, nargs=VARIADIC)
+@click.pass_context
+@click.pass_obj
+def set_task_fields(
+    client: PhabricatorClient,
+    ctx: click.Context,
+    task_ids: list[int],
+    priority: Optional[str],
+    status: Optional[str],
+    tags: list[str],
+):
+    """Set the fields of one or multiple tasks
+
+    \b
+    Example:
+    # Set the priority for a single task
+    $ phable set T123456 --priority high
+    \b
+    # Set the priority for multiple tasks
+    $ phable set T123456 T123457 --priority medium
+    \b
+    # Set the status for a single task
+    $ phable set T123456 --status resolved
+    \b
+    # Set the tags for a single task
+    $ phable set T123456 --tags 'Epic' 'OKR'
+
+    """
+    tag_phids = []
+    for tag in tags:
+        if tag_meta := client.find_project_by_title(title=tag):
+            tag_phids.append(tag_meta["phid"])
+        else:
+            ctx.fail(f"Tag '{tag}' not found")
+
+    for task_id in task_ids:
+        params = {"priority": priority, "status": status}
+        params = {param: value for param, value in params.values() if value is not None}
+        client.create_or_edit_task(task_id=task_id, params=params)

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/cli/status.py

@@ -16,7 +16,7 @@ from phable.task import TASK_ID, TaskStatus
 def set_task_status(
     client: PhabricatorClient, task_ids: list[int], status: Optional[str]
 ):
-    """Set the status of one or multiple tasks
+    """Set the status of one or multiple tasks [DEPRECATED]
 
     \b
     Example:
@@ -27,5 +27,9 @@ def set_task_status(
     $ phable status T123456 T123457 --status declined
 
     """
+    click.secho(
+        "[DEPRECATION NOTICE] This command has been replaced by `phable set --status`  and will soon be removed",
+        fg="yellow",
+    )
     for task_id in task_ids:
         client.set_task_status(task_id=task_id, status=status)

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/cli/tag.py

@@ -12,7 +12,7 @@ from phable.task import TASK_ID
 @click.argument("task-ids", type=TASK_ID, nargs=VARIADIC)
 @click.pass_obj
 def tag_task(client: PhabricatorClient, task_ids: list[int], tag: Optional[str]):
-    """Add a tag on one or multiple tasks
+    """Add a tag on one or multiple tasks [DEPRECATED]
 
     \b
     Example:
@@ -20,6 +20,10 @@ def tag_task(client: PhabricatorClient, task_ids: list[int], tag: Optional[str])
     $ phable tag T123456 T123457 --tag 'Essential work'  # add multiple tags to a task
 
     """
+    click.secho(
+        "[DEPRECATION NOTICE] This command has been replaced by `phable set --tag` and will soon be removed",
+        fg="yellow",
+    )
     if tag := client.find_project_by_title(title=tag):
         for task_id in task_ids:
             client.assign_tag_to_task(task_id=task_id, tag_phid=tag["phid"])

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/config.py

@@ -1,4 +1,5 @@
 import os
+import getpass
 import sys
 from configparser import ConfigParser
 from dataclasses import dataclass, field
@@ -11,7 +12,7 @@ _warnings = []
 CONFIG_HOME_PER_PLATFORM = {
     "darwin": Path.home() / "Library" / "Preferences",
     "linux": Path(os.getenv("XDG_CACHE_HOME", f"{Path.home()}/.config")),
-    "windows": Path("c:/", "Users", os.getlogin(), "AppData", "Local", "Programs"),
+    "windows": Path("c:/", "Users", getpass.getuser(), "AppData", "Local", "Programs"),
 }
 config_filepath = CONFIG_HOME_PER_PLATFORM[sys.platform] / "phable" / "config.ini"
 

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/display.py

@@ -11,6 +11,8 @@ class TaskFormat(StrEnum):
     HTML = auto()
     MARKDOWN = auto()
     WIKITEXT = auto()
+    ONELINE = auto()
+    IDS = auto()
 
 
 def display_tasks(
@@ -34,7 +36,8 @@ class TaskPrinter:
         pass
 
     def print_list(self, tasks: list[dict]) -> None:
-        pass
+        for task in tasks:
+            self.print(task)
 
     def title(self, task: dict) -> str:
         return f"{Task.from_int(task['id'])} {task['fields']['name']}"
@@ -55,19 +58,11 @@ class MarkdownTaskPrinter(TaskPrinter):
     def print(self, task: dict) -> None:
         self._printer(f"* [{self.title(task)}]({task['url']}) {self.status(task)}")
 
-    def print_list(self, tasks: list[dict]) -> None:
-        for task in tasks:
-            self.print(task)
-
 
 class WikitextTaskPrinter(TaskPrinter):
     def print(self, task: dict) -> None:
         self._printer(f"* [{task['url']} {self.title(task)}] {self.status(task)}")
 
-    def print_list(self, tasks: list[dict]) -> None:
-        for task in tasks:
-            self.print(task)
-
 
 class HtmlTaskPrinter(TaskPrinter):
     def print(self, task: dict) -> None:
@@ -112,6 +107,25 @@ class PlainTaskPrinter(TaskPrinter):
             self._printer("=" * 50)
 
 
+class OneLineTaskPrinter(TaskPrinter):
+    def print(self, task: dict) -> None:
+        self._printer(
+            " ".join(
+                [
+                    f"{Task.from_int(task['id'])}",
+                    f"{task['fields']['status']['name']:<12}",
+                    f"{task['fields']['priority']['name']:<12}",
+                    task["fields"]["name"],
+                ]
+            )
+        )
+
+
+class IdsTaskPrinter(TaskPrinter):
+    def print(self, task: dict) -> None:
+        self._printer(f"{Task.from_int(task['id'])}")
+
+
 def get_printer(format: TaskFormat) -> TaskPrinter:
     if format == TaskFormat.PLAIN:
         return PlainTaskPrinter(print)
@@ -123,5 +137,9 @@ def get_printer(format: TaskFormat) -> TaskPrinter:
         return MarkdownTaskPrinter(print)
     elif format == TaskFormat.WIKITEXT:
         return WikitextTaskPrinter(print)
+    elif format == TaskFormat.ONELINE:
+        return OneLineTaskPrinter(print)
+    elif format == TaskFormat.IDS:
+        return IdsTaskPrinter(print)
     else:
         raise ValueError(f"Unknown format: {format}")

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/phabricator.py

@@ -173,6 +173,7 @@ class PhabricatorClient:
         owner_phid: Optional[str] = None,
         backup_owner_phid: Optional[str] = None,
         project_phid: Optional[str] = None,
+        status: Optional[list[str]] = None,
     ) -> list[dict[str, Any]]:
         params = {
             "attachments[subscribers]": "true",
@@ -187,6 +188,9 @@ class PhabricatorClient:
             params["constraints[custom.train.backup][0]"] = backup_owner_phid
         if project_phid:
             params["constraints[projects][0]"] = project_phid
+        if status:
+            for i, value in enumerate(status):
+                params[f"constraints[statuses][{i}]"] = value
         return self._make_request("maniphest.search", params=params)["result"]["data"]
 
     def find_subtasks(self, parent_id: int) -> list[dict[str, Any]]:

{phable_cli-0.1.15 → phable_cli-0.1.17}/phable/task.py

@@ -30,3 +30,13 @@ class TaskStatus(StrEnum):
     stalled = "stalled"
     invalid = "invalid"
     declined = "declined"
+
+
+# TODO these are hard-coded for Wikimedia's Phab, we should do something better
+class TaskPriority(StrEnum):
+    lowest = "lowest"
+    low = "low"
+    medium = "medium"
+    high = "high"
+    unbreak = "unbreak"
+    triage = "triage"

{phable_cli-0.1.15 → phable_cli-0.1.17}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "phable-cli"
-version = "0.1.15"
+version = "0.1.17"
 description = "Manage Phabricator tasks from the comfort of your terminal"
 authors = ["Balthazar Rouberol <br@imap.cc>"]
 license = "MIT"
@@ -8,7 +8,7 @@ readme = "README.md"
 packages = [{ include = "phable" }]
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.11"
 requests = "^2.32.3"
 click = "^8.1.8"
 pytest = "^8.3.5"