openshift-python-utilities

Name	openshift-python-utilities JSON
Version	6.0.6 JSON
	download
home_page	None
Summary	A utilities repository for https://github.com/RedHatQE/openshift-python-wrapper
upload_time	2025-01-27 06:54:47
maintainer	None
docs_url	None
author	None
requires_python	~=3.9
license	None
keywords	openshift ocp
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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 [uv](https://github.com/astral-sh/uv).

```
git clone https://github.com/RedHatQE/openshift-python-utilities.git
cd openshift-python-utilities
uv sync
```

## 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": null,
    "name": "openshift-python-utilities",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.9",
    "maintainer_email": null,
    "keywords": "Openshift, ocp",
    "author": null,
    "author_email": "Meni Yakove <myakove@gmail.com>, Ruth Netser <rnetser@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/88/ed/038eb464ab41500e59ad0987d6c97770ada252623b6086910dc91359de58/openshift_python_utilities-6.0.6.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\n### usage\n\n- Create a release, run from the relevant branch.  \n  To 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 [uv](https://github.com/astral-sh/uv).\n\n```\ngit clone https://github.com/RedHatQE/openshift-python-utilities.git\ncd openshift-python-utilities\nuv sync\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",
    "bugtrack_url": null,
    "license": null,
    "summary": "A utilities repository for https://github.com/RedHatQE/openshift-python-wrapper",
    "version": "6.0.6",
    "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": null,
            "digests": {
                "blake2b_256": "88ed038eb464ab41500e59ad0987d6c97770ada252623b6086910dc91359de58",
                "md5": "67af9274f5113ae8aa768f0b4be92a68",
                "sha256": "ad4f1f1c9a9a78f1332ed7330fa4b5fa2db1c7e069cd12242c1f445f922bf6b2"
            },
            "downloads": -1,
            "filename": "openshift_python_utilities-6.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "67af9274f5113ae8aa768f0b4be92a68",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.9",
            "size": 18167,
            "upload_time": "2025-01-27T06:54:47",
            "upload_time_iso_8601": "2025-01-27T06:54:47.875922Z",
            "url": "https://files.pythonhosted.org/packages/88/ed/038eb464ab41500e59ad0987d6c97770ada252623b6086910dc91359de58/openshift_python_utilities-6.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-27 06:54:47",
    "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"
}