suite-py 1.43.4__py3-none-any.whl → 1.46.0__py3-none-any.whl

suite_py/__version__.py

@@ -1,2 +1,2 @@
 # -*- encoding: utf-8 -*-
-__version__ = "1.43.4"
+__version__ = "1.46.0"

suite_py/cli.py

@@ -228,12 +228,17 @@ def bump(obj: Context, project: Optional[str] = None, version: Optional[str] = N
     "create-branch", help="Create local branch and set the YouTrack card in progress"
 )
 @click.option("--card", type=click.STRING, help="YouTrack card number (ex. PRIMA-123)")
+@click.option(
+    "--autostash",
+    is_flag=True,
+    help="Stash uncommitted changes before creating the branch and reapply them afterward",
+)
 @click.pass_obj
 @catch_exceptions
-def cli_create_branch(obj, card):
+def cli_create_branch(obj, card, autostash):
     from suite_py.commands.create_branch import CreateBranch
 
-    obj.call(CreateBranch, card=card).run()
+    obj.call(CreateBranch, card=card, autostash=autostash).run()
 
 
 @main.command("lock", help="Lock project on staging or prod")
@@ -260,6 +265,28 @@ def cli_unlock_project(obj, environment):
     obj.call(ProjectLock, env=environment, action="unlock").run()
 
 
+@main.command(
+    "estimate-cone",
+    help="Point-in-time estimate of the time needed to complete all unresolved children of a card using the Cone of Uncertainty",
+)
+@click.option("--issue", prompt="Issue ID", type=str)
+@click.option("--sprint-board", prompt="Sprint Board ID", type=str)
+@click.option("--previous-sprints", required=False, type=int, default=6)
+@click.pass_obj
+@catch_exceptions
+def estimate_cone(
+    obj: Context,
+    issue: Optional[str],
+    sprint_board: Optional[str],
+    previous_sprints: int,
+):
+    from suite_py.commands.estimate_cone import EstimateCone
+
+    obj.call(EstimateCone).run(
+        issue=issue, sprint_board=sprint_board, previous_sprints=previous_sprints
+    )
+
+
 @main.command("open-pr", help="Open a PR on GitHub")
 @click.pass_obj
 @catch_exceptions

suite_py/commands/create_branch.py

@@ -11,16 +11,17 @@ from suite_py.lib.handler.youtrack_handler import YoutrackHandler
 
 
 class CreateBranch:
-    def __init__(self, project, card, config, tokens):
+    def __init__(self, project, card, config, tokens, autostash=False):
         self._project = project
         self._card = card
         self._config = config
         self._youtrack = YoutrackHandler(config, tokens)
         self._git = GitHandler(project, config)
+        self._autostash = autostash
 
     @metrics.command("create-branch")
     def run(self):
-        if not self._git.is_detached() and self._git.is_dirty():
+        if not self._git.is_detached() and self._git.is_dirty() and not self._autostash:
             # Default behaviour is to pull when not detached.
             # Can't do that with uncommitted changes.
             logger.error("You have some uncommitted changes, I can't continue")
@@ -37,7 +38,7 @@ class CreateBranch:
             )
             sys.exit(-1)
 
-        self._checkout_branch(issue)
+        self._checkout_branch(issue, self._autostash)
 
         user = self._youtrack.get_current_user()
         self._youtrack.assign_to(issue["id"], user["login"])
@@ -94,7 +95,7 @@ class CreateBranch:
             )
             return []
 
-    def _checkout_branch(self, issue):
+    def _checkout_branch(self, issue, autostash=False):
         default_parent_branch_name = self._config.user.get(
             "default_parent_branch", self._git.current_branch_name()
         )
@@ -118,9 +119,9 @@ class CreateBranch:
 
             logger.error(f"Invalid branch name: {full_branch_name}. Try again?")
 
-        self._git.checkout(parent_branch_name)
+        self._git.checkout(parent_branch_name, autostash=autostash)
 
-        self._git.checkout(full_branch_name, new=True)
+        self._git.checkout(full_branch_name, new=True, autostash=autostash)
 
 
 # Normalize a string into a valid segment(ie. the part of the branch name between the /)

