openshift-python-wrapper 10.0.71__tar.gz → 10.0.72__tar.gz

openshift_python_wrapper-10.0.72/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.1
+Name: openshift-python-wrapper
+Version: 10.0.72
+Summary: Wrapper around https://github.com/kubernetes-client/python
+Home-page: https://github.com/RedHatQE/openshift-python-wrapper
+License: Apache-2.0
+Keywords: Openshift,Kubevirt,Openshift Virtualization
+Author: Meni Yakove
+Author-email: myakove@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: cloup (>=3.0.5,<4.0.0)
+Requires-Dist: colorlog (>=6.7.0,<7.0.0)
+Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
+Requires-Dist: kubernetes (>=30.0.0,<31.0.0)
+Requires-Dist: packaging (>=23.1,<24.0)
+Requires-Dist: pyhelper-utils (>=0.0.34,<0.0.35)
+Requires-Dist: pytest (>=8.0.0,<9.0.0)
+Requires-Dist: python-benedict (>=0.33.0,<0.34.0)
+Requires-Dist: python-simple-logger (>=1.0.6)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Requires-Dist: ruff (>=0.6.0,<0.7.0)
+Requires-Dist: timeout-sampler (>=0.0.17)
+Requires-Dist: xmltodict (>=0.13.0,<0.14.0)
+Project-URL: Bug Tracker, https://github.com/RedHatQE/openshift-python-wrapper/issues
+Project-URL: Documentation, https://openshift-python-wrapper.readthedocs.io/en/latest/
+Project-URL: Download, https://pypi.org/project/openshift-python-wrapper/
+Description-Content-Type: text/markdown
+
+# openshift-python-wrapper (`wrapper`)
+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/)
+
+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.  
+The wrapper also provides additional capabilities, such as resource-specific functionality that otherwise needs to be implemented by users.  
+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)
+
+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.  
+It saves time, avoids code duplications, and reduces the chance of errors.
+
+Using Python capabilities, context managers can provide out-of-the-box resource creation and deletion,  
+and inheritance can be used to extend functionality for specific use cases.  
+Pytest fixtures can utilize the code for setup and teardown, leaving no leftovers.  
+Resources can even be saved for debugging.  
+Resource manifests and logs can be easily collected.
+
+## Installation
+From source:
+```bash
+git clone https://github.com/RedHatQE/openshift-python-wrapper.git
+cd openshift-python-wrapper
+python setup.py install --user
+```
+From pypi:
+```bash
+pip install openshift-python-wrapper --user
+```
+
+## Release new version
+### requirements:
+* Export GitHub token
+```bash
+export GITHUB_TOKEN=<your_github_token>
+```
+* [release-it](https://github.com/release-it/release-it)
+```bash
+sudo npm install --global release-it
+npm install --save-dev @release-it/bumper
+```
+### usage:
+* Create a release, run from the relevant branch.  
+To create a 4.11 release, run:
+```bash
+git checkout v4.11
+git pull
+release-it # Follow the instructions
+```
+
+## docs
+Hosted on readthedocs.io [openshift-python-wrapper](https://openshift-python-wrapper.readthedocs.io/en/latest/)
+
+## PR dependency
+For PR dependency we use [dpulls](https://www.dpulls.com/)  
+To make PR depends on other PR add `depends on #<PR NUMBER>` in the PR description.
+
+## Logging configuration
+To change log level export OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL:  
+
+```bash
+export OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL=<LOG_LEVEL> # can be: "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
+```
+
+## Code check
+We use pre-commit for code check.
+```bash
+pre-commit install
+```
+
+Some code examples locate at [examples](examples) directory
+
+## Contribute to the project
+To contribute new additions or changes to the project, please refer to the [contribution guide](CONTRIBUTING.md) first.
+

openshift_python_wrapper-10.0.72/class_generator/README.md

@@ -0,0 +1,97 @@
+# Resource class generator
+
+## Usage
+
+### Installation
+
+- Using [pipx](https://github.com/pypa/pipx) (recommended)
+
+```bash
+ pipx install openshift-python-wrapper
+```
+
+- Using `pip`
+
+```bash
+python3 -m pip install openshift-python-wrapper
+```
+
+- Using [poetry](https://python-poetry.org/) (For development)
+
+```bash
+pipx install poetry
+poetry install
+```
+
+For shell completion Add this to ~/.bashrc or ~/.zshrc:
+
+```bash
+if type class-generator > /dev/null; then eval "$(_CLASS_GENERATOR_COMPLETE=zsh_source class-generator)"; fi
+```
+
+#### Usage
+
+- All available options:
+
+```bash
+class-generator --help
+```
+
+- Running in normal mode with `--kind` flags:
+  - `--kind` can process multiple kinds at the same command, pass `--kind <kind1>,<kind2>,<kind3>`
+
+```bash
+class-generator --kind <kind>
+
+```
+
+- Review the resource file; make sure that the filename and attribute names are named correctly. For example:
+  - `OATH` -> `oath`
+  - `CDIConfig` -> `cdi_config`
+
+#### Adding tests
+
+- Add a new test for the provided `kind` by passing `--add-tests` flag
+- Replace `Pod` with the kind you want to add to the tests
+
+```bash
+class-generator --kind Pod --add-tests
+```
+
+#### Update schema files
+
+- Dependencies
+  - Kubernetes/Openshift cluster
+  - [oc](https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/stable/) or [kubectl](https://kubernetes.io/docs/tasks/tools/) (latest version)
+  - [openapi2jsonschema](https://github.com/instrumenta/openapi2jsonschema)
+  - [poetry](https://python-poetry.org/)
+
+```bash
+pipx install poetry
+pipx install --python python3.9 openapi2jsonschema
+```
+
+- Clone this repository
+
+```bash
+git clone https://github.com/RedHatQE/openshift-python-wrapper.git
+cd openshift-python-wrapper
+```
+
+- Install dependencies
+
+```bash
+poetry install
+```
+
+- Login to the cluster use admin user and password.
+
+```bash
+oc login <clster api URL> -u <username> -p <password>
+```
+
+- Execute the command:
+
+```bash
+poetry run python class_generator/class-generator --update-schema
+```