Skip to main content

Code Craft AI Interop - vSphere

The codecraftai-restclient-vsphere package is a typed, aspect-driven REST client for the VMware vCenter API. It implements the IVPNControlPlane-adjacent virtualization surface as a sibling to other vendor packages in the ccai suite, built on top of codecraftai-restclient-base. The client replaces the legacy VSphereAgent from codecraftai-landscaping/services/vmware/ — a 606-line agent class plus 29 extension modules — with a RestClientBase-derived VSphereClient and 29 RestApiGroup subclasses.

This package is hand-authored against the documented vCenter REST surface and does not use OpenAPI code generation. The reasoning is recorded in the AGENTS.md “Codegen Decision” section and in the workspace-level PLAN-VPN-AND-CLOUD-PROVISIONING.md §9.2a.

Highlights

  • VSphereClient — the RestClientBase subclass that handles session-token mint, dual /api and /rest URL composition, and the 29 lazy-cached api-group properties.

  • VSphereTaskHandle — implements ITaskHandle from codecraftai-foundations; sync-polling with aspects-controlled interval and timeout, injectable clock/sleeper/fetcher for test determinism.

  • 29 apigroups/*Group classes covering certificate management, clusters, compute, content library, crypto manager, datacenter, datastore, deployment, folder, guest, host, hvc, identity, inventory, iso, lcm, namespace management, networks, OVF, resource pool, services, storage, system config, tagging, token service, topology, trusted infrastructure, and VMs.

  • Content Library deploy (ContentGroup.deploy_ovf_item), OVF deploy from URL or local file (OvfGroup.deploy_from_url / deploy_from_local_ovf), and guest customization (Linux cloud-init + Windows sysprep renderers).

  • VM lifecycle waiters: wait_for_power_state, wait_for_tools_ready, wait_for_ip_address.

  • Inventory helpers: find_vm_by_name, find_vm_by_tag, find_datastore_with_free_gb, pick_least_loaded_host — with total tie-breaking ordering and hypothesis property-tested selection determinism.

  • Events stream (EventsGroup.stream with backpressure + dropped-event counting) and linked-mode helpers (linked_vcenters, for_vcenter).

Repository Structure

  • development/ - Runtime environment scripts.

  • repository-setup/ - Repository homing and setup scripts.

  • source/packages/ccai/restclient/vsphere/ - Package source code.

  • source/testroots/testbase/ccai/tests/restclient/vsphere/ - TestBase test roots.

  • specs/ - Requirements, design, and task documentation (Kiro-style).

  • userguide/ - Standards, conventions, and documentation.

Environment Setup

When working in a Codex container:

./development/setup-agent-container

For local development:

./repository-setup/rehome-repository
./development/setup-environment

Running Tests

Activate the virtual environment:

source .venv/bin/activate

Run the test suite:

testbase testing run --root ./source/testroots/testbase --includes=testbase.ccai.tests

Standards and Conventions

  • Naming conventions: userguide/10-02-naming-conventions.rst

  • Code organization: userguide/10-01-code-organization.rst

  • Coding standards: userguide/10-00-coding-standards.rst

Additional Resources

  • User guide entry point: userguide/userguide.rst

  • Codegen decision: AGENTS.md (Codegen Decision section)

Metadata

Release files for codecraftai-restclient-vsphere 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for codecraftai-restclient-vsphere 1.2.1
File Size Uploaded Provenance
codecraftai_restclient_vsphere-1.2.1.tar.gz 52.6 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for codecraftai-restclient-vsphere 1.2.1
File Interpreter ABI Platform
codecraftai_restclient_vsphere-1.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 146.0 kB

Release files / codecraftai_restclient_vsphere-1.2.1.tar.gz

Download URL codecraftai_restclient_vsphere-1.2.1.tar.gz
Size 52.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d7a2e914cfddcb7bb45866f1b0294b448c54e37e48c1e65556135077bb7460c8
BLAKE2b-256 checksum
How to use checksums
936d5aeeeb5deccaa7e7a89da43159e162568a17b817976843cc19ab60ff1c0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / codecraftai_restclient_vsphere-1.2.1-py3-none-any.whl

Download URL codecraftai_restclient_vsphere-1.2.1-py3-none-any.whl
Size 93.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a462d88234e85ce156e7618e08aca20a03ea67f9415be21c4e28c3c4579c3b76
BLAKE2b-256 checksum
How to use checksums
9548a20f2d3b632921efca6ccf174f30b09137a54d6feb0975ec9ad77649c70e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for codecraftai-restclient-vsphere 1.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for codecraftai_restclient_vsphere-1.2.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.2.1 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page