Metadata-Version: 2.4
Name: codecraftai-restclient-runpod
Version: 1.2.0
Summary: Code Craft AI - RunPod REST client
License-Expression: LicenseRef-CodeCraftAI-Source-Available
License-File: LICENSE.md
Keywords: python,automation,ccai,restclient,runpod
Author: Myron Walker
Author-email: myron.walker@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX
Requires-Dist: codecraftai-credentials (<2.0.0)
Requires-Dist: codecraftai-foundations (<2.0.0)
Requires-Dist: codecraftai-restclient-base (<2.0.0)
Requires-Dist: requests (>=2.32.4,<3.0.0)
Project-URL: Issues, https://github.com/code-craft-ai-company/codecraftai-restclient-runpod/issues
Project-URL: Repository, https://github.com/code-craft-ai-company/codecraftai-restclient-runpod
Description-Content-Type: text/x-rst

=========================================
Code Craft AI Rest Client - RunPod
=========================================

The ``codecraftai-restclient-runpod`` package is the venue-specific REST client for RunPod, a
GPU cloud whose primary unit of provisioning is the container *pod* rather than the VM.
The provider exposes secure-cloud and community-cloud capacity tiers, pod templates,
GPU-type and region catalogs, persistent network volumes, and a small lifecycle surface
for pods. The container-first shape makes RunPod a natural ``WorkloadVenue`` rather than a
``CloudVenue`` in the neutral provisioning model.

Highlights
==========

- ``RunpodClient`` — a ``RestClientBase`` subclass covering authentication, GPU-type and pod-template enumeration, and region catalogs.
- Network-volume lifecycle — create, inspect, and delete persistent network volumes.
- Pod lifecycle — launch, inspect, stop, start, and terminate container pods across secure-cloud and community-cloud tiers.
- Scope boundary — multi-node training shapes are out of scope at the client level; the provisioner composes per-pod calls to express them.
- Aspects-driven transport — every behaviour-bearing call accepts ``aspects: AspectsRest = DEFAULT_RUNPOD_ASPECTS``; credentials enter as typed ``RunpodApiKeyCredential`` instances from ``codecraftai-credentials``.

Repository Structure
====================

- ``development/`` - Runtime environment scripts.
- ``repository-setup/`` - Repository homing and setup scripts.
- ``source/packages/ccai/restclient/runpod/`` - Package source code.
- ``source/testroots/testbase/ccai/tests/restclient/runpod/`` - TestBase test roots.
- ``specs/`` - Requirements, design, and task documentation (Kiro-style).
- ``userguide/`` - Standards, conventions, and documentation.

Environment Setup
=================

When working in a Codex container:

.. code-block:: bash

   ./development/setup-agent-container

For local development:

.. code-block:: bash

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

Running Tests
=============

.. code-block:: bash

   source .venv/bin/activate
   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``

