openshift-python-wrapper 11.0.143__tar.gz → 11.0.145__tar.gz

{openshift_python_wrapper-11.0.143 → openshift_python_wrapper-11.0.145}/.coderabbit.yaml

@@ -15,7 +15,14 @@ reviews:
   sequence_diagrams: false
   changed_files_summary: true
   labeling_instructions: []
-  path_filters: ["!class_generator/schema/**"]
+  path_filters:
+    - "!class_generator/schema/**"
+    # generated by pi-docsite - the .md sources and nav.json stay in review scope
+    - "!docs/*.html"
+    - "!docs/search-index.json"
+    - "!docs/llms.txt"
+    - "!docs/llms-full.txt"
+    - "!docs/assets/**"
   path_instructions:
     - path: "**/ocp_resources/**"
       instructions: |

{openshift_python_wrapper-11.0.143 → openshift_python_wrapper-11.0.145}/.pr_agent.toml

@@ -10,3 +10,13 @@ push_commands = ["/agentic_review"]
 [review_agent]
 comments_location_policy = "both"
 inline_comments_severity_threshold = 1
+
+[ignore]
+glob = [
+  "docs/*.html",
+  "docs/search-index.json",
+  "docs/llms.txt",
+  "docs/llms-full.txt",
+  "docs/assets/*.js",
+  "docs/assets/style.css",
+]

{openshift_python_wrapper-11.0.143 → openshift_python_wrapper-11.0.145}/.pre-commit-config.yaml

@@ -46,7 +46,7 @@ repos:
           ]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.16.10
+    rev: v0.17.2
     hooks:
       - id: ruff
       - id: ruff-format

{openshift_python_wrapper-11.0.143 → openshift_python_wrapper-11.0.145}/CONTRIBUTING.md

