CodeFlare SDK
An intuitive, easy-to-use python interface for batch resource requesting, access, job submission, and observation. Simplifying the developer's life while enabling access to high-performance compute resources, either in the cloud or on-prem.
For guided demos and basics walkthroughs, check out the following links:
- Guided demo notebooks available here, and copies of the notebooks with expected output also available
- these demos can be copied into your current working directory when using the
codeflare-sdkby using thecodeflare_sdk.copy_demo_nbs()function - Additionally, we have a video walkthrough of these basic demos from June, 2023
Full documentation can be found here
Admin guide for heterogeneous Ray clusters under Kueue (multiple worker groups,
ResourceFlavor / ClusterQueue prerequisites):
docs/sphinx/user-docs/kueue-heterogeneous-ray-clusters.rst
(also in the published docs toctree after the next documentation release).
Installation
Can be installed via pip: pip install codeflare-sdk
Authentication
CodeFlare SDK uses kube-authkit for Kubernetes authentication, supporting multiple authentication methods:
- Auto-Detection - Automatically detects kubeconfig or in-cluster authentication
- Token-Based - Authenticate with API server token
- OIDC - OpenID Connect authentication with device flow or client credentials
- OpenShift OAuth - Native OpenShift OAuth support
- Kubeconfig - Traditional kubeconfig file authentication
- In-Cluster - Service account authentication when running in a pod
Quick Start
Codeflare is the single entrypoint. It authenticates and owns the resulting
Kubernetes client, so clusters and jobs created from it keep using that client.
from kube_authkit import AuthConfig
from codeflare_sdk import ClusterConfiguration, Codeflare, SDKConfig
# Option 1: Auto-detect authentication (kubeconfig or in-cluster service account)
cf = Codeflare(config=SDKConfig(namespace='my-project'))
# Option 2: OIDC authentication
cf = Codeflare(config=SDKConfig(
auth=AuthConfig(
method="oidc",
oidc_issuer="https://your-oidc-provider.com",
client_id="your-client-id",
use_device_flow=True,
),
namespace='my-project',
))
# Option 3: OpenShift OAuth with token
cf = Codeflare(config=SDKConfig(
auth=AuthConfig(
method="openshift",
k8s_api_host="https://api.example.com:6443",
token="your-token",
),
namespace='my-project',
))
# Now create your cluster. Every SDK entrypoint that takes a cluster
# description takes the same ClusterConfiguration object.
cluster = cf.clusters.create(ClusterConfiguration(name='my-cluster', num_workers=2))
cluster.apply()
Development
Please see our CONTRIBUTING.md for detailed instructions.
Release Instructions
Automated Releases
It is possible to use the Release Github workflow to do the release. This is generally the process we follow for releases
Manual Releases
The following instructions apply when doing release manually. This may be required in instances where the automation is failing.
- Check and update the version in "pyproject.toml" file.
- Commit all the changes to the repository.
- Create Github release (https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release).
- Build the Python package.
poetry build - If not present already, add the API token to Poetry.
poetry config pypi-token.pypi API_TOKEN - Publish the Python package.
poetry publish - Trigger the Publish Documentation workflow
10 maintainers
Metadata
10 maintainers
Release files for codeflare-sdk 0.40.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| codeflare_sdk-0.40.1.tar.gz | 226.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| codeflare_sdk-0.40.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 536.8 kB
Release files / codeflare_sdk-0.40.1.tar.gz
| Download URL | codeflare_sdk-0.40.1.tar.gz |
|---|---|
| Size | 226.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b81a1f347cd92295052c45576c08656b1acd9001391b28468e324b1a6539174d
|
|
BLAKE2b-256 checksum How to use checksums |
caeaff8301e87c02dbc3b7af6091d1e873498dd072d9cb65c9a3bcfaa4580a8e
|
| 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 12, 2026.
Transparency logRelease files / codeflare_sdk-0.40.1-py3-none-any.whl
| Download URL | codeflare_sdk-0.40.1-py3-none-any.whl |
|---|---|
| Size | 309.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5c01a673493a61000ce0459caede56479d22c5e884b101186ffade14940d8798
|
|
BLAKE2b-256 checksum How to use checksums |
ff70b5aadd1d0c42abfa9666b87ec73274572fe60b07c1ca94a2f9bff3b85126
|
| 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 12, 2026.
Transparency log
