gitd-client 0.14.0__tar.gz → 0.15.0__tar.gz

{gitd_client-0.14.0 → gitd_client-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: gitd-client
-Version: 0.14.0
+Version: 0.15.0
 Summary: Client for gitd: instant, secretless git checkouts for agent sandboxes
 Project-URL: Homepage, https://github.com/dooservice/gitd
 Project-URL: Source, https://github.com/dooservice/gitd/tree/main/sdk/python
@@ -15,7 +15,7 @@ Requires-Dist: grpcio>=1.84.0
 Requires-Dist: protobuf>=7.36.2
 Description-Content-Type: text/markdown
 
-# gitd for Python
+# gitd-client for Python
 
 A client for [gitd](https://github.com/dooservice/gitd): instant, secretless git checkouts
 for agent sandboxes. Your agents work in their own copy and publish a branch; they never
@@ -45,12 +45,13 @@ No call takes a credential: gitd reads and publishes with the ones it keeps.
 
 | Method | What it does |
 |---|---|
-| `prepare(url, path, *, branch, commit, submodules, full_history, strategy, on_progress)` | A workspace of a repository at a path under gitd's roots |
-| `update(path, *, branch, submodules, on_progress)` | To the tip of its branch, or of the branch given |
+| `prepare(url, path, *, branch, commit, submodules, full_history, strategy, warm, new_branch, on_progress)` | A workspace of a repository at a path under gitd's roots, on a new branch of its own with `new_branch` |
+| `update(path, *, branch, merge, submodules, on_progress)` | To the tip of its branch, or of the branch given; with `merge`, that branch merged into the one it is on |
 | `checkout(path, commit, *, submodules, on_progress)` | To a commit, as a rollback does |
 | `describe(path)` | Its repository, commit, branch, uncommitted changes and submodules |
-| `publish(path, branch, *, requested_by, pull_request, provenance, sandbox, update)` | Its commits pushed to a new branch, or with `update` an earlier publish's branch moved forward; its pull request opened or updated |
+| `publish(path, branch=None, *, requested_by, pull_request, provenance, sandbox, update)` | Its commits pushed to a new branch, or to the branch it is on when none is given; with `update`, or a branch it published before, that branch moved forward; its pull request opened or updated |
 | `remove(path)` | Deleted; its pool stays |
+| `list()` | Every workspace gitd made, described, with the branches published from each |
 | `probe(url)` | Whether it can be read, its default branch and branches |
 | `info()` | Which gitd answers, and how it makes workspaces here and why |
 | `audit(*, since, url, limit)` | Every publish, done or refused, newest first |

{gitd_client-0.14.0 → gitd_client-0.15.0}/README.md

@@ -1,4 +1,4 @@
-# gitd for Python
+# gitd-client for Python
 
 A client for [gitd](https://github.com/dooservice/gitd): instant, secretless git checkouts
 for agent sandboxes. Your agents work in their own copy and publish a branch; they never
@@ -28,12 +28,13 @@ No call takes a credential: gitd reads and publishes with the ones it keeps.
 
 | Method | What it does |
 |---|---|
-| `prepare(url, path, *, branch, commit, submodules, full_history, strategy, on_progress)` | A workspace of a repository at a path under gitd's roots |
-| `update(path, *, branch, submodules, on_progress)` | To the tip of its branch, or of the branch given |
+| `prepare(url, path, *, branch, commit, submodules, full_history, strategy, warm, new_branch, on_progress)` | A workspace of a repository at a path under gitd's roots, on a new branch of its own with `new_branch` |
+| `update(path, *, branch, merge, submodules, on_progress)` | To the tip of its branch, or of the branch given; with `merge`, that branch merged into the one it is on |
 | `checkout(path, commit, *, submodules, on_progress)` | To a commit, as a rollback does |
 | `describe(path)` | Its repository, commit, branch, uncommitted changes and submodules |
-| `publish(path, branch, *, requested_by, pull_request, provenance, sandbox, update)` | Its commits pushed to a new branch, or with `update` an earlier publish's branch moved forward; its pull request opened or updated |
+| `publish(path, branch=None, *, requested_by, pull_request, provenance, sandbox, update)` | Its commits pushed to a new branch, or to the branch it is on when none is given; with `update`, or a branch it published before, that branch moved forward; its pull request opened or updated |
 | `remove(path)` | Deleted; its pool stays |
+| `list()` | Every workspace gitd made, described, with the branches published from each |
 | `probe(url)` | Whether it can be read, its default branch and branches |
 | `info()` | Which gitd answers, and how it makes workspaces here and why |
 | `audit(*, since, url, limit)` | Every publish, done or refused, newest first |

{gitd_client-0.14.0 → gitd_client-0.15.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "gitd-client"
-version = "0.14.0"
+version = "0.15.0"
 description = "Client for gitd: instant, secretless git checkouts for agent sandboxes"
 readme = "README.md"
 license = "Apache-2.0"

{gitd_client-0.14.0 → gitd_client-0.15.0}/src/gitd/__init__.py

@@ -15,6 +15,7 @@ from .models import (
     Description,
     Info,
     Layers,
+    ListedWorkspace,
     PendingSubmodule,
     Probe,
     Progress,
@@ -71,6 +72,7 @@ __all__ = [
     "GitdError",
     "Info",
     "Layers",
+    "ListedWorkspace",
     "PendingSubmodule",
     "Probe",
     "Progress",

{gitd_client-0.14.0 → gitd_client-0.15.0}/src/gitd/client.py

@@ -12,7 +12,7 @@ from .comparison import Comparison, Conflict, Event, Side
 from .connection import Connection, OnProgress
 from .credentials_calls import Credentials
 from .endpoint_calls import Endpoint
-from .models import AuditEntry, Description, Info, Probe, Published, Strategy, Workspace
+from .models import AuditEntry, Description, Info, ListedWorkspace, Probe, Published, Strategy, Workspace
 from .publishing_calls import Publishing
 from .publishing_settings import Provenance, PullRequestOptions
 from .timestamps import Timestamp
@@ -75,13 +75,15 @@ class Gitd:
         full_history: bool = False,
         strategy: Strategy | None = None,
         warm: str = "",
+        new_branch: str = "",
         on_progress: OnProgress | None = None,
     ) -> Workspace:
         """Makes a workspace of a repository at a path under gitd's roots, at a commit, a
         branch, or the default branch. strategy is a preference: gitd falls back to copy when
         it cannot make one that way here. warm names a warm layer to stand on, its
         dependencies installed already: the workspace is then made by overlay, at the commit
-        the layer was sealed at, or not at all."""
+        the layer was sealed at, or not at all. new_branch starts the workspace on a branch
+        of its own, made there for the work: publish takes it when given no branch."""
         if commit:
             revision = messages.Revision(commit=commit)
         elif branch:
@@ -96,6 +98,7 @@ class Gitd:
             full_history=full_history,
             strategy=Strategy.preference(strategy),
             warm=warm,
+            new_branch=new_branch,
         )
         return Workspace.from_message(path, self.connection.follow(methods.PREPARE, request, on_progress))
 
@@ -104,11 +107,17 @@ class Gitd:
         path: str,
         *,
         branch: str | None = None,
+        merge: str | None = None,
         submodules: bool = False,
         on_progress: OnProgress | None = None,
     ) -> Workspace:
-        """Brings a workspace to the tip of its branch, or of the branch given."""
-        request = messages.UpdateRequest(path=path, branch=branch or "", with_submodules=submodules)
+        """Brings a workspace to the tip of its branch, or of the branch given. With merge,
+        merges that branch of the repository into the one the workspace is on instead, with a
+        merge commit; conflicts raise CONFLICT and stay marked in the workspace, to be
+        resolved and committed there."""
+        request = messages.UpdateRequest(
+            path=path, branch=branch or "", merge=merge or "", with_submodules=submodules
+        )
         return Workspace.from_message(path, self.connection.follow(methods.UPDATE, request, on_progress))
 
     def checkout(
@@ -131,7 +140,7 @@ class Gitd:
     def publish(
         self,
         path: str,
-        branch: str,
+        branch: str | None = None,
         *,
         requested_by: str = "",
         pull_request: PullRequestOptions | None = None,
@@ -139,18 +148,20 @@ class Gitd:
         sandbox: str = "",
         update: bool = False,
     ) -> Published:
-        """Pushes what was committed in a workspace to a new branch, with the credential gitd
-        keeps, and opens its pull request when the publishing settings or pull_request say
-        so. requested_by is who asked for the work, as their account on the host. With
-        sandbox, and path empty, publishes the branch a sandbox pushed through the endpoint.
+        """Pushes what was committed in a workspace to a new branch, or to the branch it is
+        on when none is given, with the credential gitd keeps, and opens its pull request
+        when the publishing settings or pull_request say so. requested_by is who asked for
+        the work, as their account on the host. With sandbox, and path empty, publishes the
+        branch a sandbox pushed through the endpoint.
 
         With update, the branch may exist from an earlier publish: it is moved forward, only
         ever as a fast-forward (BRANCH_EXISTS otherwise), and the pull request open from it is
-        updated rather than another opened. An update bringing nothing beyond what gitd
+        updated rather than another opened. A branch this workspace published before is
+        moved forward so without update. An update bringing nothing beyond what gitd
         published to the branch pushes nothing and still opens or updates the pull requests,
         so a publish whose pull request failed is retried by publishing again."""
         request: Any = messages.PublishRequest(
-            path=path, branch=branch, requested_by=requested_by, sandbox=sandbox, update=update
+            path=path, branch=branch or "", requested_by=requested_by, sandbox=sandbox, update=update
         )
         if pull_request is not None:
             request.pull_request.CopyFrom(pull_request.to_message())
@@ -229,6 +240,11 @@ class Gitd:
         """Deletes a workspace; its pool stays."""
         self.connection.call(methods.REMOVE, messages.RemoveRequest(path=path))
 
+    def list(self) -> list[ListedWorkspace]:
+        """Every workspace gitd made, described, with the branches published from each."""
+        response = self.connection.call(methods.LIST, messages.ListRequest())
+        return [ListedWorkspace.from_message(listed) for listed in response.workspaces]
+
     def audit(
         self,
         *,

{gitd_client-0.14.0 → gitd_client-0.15.0}/src/gitd/contract.json

@@ -291,6 +291,10 @@
                 {
                   "name": "REASON_BRANCH_EXISTS",
                   "number": 16
+                },
+                {
+                  "name": "REASON_CONFLICT",
+                  "number": 17
                 }
               ]
             }
@@ -364,6 +368,13 @@
               "label": "LABEL_OPTIONAL",
               "type": "TYPE_BOOL",
               "jsonName": "poolInside"
+            },
+            {
+              "name": "new_branch",
+              "number": 10,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_STRING",
+              "jsonName": "newBranch"
             }
           ]
         },
@@ -516,6 +527,13 @@
               "type": "TYPE_MESSAGE",
               "typeName": ".gitd.v1.Credential",
               "jsonName": "credentials"
+            },
+            {
+              "name": "merge",
+              "number": 5,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_STRING",
+              "jsonName": "merge"
             }
           ]
         },
