---
id: openshift
version: "0.13.2"
license: Apache License Version 2.0
license_treatment: permissive
maintenance: abandoned
---

# openshift — OpenShift python client

License: permissive · Maintenance: abandoned · Downloads: 528.5K/mo

## What it is and what it does

The openshift package is a Python client for the Kubernetes and OpenShift REST APIs. It wraps the kubernetes client and provides a dynamic resource model that lets you interact with any Kubernetes or OpenShift resource—built-in types like Services and Routes, as well as custom resources defined via Custom Resource Definitions—without needing resource-specific generated code. The library depends on kubernetes, python-string-utils, and six.

You instantiate a DynamicClient from a Kubernetes API client, then call `resources.get()` to retrieve a resource type by API version and kind, and use standard methods like `get()`, `create()`, `delete()`, `patch()`, `replace()`, and `watch()` to interact with instances. The package includes helper utilities for authentication, such as username/password login to OpenShift clusters. Because the project is abandoned and has not been updated since 2023-07-25, compatibility with recent Kubernetes or OpenShift releases is uncertain.

Use it for:

- Automate OpenShift cluster operations—create, list, and delete projects, services, and routes programmatically
- Manage custom resources and Custom Resource Definitions in Kubernetes clusters without writing resource-specific client code
- Build Python-based deployment or orchestration tools that work with multiple Kubernetes API versions and custom resource types
- Authenticate to OpenShift clusters using username and password credentials and retrieve API tokens
- Write integration tests or monitoring scripts that query and manipulate Kubernetes resources generically

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Python client library for interacting with Kubernetes and OpenShift APIs using a dynamic resource model that works with built-in and custom resources.

Yes, but with caution. The package is suitable for existing OpenShift/Kubernetes Python automation projects and provides a clean dynamic API that avoids code generation. However, the project is abandoned—no updates since 2023-07-25—so verify compatibility with your target Kubernetes and OpenShift versions before adopting it in new projects. For actively maintained alternatives, check the kubernetes client directly or newer OpenShift-specific libraries.

## Install

pip install openshift
uv add openshift
poetry add openshift

## Installing openshift

Before you install: Low install friction with three runtime dependencies. However, maintenance status is abandoned—the last release was 2023-07-25, and the repository shows no recent activity despite being unarchived. New projects should verify compatibility with current Kubernetes and OpenShift versions.

License in practice: Licensed under Apache License Version 2.0, a permissive open-source license. You may use, modify, and distribute this package freely in commercial and private projects, provided you include a copy of the license and state significant changes.

Quickstart:

pip install openshift

from kubernetes import client, config
from openshift.dynamic import DynamicClient

k8s_client = config.new_client_from_config()
dyn_client = DynamicClient(k8s_client)
v1_services = dyn_client.resources.get(api_version='v1', kind='Service')
service_list = v1_services.get(namespace='default')

Requires a valid Kubernetes configuration file (typically ~/.kube/config) or explicit cluster credentials to authenticate and connect to a Kubernetes or OpenShift cluster.

Verify before relying:

- Compatibility with current Kubernetes and OpenShift API versions beyond 2023-07-25
- Whether the dynamic client approach fully replaces the deprecated swagger-generated models
- Support status for Python versions beyond 3.5 given the Alpha development status classifier

## Package facts

- License: Apache License Version 2.0 (permissive)
- Python support: unspecified
- Install friction: low
- Maintenance: abandoned
- Downloads: 528.5K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

openshift python client, kubernetes api python, dynamic kubernetes client, openshift rest client, custom resource definitions python, kubernetes resource management, openshift cluster automation, kubernetes, openshift, container-orchestration

[View on SkillFed](https://skillfed.io/packages/openshift) · [View on PyPI](https://pypi.org/project/openshift/)