# 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>,
)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/RedHatQE/openshift-python-utilities",
"name": "openshift-python-utilities",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "Openshift, ocp",
"author": "Meni Yakove",
"author_email": "myakove@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e6/13/d2423f5836d4c2141f8a23645991c7859205f376a4cc2b0568ca1e1793e4/openshift_python_utilities-5.0.41.tar.gz",
"platform": null,
"description": "# openshift-python-utilities\n\nPypi: [openshift-python-utilities](https://pypi.org/project/openshift-python-utilities/) \nA utilities repository for [openshift-restclient-python](https://github.com/openshift/openshift-restclient-python)\n\n## Release new version\n\n### requirements:\n\n* Export GitHub token\n\n```bash\nexport GITHUB_TOKEN=<your_github_token>\n```\n\n* [release-it](https://github.com/release-it/release-it)\n\nRun the following once (execute outside repository dir for example `~/`):\n\n```bash\nsudo npm install --global release-it\nnpm install --save-dev @release-it/bumper\n```\n### usage:\n\n* Create a release, run from the relevant branch. \nTo create a 4.11 release, run:\n\n```bash\ngit checkout v4.11\ngit pull\nrelease-it # Follow the instructions\n```\n\n## Installation\n\nFrom source using [poetry](https://github.com/python-poetry/poetry).\n\n```\ngit clone https://github.com/RedHatQE/openshift-python-utilities.git\ncd openshift-python-utilities\npoetry install\n```\n\n## Examples\n\n### Get Client\n\n```python\nfrom ocp_utilities.infra import get_client\nclient = get_client(config_file=<path to kubeconfig>))\n```\n\n### Install Operator\n\n```python\nfrom ocp_utilities.operators import install_operator\ninstall_operator(\n admin_client=client,\n name=<operator name>,\n channel=<channel>,\n source=<source>,\n)\n```\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A utilities repository for https://github.com/RedHatQE/openshift-python-wrapper",
"version": "5.0.41",
"project_urls": {
"Bug Tracker": "https://github.com/RedHatQE/openshift-python-utilities/issues",
"Documentation": "https://github.com/RedHatQE/openshift-python-utilities/blob/main/README.md",
"Download": "https://pypi.org/project/openshift-python-utilities/",
"Homepage": "https://github.com/RedHatQE/openshift-python-utilities"
},
"split_keywords": [
"openshift",
" ocp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e613d2423f5836d4c2141f8a23645991c7859205f376a4cc2b0568ca1e1793e4",
"md5": "042ab51a979314835d559145e0b4aecb",
"sha256": "552469a7f33868864409b188be4d55db575d61bf9e3a855d9ec5c00e5c1da19b"
},
"downloads": -1,
"filename": "openshift_python_utilities-5.0.41.tar.gz",
"has_sig": false,
"md5_digest": "042ab51a979314835d559145e0b4aecb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 18190,
"upload_time": "2024-05-03T21:23:05",
"upload_time_iso_8601": "2024-05-03T21:23:05.835489Z",
"url": "https://files.pythonhosted.org/packages/e6/13/d2423f5836d4c2141f8a23645991c7859205f376a4cc2b0568ca1e1793e4/openshift_python_utilities-5.0.41.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-03 21:23:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RedHatQE",
"github_project": "openshift-python-utilities",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openshift-python-utilities"
}
JSON