@@ -773,6 +791,49 @@
             }
           ]
         },
+        {
+          "name": "ListRequest"
+        },
+        {
+          "name": "ListResponse",
+          "field": [
+            {
+              "name": "workspaces",
+              "number": 1,
+              "label": "LABEL_REPEATED",
+              "type": "TYPE_MESSAGE",
+              "typeName": ".gitd.v1.ListedWorkspace",
+              "jsonName": "workspaces"
+            }
+          ]
+        },
+        {
+          "name": "ListedWorkspace",
+          "field": [
+            {
+              "name": "path",
+              "number": 1,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_STRING",
+              "jsonName": "path"
+            },
+            {
+              "name": "description",
+              "number": 2,
+              "label": "LABEL_OPTIONAL",
+              "type": "TYPE_MESSAGE",
+              "typeName": ".gitd.v1.DescribeResponse",
+              "jsonName": "description"
+            },
+            {
+              "name": "published",
+              "number": 3,
+              "label": "LABEL_REPEATED",
+              "type": "TYPE_STRING",
+              "jsonName": "published"
+            }
+          ]
+        },
         {
           "name": "RemoveResponse"
         },
@@ -3000,6 +3061,11 @@
               "inputType": ".gitd.v1.RemoveRequest",
               "outputType": ".gitd.v1.RemoveResponse"
             },
