fcvm 0.7.0__tar.gz

fcvm-0.7.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fcvm-0.7.0/NOTICE

@@ -0,0 +1,12 @@
+fcvm
+Copyright 2026 Carlos Bravo
+https://github.com/carlosbravoa/fcvm
+https://cabra-consulting.com/
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+It includes xterm.js and its fit addon (lib/web/static/vendor/):
+  Copyright (c) 2017-2019, The xterm.js authors
+  Copyright (c) 2014-2016, SourceLair Private Company
+  Copyright (c) 2012-2013, Christopher Jeffrey
+licensed under the MIT License (see lib/web/static/vendor/LICENSE.xterm).

fcvm-0.7.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: fcvm
+Version: 0.7.0
+Summary: A client for the fcvm HTTP API: Firecracker microVM sandboxes from Python
+Author: Carlos Bravo
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/carlosbravoa/fcvm
+Project-URL: Documentation, https://github.com/carlosbravoa/fcvm/blob/main/sdk/README.md
+Project-URL: Issues, https://github.com/carlosbravoa/fcvm/issues
+Project-URL: Changelog, https://github.com/carlosbravoa/fcvm/blob/main/CHANGELOG.md
+Keywords: firecracker,microvm,sandbox,ai-agents,virtualization,isolation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Emulators
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Dynamic: license-file
+
+# fcvm for Python
+
+A client for the HTTP API of [fcvm](https://github.com/carlosbravoa/fcvm),
+which runs disposable, isolated Firecracker microVMs with container
+ergonomics. Use it to give an agent framework, a test harness or a build
+pipeline real VM sandboxes: create one from any OCI image, run commands,
+move files, snapshot it and fork running copies in about 150 ms.
+
+The client has no dependencies and needs Python 3.9 or newer. The VMs run
+on a Linux host with KVM where fcvm is installed; the client itself runs
+anywhere that can reach that host's API.
+
+```sh
+pip install fcvm
+```
+
+```python
+from fcvm import Client
+
+c = Client()
+with c.create("box", template="python-sandbox", ttl="1h") as sb:      # removed when the block ends
+    out = sb.run("pip install -q requests && python -c 'import requests; print(requests.__version__)'")
+    sb.write_file("/work/app.py", "print('hi')\n")
+    print(sb.exec("python /work/app.py").stdout)                      # ExecResult: exit_code, stdout, stderr
+    job = sb.exec("python -m http.server 8000", background=True)      # a Job
+    port = sb.publish(8000)                                           # http://127.0.0.1:{port} on the host
+    job.kill()
+
+snap = c.sandbox("prepared").snapshot("ready")
+forks = snap.fork("try", count=3)                                     # three running Sandbox objects
+```
+
+`Client()` finds the local fcvm service by itself. For another host, set
+`FCVM_URL` and `FCVM_TOKEN`. The token gives full control of fcvm, so treat
+it like an SSH key.
+
+- [All methods](https://github.com/carlosbravoa/fcvm/blob/main/sdk/README.md)
+- [The HTTP API](https://github.com/carlosbravoa/fcvm/blob/main/docs/api.md)
+- [Installing fcvm](https://github.com/carlosbravoa/fcvm/blob/main/docs/getting-started.md)
+
+Apache License 2.0.

fcvm-0.7.0/README.md

@@ -0,0 +1,41 @@
+# fcvm for Python
+
+A client for the HTTP API of [fcvm](https://github.com/carlosbravoa/fcvm),
+which runs disposable, isolated Firecracker microVMs with container
+ergonomics. Use it to give an agent framework, a test harness or a build
+pipeline real VM sandboxes: create one from any OCI image, run commands,
+move files, snapshot it and fork running copies in about 150 ms.
+
+The client has no dependencies and needs Python 3.9 or newer. The VMs run
+on a Linux host with KVM where fcvm is installed; the client itself runs
+anywhere that can reach that host's API.
+
+```sh
+pip install fcvm
+```
+
+```python
+from fcvm import Client
+
+c = Client()
+with c.create("box", template="python-sandbox", ttl="1h") as sb:      # removed when the block ends
+    out = sb.run("pip install -q requests && python -c 'import requests; print(requests.__version__)'")
+    sb.write_file("/work/app.py", "print('hi')\n")
+    print(sb.exec("python /work/app.py").stdout)                      # ExecResult: exit_code, stdout, stderr
+    job = sb.exec("python -m http.server 8000", background=True)      # a Job
+    port = sb.publish(8000)                                           # http://127.0.0.1:{port} on the host
+    job.kill()
+
+snap = c.sandbox("prepared").snapshot("ready")
+forks = snap.fork("try", count=3)                                     # three running Sandbox objects
+```
+
+`Client()` finds the local fcvm service by itself. For another host, set
+`FCVM_URL` and `FCVM_TOKEN`. The token gives full control of fcvm, so treat
+it like an SSH key.
+
+- [All methods](https://github.com/carlosbravoa/fcvm/blob/main/sdk/README.md)
+- [The HTTP API](https://github.com/carlosbravoa/fcvm/blob/main/docs/api.md)
+- [Installing fcvm](https://github.com/carlosbravoa/fcvm/blob/main/docs/getting-started.md)
+
+Apache License 2.0.

fcvm-0.7.0/fcvm.egg-info/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: fcvm
+Version: 0.7.0
+Summary: A client for the fcvm HTTP API: Firecracker microVM sandboxes from Python
+Author: Carlos Bravo
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/carlosbravoa/fcvm
+Project-URL: Documentation, https://github.com/carlosbravoa/fcvm/blob/main/sdk/README.md
+Project-URL: Issues, https://github.com/carlosbravoa/fcvm/issues
+Project-URL: Changelog, https://github.com/carlosbravoa/fcvm/blob/main/CHANGELOG.md
+Keywords: firecracker,microvm,sandbox,ai-agents,virtualization,isolation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Emulators
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Dynamic: license-file
+
+# fcvm for Python
+
+A client for the HTTP API of [fcvm](https://github.com/carlosbravoa/fcvm),
+which runs disposable, isolated Firecracker microVMs with container
+ergonomics. Use it to give an agent framework, a test harness or a build
+pipeline real VM sandboxes: create one from any OCI image, run commands,
+move files, snapshot it and fork running copies in about 150 ms.
+
+The client has no dependencies and needs Python 3.9 or newer. The VMs run
+on a Linux host with KVM where fcvm is installed; the client itself runs
+anywhere that can reach that host's API.
+
+```sh
+pip install fcvm
+```
+
+```python
+from fcvm import Client
+
+c = Client()
+with c.create("box", template="python-sandbox", ttl="1h") as sb:      # removed when the block ends
+    out = sb.run("pip install -q requests && python -c 'import requests; print(requests.__version__)'")
+    sb.write_file("/work/app.py", "print('hi')\n")
+    print(sb.exec("python /work/app.py").stdout)                      # ExecResult: exit_code, stdout, stderr
+    job = sb.exec("python -m http.server 8000", background=True)      # a Job
+    port = sb.publish(8000)                                           # http://127.0.0.1:{port} on the host
+    job.kill()
+
+snap = c.sandbox("prepared").snapshot("ready")
+forks = snap.fork("try", count=3)                                     # three running Sandbox objects
+```
+
+`Client()` finds the local fcvm service by itself. For another host, set
+`FCVM_URL` and `FCVM_TOKEN`. The token gives full control of fcvm, so treat
+it like an SSH key.
+
+- [All methods](https://github.com/carlosbravoa/fcvm/blob/main/sdk/README.md)
+- [The HTTP API](https://github.com/carlosbravoa/fcvm/blob/main/docs/api.md)
+- [Installing fcvm](https://github.com/carlosbravoa/fcvm/blob/main/docs/getting-started.md)
+
+Apache License 2.0.

fcvm-0.7.0/fcvm.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE
+NOTICE
+README.md
+fcvm.py
+pyproject.toml
+fcvm.egg-info/PKG-INFO
+fcvm.egg-info/SOURCES.txt
+fcvm.egg-info/dependency_links.txt
+fcvm.egg-info/top_level.txt

fcvm-0.7.0/fcvm.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fcvm-0.7.0/fcvm.egg-info/top_level.txt

@@ -0,0 +1 @@
+fcvm

fcvm-0.7.0/fcvm.py

@@ -0,0 +1,382 @@
+"""fcvm: a client for the fcvm HTTP API (fcvm serve, or the fcvm service).
+
+    from fcvm import Client
+
+    c = Client()                      # the local server: vms/.serve.json, or FCVM_URL + FCVM_TOKEN
+    with c.create("box", template="python-sandbox", ttl="1h") as sb:
+        r = sb.exec("pip install -q requests && python -c 'import requests; print(requests.__version__)'")
+        print(r.exit_code, r.stdout)
+        sb.write_file("/work/app.py", "print('hi')\\n")
+        job = sb.exec("python -m http.server 8000", background=True)
+        port = sb.publish(8000)       # http://127.0.0.1:PORT on the host
+    # the sandbox is removed when the block ends
+
+Everything maps onto the API documented in docs/api.md, which maps onto the
+CLI. Standard library only; Python 3.9+.
+"""
+import json
+import os
+import shutil
+import subprocess
+import time
+import urllib.error
+import urllib.parse
+import urllib.request
+
+__all__ = ["Client", "Sandbox", "Snapshot", "Job", "ServerJob", "ExecResult", "FcvmError"]
+__version__ = "0.7.0"
+
+
+class FcvmError(Exception):
+    """An error from the server: `status` is the HTTP status, the message fcvm's."""
+
+    def __init__(self, status, message):
+        super().__init__(message)
+        self.status = status
+
+
+class ExecResult:
+    def __init__(self, d):
+        self.exit_code = d.get("exit_code")
+        self.stdout = d.get("stdout", "")
+        self.stderr = d.get("stderr", "")
+        self.timed_out = bool(d.get("timed_out"))
+
+    @property
+    def ok(self):
+        return self.exit_code == 0
+
+    def check(self):
+        """self, or FcvmError when the command failed."""
+        if not self.ok:
+            raise FcvmError(0, f"command exited {self.exit_code}: {self.stderr.strip() or self.stdout.strip()}")
+        return self
+
+    def __repr__(self):
+        return f"ExecResult(exit_code={self.exit_code}, stdout={self.stdout!r}, stderr={self.stderr!r})"
+
+
+def discover():
+    """(url, token) of the local server, from the environment or vms/.serve.json."""
+    if os.environ.get("FCVM_URL") and os.environ.get("FCVM_TOKEN"):
+        return os.environ["FCVM_URL"].rstrip("/"), os.environ["FCVM_TOKEN"]
+    homes = [os.environ.get("FCVM_HOME"), os.path.join(os.environ.get("XDG_DATA_HOME") or os.path.expanduser("~/.local/share"), "fcvm")]
+    if shutil.which("fcvm"):        # an fcvm run from a checkout keeps its state in the checkout
+        try:
+            homes.append(subprocess.run(["fcvm", "_home"], capture_output=True, text=True, timeout=10).stdout.strip())
+        except (OSError, subprocess.SubprocessError):
+            pass
+    for home in filter(None, homes):
+        try:
+            with open(os.path.join(home, "vms", ".serve.json")) as f:
+                s = json.load(f)
+            return s["url"].split("/?")[0], s["token"]
+        except (OSError, ValueError, KeyError):
+            continue
+    raise FcvmError(0, "no fcvm server found: run `fcvm serve` (or `fcvm service install`), or set FCVM_URL and FCVM_TOKEN")
+
+
+class Client:
+    def __init__(self, url=None, token=None, timeout=600):
+        if not (url and token):
+            url, token = discover()
+        self.url, self.token, self.timeout = url.rstrip("/"), token, timeout
+
+    # --- plumbing ---------------------------------------------------------------------
+    def request(self, method, path, body=None, params=None, data=None, raw=False):
+        url = f"{self.url}/api/{path.lstrip('/')}"
+        if params:
+            url += "?" + urllib.parse.urlencode({k: v for k, v in params.items() if v is not None})
+        headers = {"Authorization": f"Bearer {self.token}"}
+        payload = data
+        if body is not None:
+            payload, headers["Content-Type"] = json.dumps(body).encode(), "application/json"
+        req = urllib.request.Request(url, data=payload, method=method, headers=headers)
+        try:
+            with urllib.request.urlopen(req, timeout=self.timeout) as r:
+                content = r.read()
+        except urllib.error.HTTPError as e:
+            try:
+                message = json.loads(e.read().decode())["error"]
+            except (ValueError, KeyError):
+                message = f"HTTP {e.code}"
+            raise FcvmError(e.code, message) from None
+        except urllib.error.URLError as e:
+            raise FcvmError(0, f"cannot reach {self.url}: {e.reason}") from None
+        if raw:
+            return content
+        return json.loads(content) if content else None
+
+    def get(self, path, /, **params):            # positional-only: a query parameter may be named path
+        return self.request("GET", path, params=params or None)
+
+    def post(self, path, /, body=None):
+        return self.request("POST", path, body=body or {})
+
+    def delete(self, path, /, **params):
+        return self.request("DELETE", path, params=params or None)
+
+    # --- the host -------------------------------------------------------------------------
+    def host(self):
+        return self.get("host")
+
+    def vms(self):
+        return [Sandbox(self, v["name"], v) for v in self.get("vms")]
+
+    def sandbox(self, name):
+        """An existing VM by name (checked)."""
+        return Sandbox(self, name, self.get(f"vms/{name}"))
+
+    def images(self):
+        return self.get("images")
+
+    def templates(self):
+        return self.get("templates")
+
+    def snapshots(self):
+        return [Snapshot(self, s["name"], s) for s in self.get("snapshots")]
+
+    def volumes(self):
+        return self.get("volumes")
+
+    def pools(self):
+        return self.get("pools")
+
+    def import_image(self, ref, name=None):
+        """Start an import; returns a ServerJob to wait on."""
+        return ServerJob(self, self.post("images", {"ref": ref, **({"name": name} if name else {})}))
+
+    def create(self, name, image=None, template=None, start=True, **opts):
+        """Create (and start) a VM. opts are the fields of POST /vms: vcpus, mem_mib,
+        network ("full"|"none"|"restricted"), allow, ports, volumes, idle, command,
+        jail, restart, ttl, idle_stop, secrets ({NAME: value}), forward, cache, disk,
+        copy, entrypoint. With a template, its fields come first and opts override."""
+        body = {}
+        if template:
+            t = next((t for t in self.templates() if t["name"] == template), None)
+            if not t:
+                raise FcvmError(404, f"no template '{template}'")
+            body = {k: v for k, v in t.items() if k not in ("name", "builtin", "description", "process", "command", "secrets")}
+            if t["process"] == "idle":
+                body["idle"] = True
+            elif t["process"] == "command":
+                body["command"] = " ".join(_shell_quote(a) for a in t["command"])
+            secrets = {n: os.environ[n] for n in t.get("secrets", []) if n in os.environ}
+            if secrets:
+                body["secrets"] = secrets
+        if image:
+            body["image"] = image
+        if "image" not in body:
+            raise FcvmError(400, "give an image or a template")
+        if "command" in opts and isinstance(opts["command"], (list, tuple)):
+            opts["command"] = " ".join(_shell_quote(a) for a in opts["command"])
+        body.update({k: v for k, v in opts.items() if v is not None})
+        body.update({"name": name, "start": start})
+        return Sandbox(self, name, self.post("vms", body))
+
+    def claim(self, pool, ttl=None, idle_stop=None):
+        """A ready VM out of a warm pool."""
+        info = self.post(f"pools/{pool}/claim", {k: v for k, v in (("ttl", ttl), ("idle_stop", idle_stop)) if v})
+        return Sandbox(self, info["name"], info)
+
+
+def _shell_quote(a):
+    import re
+    return a if re.fullmatch(r"[\w@%+=:,./-]+", a) else "'" + a.replace("'", "'\\''") + "'"
+
+
+class Sandbox:
+    """A VM. Methods map onto the API's /vms/{name}/... endpoints."""
+
+    def __init__(self, client, name, info=None):
+        self.client, self.name, self._info = client, name, info
+
+    def __repr__(self):
+        return f"Sandbox({self.name!r})"
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *exc):
+        self.remove()
+
+    def info(self):
+        self._info = self.client.get(f"vms/{self.name}")
+        return self._info
+
+    @property
+    def state(self):
+        return self.info()["state"]
+
+    @property
+    def ip(self):
+        return self.info().get("ip")
+
+    # commands ----------------------------------------------------------------------------
+    def exec(self, command=None, argv=None, workdir=None, env=None, user=None, stdin=None, timeout=300, background=False):
+        """Run a shell command (or an exact argv). Returns an ExecResult, or a Job with background=True."""
+        body = {"command": command, "argv": argv, "workdir": workdir, "env": env, "user": user,
+                "stdin": stdin, "timeout": timeout, "background": background}
+        r = self.client.post(f"vms/{self.name}/exec", {k: v for k, v in body.items() if v is not None and v is not False})
+        return Job(self, r["job"]) if background else ExecResult(r)
+
+    def run(self, command, **kw):
+        """exec, raising when the command fails; returns its stdout."""
+        return self.exec(command, **kw).check().stdout
+
+    def jobs(self):
+        return [Job(self, j["id"], j) for j in self.client.get(f"vms/{self.name}/jobs")]
+
+    def job(self, job_id):
+        return Job(self, job_id)
+
+    # files -------------------------------------------------------------------------------
+    def read_file(self, path):
+        return self.client.request("GET", f"vms/{self.name}/file", params={"path": path}, raw=True)
+
+    def read_text(self, path, encoding="utf-8"):
+        return self.read_file(path).decode(encoding)
+
+    def write_file(self, path, data, mode=None):
+        if isinstance(data, str):
+            data = data.encode()
+        return self.client.request("PUT", f"vms/{self.name}/file", params={"path": path, "mode": mode}, data=data)
+
+    def ls(self, path="/"):
+        return self.client.get(f"vms/{self.name}/files", path=path)["entries"]
+
+    def mkdir(self, path):
+        return self.client.post(f"vms/{self.name}/files", {"op": "mkdir", "path": path})
+
+    def remove_path(self, path):
+        return self.client.post(f"vms/{self.name}/files", {"op": "remove", "path": path})
+
+    def rename(self, path, to):
+        return self.client.post(f"vms/{self.name}/files", {"op": "rename", "path": path, "to": to})
+
+    def mount(self, host, path=None, ro=False):
+        return self.client.post(f"vms/{self.name}/mounts", {"host": host, "path": path or "", "ro": ro})
+
+    def umount(self, path):
+        return self.client.delete(f"vms/{self.name}/mounts", path=path)
+
+    # ports -------------------------------------------------------------------------------
+    def publish(self, guest_port, host_port=None, bind=None):
+        """Publish a port; returns the host port (a free one unless given)."""
+        spec = f"{bind + ':' if bind else ''}{host_port or ''}:{int(guest_port)}"
+        info = self.client.post(f"vms/{self.name}/ports", {"port": spec})
+        return int(info["ports"][-1].split(":")[-2])
+
+    def unpublish(self, host_port):
+        return self.client.delete(f"vms/{self.name}/ports", port=str(host_port))
+
+    # lifecycle ---------------------------------------------------------------------------
+    def start(self):
+        return self.client.post(f"vms/{self.name}/start")
+
+    def stop(self):
+        return self.client.post(f"vms/{self.name}/stop")
+
+    def restart(self):
+        return self.client.post(f"vms/{self.name}/restart")
+
+    def remove(self):
+        return self.client.delete(f"vms/{self.name}")
+
+    def update(self, **fields):
+        """restart, ttl, idle_stop (None clears), secrets ({NAME: value}), unset_secrets, forward."""
+        return self.client.post(f"vms/{self.name}/update", fields)
+
+    def snapshot(self, name):
+        self.client.post(f"vms/{self.name}/snapshot", {"name": name})
+        return Snapshot(self.client, name)
+
+    def commit(self, image):
+        self.client.post(f"vms/{self.name}/commit", {"image": image})
+        return image
+
+    def logs(self):
+        return self.client.get(f"vms/{self.name}/logs")["log"]
+
+    def egress(self):
+        return self.client.get(f"vms/{self.name}/egress")["text"]
+
+    def balloon(self, mib=None):
+        if mib is None:
+            return self.client.get(f"vms/{self.name}/balloon")
+        return self.client.post(f"vms/{self.name}/balloon", {"mib": int(mib)})
+
+    def processes(self):
+        return self.client.get(f"vms/{self.name}/processes")
+
+    def stats(self, range="10m"):
+        return self.client.get(f"vms/{self.name}/stats", range=range)
+
+
+class Job:
+    """A background command (exec with background=True)."""
+
+    def __init__(self, sandbox, job_id, info=None):
+        self.sandbox, self.id, self._info = sandbox, job_id, info
+
+    def __repr__(self):
+        return f"Job({self.id!r} in {self.sandbox.name!r})"
+
+    def status(self, tail=200):
+        """{id, command, started, status: running|exited|lost, exit_code, stdout, stderr}."""
+        self._info = self.sandbox.client.get(f"vms/{self.sandbox.name}/jobs/{self.id}", tail=tail)
+        return self._info
+
+    def kill(self):
+        return self.sandbox.client.delete(f"vms/{self.sandbox.name}/jobs/{self.id}")
+
+    def wait(self, timeout=None, poll=1.0, tail=200):
+        """The job's final status (polling); TimeoutError after `timeout` seconds."""
+        deadline = time.monotonic() + timeout if timeout else None
+        while True:
+            s = self.status(tail)
+            if s["status"] != "running":
+                return s
+            if deadline and time.monotonic() > deadline:
+                raise TimeoutError(f"job {self.id} still running after {timeout} s")
+            time.sleep(poll)
+
+
+class ServerJob:
+    """A server-side job (an image import or a build)."""
+
+    def __init__(self, client, info):
+        self.client, self.id, self._info = client, info["id"], info
+
+    def status(self):
+        self._info = self.client.get(f"jobs/{self.id}")
+        return self._info
+
+    def wait(self, timeout=None, poll=1.0):
+        deadline = time.monotonic() + timeout if timeout else None
+        while True:
+            s = self.status()
+            if s["status"] != "running":
+                if s["status"] == "failed":
+                    raise FcvmError(0, f"job {s.get('title', self.id)} failed: " + "\n".join(s.get("lines", [])[-5:]))
+                return s
+            if deadline and time.monotonic() > deadline:
+                raise TimeoutError(f"job {self.id} still running after {timeout} s")
+            time.sleep(poll)
+
+
+class Snapshot:
+    def __init__(self, client, name, info=None):
+        self.client, self.name, self._info = client, name, info
+
+    def __repr__(self):
+        return f"Snapshot({self.name!r})"
+
+    def fork(self, name=None, count=1):
+        """Running VMs from this snapshot; returns them (name, or name-1..name-N)."""
+        before = {v["name"] for v in self.client.get("vms")}
+        self.client.post(f"snapshots/{self.name}/fork", {"count": count, **({"name": name} if name else {})})
+        return [Sandbox(self.client, v["name"], v) for v in self.client.get("vms") if v["name"] not in before]
+
+    def remove(self):
+        return self.client.delete(f"snapshots/{self.name}")

fcvm-0.7.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fcvm"
+version = "0.7.0"
+description = "A client for the fcvm HTTP API: Firecracker microVM sandboxes from Python"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{name = "Carlos Bravo"}]
+requires-python = ">=3.9"
+keywords = ["firecracker", "microvm", "sandbox", "ai-agents", "virtualization", "isolation"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Security",
+    "Topic :: Software Development :: Testing",
+    "Topic :: System :: Emulators",
+]
+
+[project.urls]
+Homepage = "https://github.com/carlosbravoa/fcvm"
+Documentation = "https://github.com/carlosbravoa/fcvm/blob/main/sdk/README.md"
+Issues = "https://github.com/carlosbravoa/fcvm/issues"
+Changelog = "https://github.com/carlosbravoa/fcvm/blob/main/CHANGELOG.md"
+
+[tool.setuptools]
+py-modules = ["fcvm"]

fcvm-0.7.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+