> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/RedHatQE/openshift-python-wrapper/llms.txt > Use this file to discover all available pages before exploring further. # Introduction > A powerful Python wrapper for Kubernetes and OpenShift with first-class support for Container Virtualization

OpenShift Python Wrapper

A Python wrapper for the Kubernetes client with support for OpenShift and Container Virtualization. Standardize resource operations with a simple, intuitive interface.

Get Started API Reference 
              
                {`from ocp_resources.pod import Pod

                                # Create a pod with context manager
                                with Pod(
                                  name="my-pod",
                                  namespace="default",
                                  containers=[{
                                      "name": "nginx",
                                      "image": "nginx:latest"
                                  }]
                                ) as pod:
                                  pod.wait_for_status(
                                      status="Running",
                                      timeout=300
                                  )
                                  # Pod automatically cleaned up`}

Quick Start

Get up and running with OpenShift Python Wrapper in minutes

Install using pip or uv: ```bash pip theme={null} pip install openshift-python-wrapper ``` ```bash uv theme={null} uv pip install openshift-python-wrapper ``` Ensure you have a valid kubeconfig file with access to your cluster: ```bash theme={null} export KUBECONFIG=~/.kube/config kubectl cluster-info ``` The wrapper uses your existing Kubernetes configuration automatically. Create a Pod using the wrapper's intuitive interface: ```python theme={null} from ocp_resources.pod import Pod pod = Pod( name="nginx-pod", namespace="default", containers=[{ "name": "nginx", "image": "nginx:latest" }] ) pod.deploy() pod.wait_for_status(status="Running") print(f"Pod {pod.name} is running!") ``` ``` Pod nginx-pod is running! ``` The wrapper provides simplified access to pod operations: ```python theme={null} # Execute a command inside the pod result = pod.execute(command=["nginx", "-v"]) print(result) # Get logs logs = pod.log() print(logs) ```

Key Features

Everything you need to work with Kubernetes and OpenShift resources

Standardized Create, Read, Update, and Delete operations for all resource types Automatic resource lifecycle management with Python context managers First-class support for KubeVirt and Container Virtualization resources Execute commands, stream logs, and interact with containers easily Auto-generate wrapper classes for any Kubernetes resource Test your code without a real cluster using the fake Kubernetes client

Explore by Topic

Deep dive into specific areas of the wrapper

📦

Core Concepts

Understand resources, namespaces, and client configuration

Learn more
🐳

Working with Pods

Execute commands, stream logs, and manage container lifecycles

Learn more
💻

Virtual Machines

Manage KubeVirt virtual machines and OpenShift Virtualization

Learn more
⚙️

Class Generator

Auto-generate Python wrappers for any Kubernetes custom resource

Learn more

Ready to get started?

Install the package and create your first resource in minutes

View Quickstart Guide