Metadata-Version: 2.1
Name: openshift-python-utilities
Version: 5.0.63
Summary: A utilities repository for https://github.com/RedHatQE/openshift-python-wrapper
Home-page: https://github.com/RedHatQE/openshift-python-utilities
License: Apache-2.0
Keywords: Openshift,ocp
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: beautifulsoup4 (>=4.12.3,<5.0.0)
Requires-Dist: colorlog (>=6.7.0,<7.0.0)
Requires-Dist: deprecation (>=2.1.0,<3.0.0)
Requires-Dist: openshift-python-wrapper
Requires-Dist: openshift-python-wrapper-data-collector (>=1.0.4)
Requires-Dist: pyhelper-utils (>=0.0.22)
Requires-Dist: python-simple-logger (>=1.0.5)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: semver (>=3.0.2,<4.0.0)
Requires-Dist: timeout-sampler (>=0.0.17)
Project-URL: Bug Tracker, https://github.com/RedHatQE/openshift-python-utilities/issues
Project-URL: Documentation, https://github.com/RedHatQE/openshift-python-utilities/blob/main/README.md
Project-URL: Download, https://pypi.org/project/openshift-python-utilities/
Description-Content-Type: text/markdown

# openshift-python-utilities

Pypi: [openshift-python-utilities](https://pypi.org/project/openshift-python-utilities/)  
A utilities repository for [openshift-restclient-python](https://github.com/openshift/openshift-restclient-python)

## Release new version

### requirements:

* Export GitHub token

```bash
export GITHUB_TOKEN=<your_github_token>
```

* [release-it](https://github.com/release-it/release-it)

Run the following once (execute outside repository dir for example `~/`):

```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
```

## Installation

From source using [poetry](https://github.com/python-poetry/poetry).

```
git clone https://github.com/RedHatQE/openshift-python-utilities.git
cd openshift-python-utilities
poetry install
```

## Examples

### Get Client

```python
from ocp_utilities.infra import get_client
client = get_client(config_file=<path to kubeconfig>))
```

### Install Operator

```python
from ocp_utilities.operators import install_operator
install_operator(
    admin_client=client,
    name=<operator name>,
    channel=<channel>,
    source=<source>,
)
```