suite_py/commands/estimate_cone.py

@@ -0,0 +1,91 @@
+# -*- encoding: utf-8 -*-
+from suite_py.lib import metrics
+from suite_py.lib.handler.youtrack_handler import YoutrackHandler
+
+
+class EstimateCone:
+    def __init__(self, project, config, tokens):
+        self._project = project
+        self._config = config
+        self._youtrack = YoutrackHandler(config, tokens)
+
+    @metrics.command("estimate-cone")
+    def run(self, issue: str, sprint_board: str, previous_sprints: int):
+        remaining_story_points = self._sum_of_unresolved_descendant_story_points(issue)
+
+        current_sprint = self._youtrack.get_current_sprint(sprint_board)
+        sprints = self._youtrack.get_sprints(sprint_board)
+
+        current_sprint_index = next(
+            (
+                index
+                for index, sprint in enumerate(sprints)
+                if sprint["id"] == current_sprint["id"]
+            ),
+            None,
+        )
+
+        recent_sprints = sprints[
+            current_sprint_index - previous_sprints : current_sprint_index
+        ]
+
+        sprints_resolved_story_points = [
+            self._youtrack.get_sprint_resolved_story_points(sprint_board, sprint["id"])
+            for sprint in recent_sprints
+        ]
+
+        average_story_points_per_sprint = sum(sprints_resolved_story_points) / len(
+            sprints_resolved_story_points
+        )
+        max_story_points_per_sprint = (
+            max(sprints_resolved_story_points) or 1
+        )  # Avoid division by zero
+        min_story_points_per_sprint = (
+            min(sprints_resolved_story_points) or 1
+        )  # Avoid division by zero
+
+        average_estimate = remaining_story_points / average_story_points_per_sprint
+        best_estimate = remaining_story_points / max_story_points_per_sprint
+        worst_estimate = remaining_story_points / min_story_points_per_sprint
+
+        print(f"Remaining story points: {remaining_story_points}")
+
+        print(f"Max story points per sprint: {max_story_points_per_sprint}")
+        print(f"Average story points per sprint: {average_story_points_per_sprint:.2f}")
+        print(f"Min story points per sprint: {min_story_points_per_sprint}")
+
+        print(f"Average estimate: {average_estimate:.2f} sprints")
+        print(f"Best estimate: {best_estimate:.2f} sprints")
+        print(f"Worst estimate: {worst_estimate:.2f} sprints")
+
+        print(f"Sprints resolved story points: {sprints_resolved_story_points}")
+
+    def _sum_of_unresolved_descendant_story_points(self, _issue_readable_id):
+        descendants = self._youtrack.get_issue_descendants(_issue_readable_id)
+
+        descendants_digested = [
+            {
+                "id": descendant.get("idReadable"),
+                "summary": descendant.get("summary"),
+                "resolved": bool(descendant.get("resolved")),
+                "story_points": next(
+                    (
+                        field["value"]
+                        for field in descendant["customFields"]
+                        if field["name"] == "Story Points"
+                    )
+                )
+                or 0,
+            }
+            for descendant in descendants
+        ]
+
+        for descendant in descendants_digested:
+            if not descendant["resolved"]:
+                print(descendant)
+
+        return sum(
+            descendant["story_points"]
+            for descendant in descendants_digested
+            if not descendant["resolved"]
+        )

suite_py/lib/handler/git_handler.py

@@ -32,7 +32,7 @@ class GitHandler:
             check=True,
         )
 
-    def checkout(self, branch, new=False):
+    def checkout(self, branch, new=False, autostash=False):
         try:
             if new:
                 subprocess.run(
@@ -51,7 +51,7 @@ class GitHandler:
                     stderr=subprocess.DEVNULL,
                 )
                 if not self.is_detached():  # Skip pulling if detached
-                    self.pull(rebase=True)
+                    self.pull(rebase=True, autostash=autostash)
         except CalledProcessError as e:
             logger.error(f"Error during command execution: {e}")
             sys.exit(-1)
@@ -99,12 +99,16 @@ class GitHandler:
                 logger.error(f"Error during command execution: {e}")
                 sys.exit(-1)
 
