Skip to content

Commit ca7a2b7

Browse files
committed
Rename to kube-authkit
Signed-off-by: Saad Zaher <szaher@redhat.com>
1 parent dd2bee6 commit ca7a2b7

28 files changed

+1370
-192
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OpenShift AI Authentication Library
1+
# Kube AuthKit - Kubernetes Authentication Toolkit
22

33
A lightweight Python library that provides unified authentication for OpenShift and Kubernetes clusters. This library simplifies authentication by supporting multiple methods through a single, consistent interface.
44

@@ -30,13 +30,13 @@ A lightweight Python library that provides unified authentication for OpenShift
3030
## Installation
3131

3232
```bash
33-
pip install openshift-ai-auth
33+
pip install kube-authkit
3434
```
3535

3636
For optional keyring support (persistent token storage):
3737

3838
```bash
39-
pip install openshift-ai-auth[keyring]
39+
pip install kube-authkit[keyring]
4040
```
4141

4242
## Quick Start
@@ -46,7 +46,7 @@ pip install openshift-ai-auth[keyring]
4646
The library automatically detects your environment and chooses the appropriate authentication method:
4747

4848
```python
49-
from openshift_ai_auth import get_k8s_client
49+
from kube_authkit import get_k8s_client
5050
from kubernetes import client
5151

5252
# Auto-detect environment and authenticate
@@ -68,7 +68,7 @@ This works seamlessly whether you're running:
6868
For CLI tools or when you need explicit control:
6969

7070
```python
71-
from openshift_ai_auth import get_k8s_client, AuthConfig
71+
from kube_authkit import get_k8s_client, AuthConfig
7272

7373
config = AuthConfig(
7474
method="oidc",
@@ -86,7 +86,7 @@ api_client = get_k8s_client(config)
8686
For notebooks or interactive applications:
8787

8888
```python
89-
from openshift_ai_auth import get_k8s_client, AuthConfig
89+
from kube_authkit import get_k8s_client, AuthConfig
9090

9191
config = AuthConfig(
9292
method="oidc",
@@ -104,7 +104,7 @@ api_client = get_k8s_client(config)
104104
Store refresh tokens securely in your system keyring:
105105

106106
```python
107-
from openshift_ai_auth import get_k8s_client, AuthConfig
107+
from kube_authkit import get_k8s_client, AuthConfig
108108

109109
config = AuthConfig(
110110
method="oidc",
@@ -173,8 +173,8 @@ Each strategy implements the same interface, making it easy to add new authentic
173173

174174
```bash
175175
# Clone repository
176-
git clone https://github.com/openshift/openshift-ai-auth.git
177-
cd openshift-ai-auth
176+
git clone https://github.com/openshift/kube-authkit.git
177+
cd kube-authkit
178178

179179
# Create virtual environment
180180
python -m venv venv
@@ -197,7 +197,7 @@ pytest tests/test_config.py
197197
pytest -v
198198

199199
# Type checking
200-
mypy src/openshift_ai_auth
200+
mypy src/kube_authkit
201201

202202
# Code formatting
203203
black src/ tests/
@@ -228,8 +228,8 @@ Apache License 2.0 - see [LICENSE](LICENSE) for details.
228228

229229
## Support
230230

231-
- Issues: https://github.com/openshift/openshift-ai-auth/issues
232-
- Documentation: https://github.com/openshift/openshift-ai-auth#readme
231+
- Issues: https://github.com/openshift/kube-authkit/issues
232+
- Documentation: https://github.com/openshift/kube-authkit#readme
233233

234234
## Acknowledgments
235235

pyproject.toml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ requires = ["hatchling"]
33
build-backend = "hatchling.build"
44

55
[project]
6-
name = "openshift-ai-auth"
6+
name = "kube-authkit"
77
version = "0.1.0"
8-
description = "Thin authentication layer for OpenShift AI - unified KubeConfig, In-Cluster, OIDC, and OpenShift OAuth authentication"
8+
description = "Unified Kubernetes authentication toolkit - supports KubeConfig, In-Cluster, OIDC, and OpenShift OAuth authentication"
99
readme = "README.md"
1010
license = {text = "Apache-2.0"}
1111
requires-python = ">=3.10"
1212
authors = [
13-
{name = "OpenShift AI Team"}
13+
{name = "Kube AuthKit Contributors"}
1414
]
15-
keywords = ["openshift", "kubernetes", "authentication", "oidc", "oauth", "k8s"]
15+
keywords = ["kubernetes", "authentication", "oidc", "oauth", "k8s", "kubeconfig", "openshift"]
1616
classifiers = [
1717
"Development Status :: 3 - Alpha",
1818
"Intended Audience :: Developers",
@@ -44,21 +44,21 @@ dev = [
4444
]
4545

4646
[project.urls]
47-
Homepage = "https://github.com/openshift/openshift-ai-auth"
48-
Documentation = "https://github.com/openshift/openshift-ai-auth#readme"
49-
Repository = "https://github.com/openshift/openshift-ai-auth"
50-
Issues = "https://github.com/openshift/openshift-ai-auth/issues"
47+
Homepage = "https://github.com/kube-authkit/kube-authkit"
48+
Documentation = "https://github.com/kube-authkit/kube-authkit#readme"
49+
Repository = "https://github.com/kube-authkit/kube-authkit"
50+
Issues = "https://github.com/kube-authkit/kube-authkit/issues"
5151

5252
[tool.hatch.build.targets.wheel]
53-
packages = ["src/openshift_ai_auth"]
53+
packages = ["src/kube_authkit"]
5454

5555
[tool.pytest.ini_options]
5656
testpaths = ["tests"]
5757
python_files = ["test_*.py"]
5858
python_classes = ["Test*"]
5959
python_functions = ["test_*"]
6060
addopts = [
61-
"--cov=openshift_ai_auth",
61+
"--cov=kube_authkit",
6262
"--cov-report=term-missing",
6363
"--cov-report=html",
6464
"--cov-fail-under=70",
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
"""
2-
OpenShift AI Authentication Library.
2+
Kube AuthKit - Unified Kubernetes Authentication Toolkit.
33
4-
A lightweight Python library for unified authentication to OpenShift and
5-
Kubernetes clusters. Supports multiple authentication methods through a
4+
A lightweight Python library for unified authentication to Kubernetes and
5+
OpenShift clusters. Supports multiple authentication methods through a
66
single, consistent interface.
77
88
Quick Start:
9-
>>> from openshift_ai_auth import get_k8s_client
9+
>>> from kube_authkit import get_k8s_client
1010
>>> from kubernetes import client
1111
>>>
1212
>>> # Auto-detect and authenticate
@@ -15,7 +15,7 @@
1515
>>> pods = v1.list_pod_for_all_namespaces()
1616
1717
For more control:
18-
>>> from openshift_ai_auth import get_k8s_client, AuthConfig
18+
>>> from kube_authkit import get_k8s_client, AuthConfig
1919
>>>
2020
>>> config = AuthConfig(
2121
... method="oidc",
@@ -62,6 +62,6 @@
6262
# Configure logging
6363
# Users can configure the logger in their own code:
6464
# import logging
65-
# logging.getLogger("openshift_ai_auth").setLevel(logging.DEBUG)
65+
# logging.getLogger("kube_authkit").setLevel(logging.DEBUG)
6666
logger = logging.getLogger(__name__)
6767
logger.addHandler(logging.NullHandler()) # Avoid "No handler" warnings
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)