contree-client 0.1.0__tar.gz

contree_client-0.1.0/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

contree_client-0.1.0/PKG-INFO

@@ -0,0 +1,389 @@
+Metadata-Version: 2.4
+Name: contree-client
+Version: 0.1.0
+Summary: Python client for the Contree API, generated from the OpenAPI specification
+Author: Dmitry Orlov
+Author-email: Dmitry Orlov <mosquito@nebius.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9 ; extra == 'aiohttp'
+Requires-Dist: contree-client[urllib3,requests,aiohttp,httpx] ; extra == 'dev'
+Requires-Dist: pytest>=8 ; extra == 'dev'
+Requires-Dist: pytest-cov>=7.1.0 ; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.3 ; extra == 'dev'
+Requires-Dist: markdown-pytest[async]>=0.3 ; extra == 'dev'
+Requires-Dist: types-requests ; extra == 'dev'
+Requires-Dist: httpx>=0.27 ; extra == 'httpx'
+Requires-Dist: requests>=2.28 ; extra == 'requests'
+Requires-Dist: urllib3>=2.0 ; extra == 'urllib3'
+Requires-Python: >=3.10
+Project-URL: Homepage, https://contree.dev/
+Project-URL: Documentation, https://docs.tokenfactory.nebius.com/sandboxes/overview
+Provides-Extra: aiohttp
+Provides-Extra: dev
+Provides-Extra: httpx
+Provides-Extra: requests
+Provides-Extra: urllib3
+Description-Content-Type: text/markdown
+
+# contree-client
+
+Python client for the Contree API — sandboxed code execution
+combining virtual machine isolation with container operational
+efficiency.
+
+Synchronous clients are named `ContreeClient`, asynchronous ones are
+named `ContreeAsyncClient`; every backend shares the same interface:
+
+| Backend     | Extra                      | Import                                                          |
+|-------------|----------------------------|-----------------------------------------------------------------|
+| http.client | — (stdlib)                 | `from contree_client.http import ContreeClient`                 |
+| urllib3     | `contree-client[urllib3]`  | `from contree_client.urllib3 import ContreeClient`              |
+| requests    | `contree-client[requests]` | `from contree_client.requests import ContreeClient`             |
+| httpx       | `contree-client[httpx]`    | `from contree_client.httpx import ContreeClient` / `ContreeAsyncClient` |
+| aiohttp     | `contree-client[aiohttp]`  | `from contree_client.aiohttp import ContreeAsyncClient`         |
+
+Or let the package pick the first installed backend:
+
+<!-- name: test_readme_autodetect -->
+```python
+from contree_client.sync import ContreeClient
+from contree_client.asyncio import ContreeAsyncClient
+```
+
+## Quick start
+
+<!--
+name: test_readme_quick_start;
+fixtures: tmp_path, monkeypatch
+```python
+from contree_client import models, testing
+
+OP_UUID = "87654321-9abc-baba-deda-0123456789ab"
+EVENTS = [
+    models.OperationEvent.from_dict(event)
+    for event in (
+        {
+            "id": 1,
+            "ts": "2026-06-08T20:00:00Z",
+            "spid": 1,
+            "type": "stdout",
+            "data": {"value": "Linux\n", "encoding": "ascii"},
+        },
+        {
+            "id": 2,
+            "ts": "2026-06-08T20:00:01Z",
+            "spid": 0,
+            "type": "completion",
+            "data": {"status": "SUCCESS", "error": None, "duration_ms": 12},
+        },
+    )
+]
+
+
+class QuickStartDouble(testing.ContreeClient):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.mock(
+            "spawn_instance",
+            models.InstanceSpawnResponse.from_dict({"uuid": OP_UUID}),
+        )
+        self.mock("iter_operation_events", EVENTS)
+
+
+(tmp_path / "auth.ini").write_text(
+    "[DEFAULT]\nprofile = default\n"
+    "[profile:default]\ntoken = SECRET\nurl = https://contree.example.com\n"
+)
+monkeypatch.setenv("CONTREE_HOME", str(tmp_path))
+monkeypatch.delenv("CONTREE_PROFILE", raising=False)
+monkeypatch.setattr("contree_client.sync.ContreeClient", QuickStartDouble)
+```
+-->
+```python
+from contree_client.sync import ContreeClient
+
+# reuse a saved Contree profile,
+# or pass credentials directly: ContreeClient("IAM_TOKEN", project=...)
+with ContreeClient.from_profile() as client:
+    response = client.spawn_instance("uname -a", "tag:ubuntu:latest", shell=True)
+    for event in client.iter_operation_events(response.uuid, follow=True):
+        print(event.type, event.data)
+```
+
+## Use cases
+
+Run a command and read its output:
+
+<!--
+name: test_readme_use_cases;
+fixtures: tmp_path, monkeypatch
+```python
+import gzip
+import io
+import tarfile
+
+from contree_client import models, testing
+
+OP_UUID = "87654321-9abc-baba-deda-0123456789ab"
+IMG_UUID = "12345678-9abc-baba-deda-0123456789ab"
+EVENTS = [
+    models.OperationEvent.from_dict(event)
+    for event in (
+        {
+            "id": 1,
+            "ts": "2026-06-08T20:00:00Z",
+            "spid": 1,
+            "type": "stdout",
+            "data": {"value": "hello\n", "encoding": "ascii"},
+        },
+        {
+            "id": 2,
+            "ts": "2026-06-08T20:00:01Z",
+            "spid": 0,
+            "type": "completion",
+            "data": {"status": "SUCCESS", "error": None, "duration_ms": 12},
+        },
+    )
+]
+OPERATION = models.OperationResponse.from_dict(
+    {
+        "uuid": OP_UUID,
+        "kind": "instance",
+        "status": "SUCCESS",
+        "metadata": {
+            "command": "echo hello",
+            "image": "tag:ubuntu:latest",
+            "result": {"stdout": {"value": "hello\n", "encoding": "ascii"}},
+        },
+    }
+)
+buffer = io.BytesIO()
+with tarfile.open(fileobj=buffer, mode="w") as tar:
+    payload = b"127.0.0.1 localhost\n"
+    info = tarfile.TarInfo("etc/hosts")
+    info.size = len(payload)
+    tar.addfile(info, io.BytesIO(payload))
+TAR_BYTES = buffer.getvalue()
+
+
+class UseCaseDouble(testing.ContreeClient):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.mock(
+            "spawn_instance",
+            models.InstanceSpawnResponse.from_dict({"uuid": OP_UUID}),
+        )
+        self.mock("get_operation_status", OPERATION)
+        self.mock("iter_operation_events", EVENTS)
+        self.mock(
+            "upload_file",
+            models.FileResponse.from_dict(
+                {
+                    "uuid": "a9165a5d-5c86-4bd8-8ee4-ae46c19cf45d",
+                    "sha256": "0" * 64,
+                    "size": 8,
+                }
+            ),
+        )
+        self.mock("import_image", OP_UUID)
+        self.mock("inspect_find_image_by_tag", IMG_UUID)
+        self.mock(
+            "inspect_image_list",
+            models.DirectoryList.from_dict({"path": "/etc", "files": []}),
+        )
+        self.mock("inspect_image_archive", [TAR_BYTES])
+
+
+monkeypatch.chdir(tmp_path)
+(tmp_path / "data.txt").write_text("one\ntwo\n")
+(tmp_path / "auth.ini").write_text(
+    "[DEFAULT]\nprofile = default\n"
+    "[profile:default]\ntoken = SECRET\nurl = https://contree.example.com\n"
+)
+monkeypatch.setenv("CONTREE_HOME", str(tmp_path))
+monkeypatch.delenv("CONTREE_PROFILE", raising=False)
+ContreeClient = UseCaseDouble
+client = UseCaseDouble("IAM_TOKEN")
+```
+-->
+```python
+from contree_client import OperationStatus
+
+response = client.spawn_instance(
+    "echo hello",
+    "tag:ubuntu:latest",
+    shell=True,
+    disposable=True,   # do not persist a result image
+    timeout=60,
+)
+operation = client.wait_operation(response.uuid)
+assert operation.status is OperationStatus.SUCCESS
+print(operation.metadata.result.stdout.as_text())
+```
+
+Follow the live event stream with transparent reconnection
+(`Last-Event-Id` resume; ends on the `completion` event):
+
+<!-- name: test_readme_use_cases -->
+```python
+import sys
+
+from contree_client import decode_chunk
+
+for event in client.follow_operation_events(response.uuid):
+    if event.type in ("stdout", "stderr"):
+        sys.stdout.buffer.write(decode_chunk(event.data))
+```
+
+Retry transient failures (network errors, 410/425/5xx) automatically:
+
+<!-- name: test_readme_use_cases -->
+```python
+from contree_client import RetryPolicy
+
+client = ContreeClient.from_profile(retry=RetryPolicy())
+```
+
+Stage files into the sandbox:
+
+<!-- name: test_readme_use_cases -->
+```python
+from contree_client import FileSpec
+
+uploaded = client.upload_file(open("data.txt", "rb"))
+client.spawn_instance(
+    "wc -l /work/data.txt",
+    "tag:ubuntu:latest",
+    shell=True,
+    files={"/work/data.txt": FileSpec(uuid=uploaded.uuid, mode="0644")},
+)
+```
+
+Import an image and inspect it without spawning anything:
+
+<!-- name: test_readme_use_cases -->
+```python
+from contree_client import ImageImportRegistry
+
+operation_id = client.import_image(
+    ImageImportRegistry(url="docker://docker.io/library/busybox:latest"),
+    tag="busybox:latest",
+)
+image_uuid = client.inspect_find_image_by_tag("busybox:latest")
+print(client.inspect_image_list(image_uuid, "/etc").files)
+```
+
+Download a directory as a tar stream:
+
+<!-- name: test_readme_use_cases -->
+```python
+with open("etc.tar", "wb") as archive:
+    for chunk in client.inspect_image_archive(image_uuid, "/etc"):
+        archive.write(chunk)
+```
+
+Asynchronous flavour mirrors the sync API exactly:
+
+<!--
+name: async test_readme_async;
+fixtures: tmp_path, monkeypatch
+```python
+from contree_client import models, testing
+
+
+class AsyncDouble(testing.ContreeAsyncClient):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.mock(
+            "whoami",
+            models.WhoAmIResponse.from_dict(
+                {
+                    "token_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+                    "token_expiration": None,
+                    "permissions": {"spawn": True},
+                    "operations_stat": {},
+                }
+            ),
+        )
+
+
+(tmp_path / "auth.ini").write_text(
+    "[DEFAULT]\nprofile = default\n"
+    "[profile:default]\ntoken = SECRET\nurl = https://contree.example.com\n"
+)
+monkeypatch.setenv("CONTREE_HOME", str(tmp_path))
+monkeypatch.delenv("CONTREE_PROFILE", raising=False)
+monkeypatch.setattr("contree_client.asyncio.ContreeAsyncClient", AsyncDouble)
+```
+-->
+```python
+from contree_client.asyncio import ContreeAsyncClient
+
+async with ContreeAsyncClient.from_profile() as client:
+    me = await client.whoami()
+    print(me.permissions)
+```
+
+Test your code without a server — the in-memory double from
+`contree_client.testing` implements the same interface as every real
+backend; unmocked methods raise, calls are recorded:
+
+<!--
+name: test_readme_testing
+```python
+from contree_client import models
+
+spawn_response = models.InstanceSpawnResponse.from_dict(
+    {"uuid": "87654321-9abc-baba-deda-0123456789ab"}
+)
+stdout_event = models.OperationEvent.from_dict(
+    {
+        "id": 1,
+        "ts": "2026-06-08T20:00:00Z",
+        "spid": 1,
+        "type": "stdout",
+        "data": {"value": "hi\n", "encoding": "ascii"},
+    }
+)
+exit_event = stdout_event
+
+
+def run_my_code(client):
+    response = client.spawn_instance("uname -a", "tag:ubuntu:latest", shell=True)
+    for event in client.iter_operation_events(response.uuid):
+        pass
+```
+-->
+```python
+from contree_client.testing import ContreeClient
+
+client = ContreeClient()
+client.mock("spawn_instance", spawn_response)
+client.mock("iter_operation_events", [stdout_event, exit_event])
+
+run_my_code(client)
+
+assert client.calls_for("spawn_instance")
+```
+
+Debug logging (redacted, off by default):
+
+<!-- name: test_readme_logging -->
+```python
+import logging
+
+from contree_client.types import set_log_level
+
+set_log_level(logging.DEBUG)
+```
+<!--
+name: test_readme_logging
+```python
+set_log_level(logging.ERROR)  # keep the other examples quiet
+```
+-->
+
+## Copyright
+
+Nebius B.V. 2026, Licensed under the Apache License, Version 2.0 (see "LICENSE" file).