-    def pull(self, rebase=False):
+    def pull(self, rebase=False, autostash=False):
         with Halo(text=f"Pulling {self._repo}...", spinner="dots", color="magenta"):
             try:
                 if rebase:
                     subprocess.run(
-                        ["git", "pull", "--rebase"],
+                        (
+                            ["git", "pull", "--rebase", "--autostash"]
+                            if autostash
+                            else ["git", "pull", "--rebase"]
+                        ),
                         cwd=self._path,
                         check=True,
                         stdout=subprocess.DEVNULL,
@@ -112,7 +116,11 @@ class GitHandler:
                     )
                 else:
                     subprocess.run(
-                        ["git", "pull"],
+                        (
+                            ["git", "pull", "--autostash"]
+                            if autostash
+                            else ["git", "pull"]
+                        ),
                         cwd=self._path,
                         check=True,
                         stdout=subprocess.DEVNULL,

suite_py/lib/handler/youtrack_handler.py

@@ -23,6 +23,7 @@ WORKABLE_CARD_TYPES = [
 ]
 
 
+# pylint: disable=too-many-public-methods
 class YoutrackHandler:
     def __init__(self, config, tokens):
         headers = {"Accept": "application/json", "Content-Type": "application/json"}
@@ -43,9 +44,15 @@ class YoutrackHandler:
 
     def get_issue(self, issue_id):
         logger.debug(f"YouTrack issue_id: {issue_id}")
-        params = {
-            "fields": "$type,id,idReadable,summary,parent(issues(id)),customFields(name,value(name))"
-        }
+        _fields = [
+            "$type",
+            "id",
+            "idReadable",
+            "summary",
+            "parent(issues(id))",
+            "customFields(name,value(name))",
+        ]
+        params = {"fields": ",".join(_fields)}
         issue = self._client.get(f"issues/{issue_id}", params=params).json()
         issue["Type"] = self._get_issue_type_name(issue)
         logger.debug(f"YouTrack Issue json {issue}")
@@ -214,3 +221,69 @@ class YoutrackHandler:
         parent = issue["parent"]["issues"][0]
         # recursively get parent issue's type
         return self.get_issue(parent["id"])["Type"]
+
+    def get_issue_descendants(self, issue_id):
+        _fields = [
+            "resolved",
+            "subtasks(issues(id,idReadable,resolved,summary,customFields(name,value),subtasks(issues(id))))",
+        ]
+        params = {"fields": ",".join(_fields)}
+        issue = self._client.get(f"issues/{issue_id}", params=params).json()
+
+        descendants = []
+        for child in issue.get("subtasks", {}).get("issues", []):
+            descendants.append(child)
+            if child.get("subtasks", {}).get("issues"):
+                descendants.extend(self.get_issue_descendants(child["id"]))
+        return descendants
+
+    def get_current_sprint(self, agile_board_id):
+        params = {
+            "fields": "id",
+        }
+        return self._client.get(
+            f"agiles/{agile_board_id}/sprints/current", params=params
+        ).json()
+
+    def get_sprints(self, agile_board_id):
+        params = {
+            "fields": "id",
+        }
+        return self._client.get(
+            f"agiles/{agile_board_id}/sprints", params=params
+        ).json()
+
+    def get_sprint_resolved_story_points(self, agile_board_id, sprint_id):
+        """Get the sum of the story point estimates of all resolved issues of a sprint."""
+        params = {
+            "fields": "id,name,goal,issues(id,idReadable,summary,resolved,customFields(name,value))",
+        }
+        sprint = self._client.get(
+            f"agiles/{agile_board_id}/sprints/{sprint_id}", params=params
+        ).json()
+
+        resolved_issues = [issue for issue in sprint["issues"] if issue["resolved"]]
+
+        total_story_points = 0
+        for issue in resolved_issues:
+            # Find the Story Points custom field
+            story_points_field = next(
+                (
+                    field
+                    for field in issue.get("customFields", [])
+                    if field["name"] == "Story Points"
+                ),
+                None,
+            )
+            if story_points_field and story_points_field.get("value"):
+                try:
+                    story_points = int(story_points_field["value"])
+                    total_story_points += story_points
+                except (ValueError, TypeError):
+                    # Skip issues with invalid story points values
+                    logger.debug(
+                        f"Invalid story points value for issue {issue.get('idReadable', 'unknown')}: {story_points_field.get('value')}"
+                    )
+                    continue
+
+        return total_story_points

{suite_py-1.43.4.dist-info → suite_py-1.46.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: suite-py
-Version: 1.43.4
+Version: 1.46.0
 Summary: 
 Author: larrywax, EugenioLaghi, michelangelomo
 Author-email: devops@prima.it
@@ -28,7 +28,7 @@ Requires-Dist: pytest (>=7.0.0)
 Requires-Dist: python-dateutil (>=2.8.2)
 Requires-Dist: requests (>=2.26.0)
 Requires-Dist: requests-toolbelt (>=0.9.1)
-Requires-Dist: rich (==14.0.0)
+Requires-Dist: rich (==14.1.0)
 Requires-Dist: semver (>=3.0.4,<4.0.0)
 Requires-Dist: termcolor (>=1.1.0)
 Requires-Dist: truststore (>=0.7,<0.11) ; python_version >= "3.10"

{suite_py-1.43.4.dist-info → suite_py-1.46.0.dist-info}/RECORD

@@ -1,13 +1,14 @@
 suite_py/__init__.py,sha256=REmi3D0X2G1ZWnYpKs8Ffm3NIj-Hw6dMuvz2b9NW344,142
-suite_py/__version__.py,sha256=w3tVD5lyKBwCl5ZXYrElSDauAfbifeM2SpIKA2BUPQI,49
-suite_py/cli.py,sha256=i548aSSz6zy-2PTieWzql-qv3GQI3Wv86ZlQNCIbM_0,10270
+suite_py/__version__.py,sha256=y_irmWufF1id-FK0jAuz962BX7uXinVOrDlZ-WZGMts,49
+suite_py/cli.py,sha256=hBbNXb9vVk8lSJXRrb1GctTp3EUjMYFWS9mn_HaNG9I,11155
 suite_py/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 suite_py/commands/ask_review.py,sha256=yN__Ac-fiZBPShjRDhyCCQZGfVlQE16KozoJk4UtiNw,3788
 suite_py/commands/bump.py,sha256=oFZU1hPfD11ujFC5G7wFyQOf2alY3xp2SO1h1ldjf3s,5406
 suite_py/commands/check.py,sha256=jCX59g6DgTA55yD_75mgcqJ5zCjRwl_eIRGDeUFjUWY,3316
 suite_py/commands/common.py,sha256=aWCEvO3hqdheuMUmZcHuc9EGZPQTk7VkzkHJk283MxQ,566
 suite_py/commands/context.py,sha256=6dssSqoABPb9gLmL3Y7W2iAGxrY_oma665X8zrSkNNQ,1079
-suite_py/commands/create_branch.py,sha256=cDpeDsQk1AK70GkWz-hTduaEeU65x1wck1b-5nKIMew,4424
+suite_py/commands/create_branch.py,sha256=6sveTtOg_0lQl-MYizcnnyYyAunA_dXunQAxv7szllE,4577
+suite_py/commands/estimate_cone.py,sha256=_RekBWzPlzInlZRpSIeKUVkx-A8Phx0IEYVouTbN7z4,3411
 suite_py/commands/login.py,sha256=A59e1HsbN7Ocv2L_2H0Eb7MZK7AzLkLb72QxBthnIqU,258
 suite_py/commands/merge_pr.py,sha256=fXIE8mT9MjvvpqE-uVdXGBVFGhn0eQzcBxNr-N8SyAY,5171
 suite_py/commands/open_pr.py,sha256=e6IT6f8L_HKsOEtrGHZQ2HWrFwmvIgXGNCK_TU0WE9k,7009
@@ -22,14 +23,14 @@ suite_py/lib/handler/aws_handler.py,sha256=dRvRDicikfRbuFtCLPbevaX-yC-fO4LwXFdyq
 suite_py/lib/handler/captainhook_handler.py,sha256=R30_Vvh2ck7fM5fwbpm3UV_FtlQr2xnx6RJpkG1Gn14,2983
 suite_py/lib/handler/changelog_handler.py,sha256=-ppnRl3smBA_ys8tPqXmytS4eyntlwfawC2fiXFcwlw,4818
 suite_py/lib/handler/frequent_reviewers_handler.py,sha256=EIJX5FEMWzrxuXS9A17hu1vfxgJSOHSBX_ahCEZ2FVA,2185
-suite_py/lib/handler/git_handler.py,sha256=Y2hKR5sUKBhfRfQrMNjyCScJpdyPJ7XWK9f3ykx7Lf0,12710
+suite_py/lib/handler/git_handler.py,sha256=8UVttqo65CTg5LCvOBTDXb_sNxLKUrpevCGiohp42Is,13099
 suite_py/lib/handler/github_handler.py,sha256=xnBATLOTnOLpiYE29WwUrtDr7hxusfId9a1KbfK1OyA,2952
 suite_py/lib/handler/metrics_handler.py,sha256=-Tp62pFIiYsBkDga0nQG3lWU-gxH68wEjIIIJeU1jHk,3159
 suite_py/lib/handler/okta_handler.py,sha256=UiRcBDmFkMFi9H7Me1QaruC8yPI5fFbnLGzOf3kfxG0,2805
 suite_py/lib/handler/pre_commit_handler.py,sha256=nwqVgC-KnUjn7NVIHZ0VmDdUfp6Q1ieFIth-1_U76Gw,3740
 suite_py/lib/handler/prompt_utils.py,sha256=vgk1O7h-iYEAZv1sXtMh8xIgH1djI398rzxRIgZWZcg,2474
 suite_py/lib/handler/version_handler.py,sha256=DXTx4yCAbFVC6CdMqPJ-LiN5YM-dT2zklG8POyKTP5A,6774
-suite_py/lib/handler/youtrack_handler.py,sha256=eTGBBXjlN_ay1cawtnZ2IG6l78dDyKdMN1x6PxcvtA0,7499
+suite_py/lib/handler/youtrack_handler.py,sha256=_CwzeFhj7kMYb61CN8IYF0IE55Zrj6vZT38SUZLA5B8,10192
 suite_py/lib/logger.py,sha256=aL870R69enNL9K8mQrMFgSAVUPXXgkvaVp6xTprCBWA,1029
 suite_py/lib/metrics.py,sha256=urTBVzIc1Ys6OHPOO32fLPPRcQU45tzM3XMJ7mUl5dc,1629
 suite_py/lib/oauth.py,sha256=tE3MgCnYhW6ZIbkyeUohFTOUvnBsrJXfHN8XsAVQNXk,5077
@@ -39,7 +40,7 @@ suite_py/lib/requests/session.py,sha256=P32H3cWnCWunu91WIj2iDM5U3HzaBglg60VN_C9J
 suite_py/lib/symbol.py,sha256=z3QYBuNIwD3qQ3zF-cLOomIr_-C3bO_u5UIDAHMiyTo,60
 suite_py/lib/tokens.py,sha256=4DbsHDFLIxs40t3mRw_ZyhmejZQ0Bht7iAL8dTCTQd4,5458
 suite_py/templates/login.html,sha256=fJLls2SB84oZTSrxTdA5q1PqfvIHcCD4fhVWfyco7Ig,861
-suite_py-1.43.4.dist-info/METADATA,sha256=YMvfM9IDcAbA6QO5C_WkEKhPUYvPBVBq3hj5sRRQxjM,1250
-suite_py-1.43.4.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-suite_py-1.43.4.dist-info/entry_points.txt,sha256=dVKLC-9Infy-dHJT_MkK6LcDjOgBCJ8lfPkURJhBjxE,46
-suite_py-1.43.4.dist-info/RECORD,,
+suite_py-1.46.0.dist-info/METADATA,sha256=xKqjzEcrChO20inY1mhWsY49b3tJVhvdE8HchWfwPJ4,1250
+suite_py-1.46.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+suite_py-1.46.0.dist-info/entry_points.txt,sha256=dVKLC-9Infy-dHJT_MkK6LcDjOgBCJ8lfPkURJhBjxE,46
+suite_py-1.46.0.dist-info/RECORD,,