@@ -35,6 +35,37 @@ prek install
 
 - Add typing to new code; typing is enforced using [mypy](https://mypy-lang.org/)
 
+## Documentation
+
+The site under `docs/` is generated by [pi-docsite](https://github.com/myk-org/pi-config/tree/main/packages/pi-docsite).
+Edit the Markdown sources, never the generated files:
+
+- sources: `docs/*.md` and the sidebar order in `docs/nav.json`
+- generated (do not edit): `docs/*.html`, `docs/search-index.json`, `docs/llms.txt`, `docs/llms-full.txt`, `docs/assets/`
+
+Rebuild the site with one command:
+
+```bash
+uvx pi-docsite --docs-dir docs \
+  --project-name openshift-python-wrapper \
+  --repo-url https://github.com/RedHatQE/openshift-python-wrapper \
+  --tagline "Manage OpenShift and Kubernetes resources with clean, Pythonic code instead of raw API calls"
+```
+
+`--repo-url` is required in practice: pi-docsite otherwise derives it from the local
+`origin`, so building from a fork rewrites every repository link and produces a diff
+with no source changes. The tagline is the description shown in the sidebar and in
+each page's metadata.
+
+The output is deterministic: running it twice without source changes produces no diff.
+
+Adding a page: create `docs/<slug>.md` and add `<slug>` to `docs/nav.json`. A `.md`
+missing from `nav.json` is still built, placed under a fallback group, and reported.
+
+Deleting a page: remove the `.md` **and** its slug from `docs/nav.json`. A slug with no
+`.md` behind it is a build error, so the stale entry has to go first — the leftover
+`<slug>.html` is then removed by the rebuild.
+
 ## Adding a new module (resource)
 
 ##### Using generator script (REQUIRED)

{openshift_python_wrapper-11.0.143 → openshift_python_wrapper-11.0.145}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.5
 Name: openshift-python-wrapper
-Version: 11.0.143
+Version: 11.0.145
 Summary: Wrapper around https://github.com/kubernetes-client/python
 Project-URL: homepage, https://github.com/RedHatQE/openshift-python-wrapper
-Project-URL: documentation, https://openshift-python-wrapper.readthedocs.io/en/latest/
+Project-URL: documentation, https://redhatqe.github.io/openshift-python-wrapper/
 Project-URL: Download, https://pypi.org/project/openshift-python-wrapper/
 Project-URL: Bug Tracker, https://github.com/RedHatQE/openshift-python-wrapper/issues
 Author-email: Meni Yakove <myakove@gmail.com>, Ruth Netser <rnetser@gmail.com>
@@ -14,10 +14,11 @@ Keywords: Kubevirt,Openshift,Openshift Virtualization
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
+Requires-Dist: authlib>=1.9.0
 Requires-Dist: cloup>=3.0.5
 Requires-Dist: colorlog>=6.8.2
 Requires-Dist: deepdiff>=8.0.1
-Requires-Dist: fastmcp>=2.10.4
+Requires-Dist: fastmcp>=4.1.0
 Requires-Dist: jinja2>=3.1.4
 Requires-Dist: jsonschema>=4.20.0
 Requires-Dist: kubernetes<36,>=31.0.0
@@ -37,7 +38,7 @@ Description-Content-Type: text/markdown
 
 Pypi: [openshift-python-wrapper](https://pypi.org/project/openshift-python-wrapper)  
 A python wrapper for [kubernetes-python-client](https://github.com/kubernetes-client/python) with support for [RedHat Container Virtualization](https://www.openshift.com/learn/topics/virtualization)  
-Docs: [openshift-python-wrapper docs](https://openshift-python-wrapper.readthedocs.io/en/latest/)
+Docs: [openshift-python-wrapper docs](https://redhatqe.github.io/openshift-python-wrapper/)
 
 The wrapper offers a simple and intuitive interface for interacting with the API.  
 It standardizes how to work with cluster resources and offers unified resource CRUD (Create, Read, Update, and Delete) flows.  
@@ -46,9 +47,8 @@ The wrapper makes code easier to read and maintain over time.
 
 One example of simplified usage is interacting with a container.  
 Running a command inside a container requires using Kubernetes stream, handling errors, and more.  
-The wrapper handles it all and provides simple and intuitive functionality.
-
-![Alt Text](examples/pod_example.gif)
+The wrapper handles it all and provides simple and intuitive functionality — see
+[Executing Commands in Pods and Retrieving Logs](https://redhatqe.github.io/openshift-python-wrapper/pod-execution-and-logs.html).
 
 Both developers or testers can use the wrapper. The code is modular and easy to maintain.  
 Instead of writing custom code for every API, you can use the wrapper that provides a consistent interface for interacting with APIs.  
@@ -120,7 +120,7 @@ release-it # Follow the instructions
 
 ## docs
 
-Hosted on readthedocs.io [openshift-python-wrapper](https://openshift-python-wrapper.readthedocs.io/en/latest/)
+Hosted on GitHub Pages [openshift-python-wrapper](https://redhatqe.github.io/openshift-python-wrapper/)
 
 ## PR dependency
 

{openshift_python_wrapper-11.0.143 → openshift_python_wrapper-11.0.145}/README.md

@@ -4,7 +4,7 @@
 
 Pypi: [openshift-python-wrapper](https://pypi.org/project/openshift-python-wrapper)  
 A python wrapper for [kubernetes-python-client](https://github.com/kubernetes-client/python) with support for [RedHat Container Virtualization](https://www.openshift.com/learn/topics/virtualization)  
-Docs: [openshift-python-wrapper docs](https://openshift-python-wrapper.readthedocs.io/en/latest/)
+Docs: [openshift-python-wrapper docs](https://redhatqe.github.io/openshift-python-wrapper/)
 
 The wrapper offers a simple and intuitive interface for interacting with the API.  
 It standardizes how to work with cluster resources and offers unified resource CRUD (Create, Read, Update, and Delete) flows.  
@@ -13,9 +13,8 @@ The wrapper makes code easier to read and maintain over time.
 
 One example of simplified usage is interacting with a container.  
 Running a command inside a container requires using Kubernetes stream, handling errors, and more.  
-The wrapper handles it all and provides simple and intuitive functionality.
-
-![Alt Text](examples/pod_example.gif)
+The wrapper handles it all and provides simple and intuitive functionality — see
+[Executing Commands in Pods and Retrieving Logs](https://redhatqe.github.io/openshift-python-wrapper/pod-execution-and-logs.html).
 
 Both developers or testers can use the wrapper. The code is modular and easy to maintain.  
 Instead of writing custom code for every API, you can use the wrapper that provides a consistent interface for interacting with APIs.  
@@ -87,7 +86,7 @@ release-it # Follow the instructions
 
 ## docs
 
-Hosted on readthedocs.io [openshift-python-wrapper](https://openshift-python-wrapper.readthedocs.io/en/latest/)
+Hosted on GitHub Pages [openshift-python-wrapper](https://redhatqe.github.io/openshift-python-wrapper/)
 
 ## PR dependency
 

{openshift_python_wrapper-11.0.143 → openshift_python_wrapper-11.0.145}/class_generator/README.md

@@ -70,6 +70,48 @@ class-generator --regenerate-all --backup
 
 All backups preserve the original directory structure, making it easy to restore specific files or entire directories if needed.
 
+### Verifying generated files
+
+To check whether existing resource files were produced by class-generator (i.e. match its current output), use the verify modes. No file is modified:
+
+```bash
+# Verify specific kinds
+class-generator --verify --kind <kind1>,<kind2>
+
+# Verify all generated resources (only files with the generated marker are checked)
+class-generator --verify-all
+
+# Verify only resources changed relative to the branch's base —
+# use this to verify that PR/branch changes were produced by class-generator
+class-generator --verify-changed [--base <ref>]
+
+# Narrow the scope with a glob filter
+class-generator --verify-all --filter 'Pod*'
+```
+
+The command exits with code `0` when all files match, and code `1` listing the drifted files otherwise. Each drifted file is reported with a unified diff and a drift classification: `blank lines`, `docstring add`/`docstring delete`, `code add`/`code delete` (lines regeneration would introduce/remove), `signature code add`/`signature code remove` (`__init__` parameters added/removed — additions are non-breaking because every generated parameter carries a default, removals are not), `breaking change` (a parameter was removed, so callers passing it get a `TypeError`), and `schema incomplete` (the rendered class lost every parameter, meaning a schema `$ref` could not be resolved — flagged in addition to, not instead of, `breaking change`). A drifted file was either hand-edited inside the generated markers, or the generator/template changed since it was last generated — regenerate it with `class-generator --kind <Kind> --overwrite` instead of editing it manually.
+
+#### Filtering failures by classification
+
+All verify modes accept `--classification` to report (and fail on) only drifted files matching the given classification(s), comma-separated:
+
+```bash
+# failed files whose drift includes blank-lines drift (possibly among others)
+class-generator --verify-all --classification "blank lines"
+
+# failed files whose drift is only blank lines and/or code add, nothing else
+# (e.g. "blank lines" alone, "code add" alone, or both)
+class-generator --verify-all --classification "blank lines,code add" --match
+```
+
+Without `--match`, a file matches when its drift contains **at least one** of the given classifications. With `--match`, the file's drift must be **within** the given set — every classification the file has must be one of the given ones; files with additional classifications are excluded. Drifted files hidden by the filter are counted in the summary but do not fail the run.
+
+`--verify-changed` is the mode intended for PR review: it checks only the generated files the branch actually modified, so pre-existing drift in untouched files does not produce noise. The same check is available as a tox environment:
+
+```bash
+tox -e validate-generated
+```
+
 ### Discovering missing resources
 
 The class-generator can automatically discover resources in your cluster that don't have wrapper classes yet. Resource discovery runs in parallel for improved performance, typically reducing discovery time by 3-5x compared to sequential discovery.