+            {
+              "name": "List",
+              "inputType": ".gitd.v1.ListRequest",
+              "outputType": ".gitd.v1.ListResponse"
+            },
             {
               "name": "Adopt",
               "inputType": ".gitd.v1.AdoptRequest",

{gitd_client-0.14.0 → gitd_client-0.15.0}/src/gitd/messages.py

@@ -21,6 +21,8 @@ PublishRequest = contract.message("PublishRequest")
 PublishResponse = contract.message("PublishResponse")
 RemoveRequest = contract.message("RemoveRequest")
 RemoveResponse = contract.message("RemoveResponse")
+ListRequest = contract.message("ListRequest")
+ListResponse = contract.message("ListResponse")
 AuditRequest = contract.message("AuditRequest")
 AuditResponse = contract.message("AuditResponse")
 GitFailure = contract.message("GitFailure")

{gitd_client-0.14.0 → gitd_client-0.15.0}/src/gitd/methods.py

@@ -30,6 +30,7 @@ CHECKOUT = Method("WorkspaceService", "Checkout", messages.CheckoutResponse)
 DESCRIBE = Method("WorkspaceService", "Describe", messages.DescribeResponse)
 PUBLISH = Method("WorkspaceService", "Publish", messages.PublishResponse)
 REMOVE = Method("WorkspaceService", "Remove", messages.RemoveResponse)
+LIST = Method("WorkspaceService", "List", messages.ListResponse)
 CHANGES = Method("WorkspaceService", "Changes", messages.ChangesResponse)
 DIFF = Method("WorkspaceService", "Diff", messages.DiffResponse)
 COMPARE = Method("WorkspaceService", "Compare", messages.CompareResponse)

{gitd_client-0.14.0 → gitd_client-0.15.0}/src/gitd/models.py

@@ -164,6 +164,26 @@ class Description:
         )
 
 
+@dataclass(frozen=True)
+class ListedWorkspace:
+    """A workspace gitd made, what it is on disk, and the branches published from it, as
+    gitd recorded them. description is None when gitd could not describe it."""
+
+    path: str
+    description: Description | None
+    published: list[str] = field(default_factory=list)
+
+    @classmethod
+    def from_message(cls, listed: Any) -> ListedWorkspace:
+        return cls(
+            path=listed.path,
+            description=Description.from_message(listed.description)
+            if listed.HasField("description")
+            else None,
+            published=list(listed.published),
+        )
+
+
 @dataclass(frozen=True)
 class PublishedRepository:
     """A repository a publish pushed. path is the submodule's, empty for the workspace's own