# openshift-python-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. ([Openshift Virtualization](https://www.openshift.com/learn/topics/virtualization))
Docs: [openshift-python-wrapper docs](https://openshift-python-wrapper.readthedocs.io/en/latest/)
## 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` directory
## Contribute to the project
To contribute new additions or changes to the project, please refer to the [contribution guide](CONTRIBUTING.md) first.
Raw data
{
"_id": null,
"home_page": "https://github.com/RedHatQE/openshift-python-wrapper",
"name": "openshift-python-wrapper",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "Openshift, Kubevirt, CNV",
"author": "Meni Yakove",
"author_email": "myakove@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9b/ec/cdc3e5dec35ee6495b4dd9ff128d4e99f514ada2a39deb5839bcf8b5b7ec/openshift_python_wrapper-10.0.47.tar.gz",
"platform": null,
"description": "# openshift-python-wrapper\nPypi: [openshift-python-wrapper](https://pypi.org/project/openshift-python-wrapper) \nA python wrapper for [kubernetes-python-client](https://github.com/kubernetes-client/python) with support for RedHat Container Virtualization. ([Openshift Virtualization](https://www.openshift.com/learn/topics/virtualization))\nDocs: [openshift-python-wrapper docs](https://openshift-python-wrapper.readthedocs.io/en/latest/)\n\n## Installation\nFrom source:\n```bash\ngit clone https://github.com/RedHatQE/openshift-python-wrapper.git\ncd openshift-python-wrapper\npython setup.py install --user\n```\nFrom pypi:\n```bash\npip install openshift-python-wrapper --user\n```\n\n## Release new version\n### requirements:\n* Export GitHub token\n```bash\nexport GITHUB_TOKEN=<your_github_token>\n```\n* [release-it](https://github.com/release-it/release-it)\n```bash\nsudo npm install --global release-it\nnpm install --save-dev @release-it/bumper\n```\n### usage:\n* Create a release, run from the relevant branch. \nTo create a 4.11 release, run:\n```bash\ngit checkout v4.11\ngit pull\nrelease-it # Follow the instructions\n```\n\n## docs\nHosted on readthedocs.io [openshift-python-wrapper](https://openshift-python-wrapper.readthedocs.io/en/latest/)\n\n## PR dependency\nFor PR dependency we use [dpulls](https://www.dpulls.com/) \nTo make PR depends on other PR add `depends on #<PR NUMBER>` in the PR description.\n\n## Logging configuration\nTo change log level export OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL: \n\n```bash\nexport OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL=<LOG_LEVEL> # can be: \"DEBUG\", \"INFO\", \"WARNING\", \"ERROR\", \"CRITICAL\"\n```\n\n## Code check\nWe use pre-commit for code check.\n```bash\npre-commit install\n```\n\nSome code examples locate at `examples` directory\n\n## Contribute to the project\nTo contribute new additions or changes to the project, please refer to the [contribution guide](CONTRIBUTING.md) first.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Wrapper around https://github.com/kubernetes-client/python",
"version": "10.0.47",
"project_urls": {
"Bug Tracker": "https://github.com/RedHatQE/openshift-python-wrapper/issues",
"Documentation": "https://openshift-python-wrapper.readthedocs.io/en/latest/",
"Download": "https://pypi.org/project/openshift-python-wrapper/",
"Homepage": "https://github.com/RedHatQE/openshift-python-wrapper"
},
"split_keywords": [
"openshift",
" kubevirt",
" cnv"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9beccdc3e5dec35ee6495b4dd9ff128d4e99f514ada2a39deb5839bcf8b5b7ec",
"md5": "ab2a361198d0a0eabd9cb32150d09e19",
"sha256": "5ec10b3f9156215339bf1152247553862b05c2e0f242259c2522e647997ad972"
},
"downloads": -1,
"filename": "openshift_python_wrapper-10.0.47.tar.gz",
"has_sig": false,
"md5_digest": "ab2a361198d0a0eabd9cb32150d09e19",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 78905,
"upload_time": "2024-05-19T07:27:08",
"upload_time_iso_8601": "2024-05-19T07:27:08.633715Z",
"url": "https://files.pythonhosted.org/packages/9b/ec/cdc3e5dec35ee6495b4dd9ff128d4e99f514ada2a39deb5839bcf8b5b7ec/openshift_python_wrapper-10.0.47.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-19 07:27:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RedHatQE",
"github_project": "openshift-python-wrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "openshift-python-wrapper"
}
JSON
