.. |travis| image:: https://travis-ci.com/haxsaw/hikaru.svg?branch=dev
:target: https://app.travis-ci.com/github/haxsaw/hikaru
.. |license| image:: https://img.shields.io/github/license/haxsaw/hikaru
:alt: GitHub license :target: https://github.com/haxsaw/hikaru/blob/main/LICENSE
.. |versions| image:: https://img.shields.io/pypi/pyversions/hikaru
:alt: PyPI - Python Version
.. |coverage| image:: https://codecov.io/gh/haxsaw/hikaru/branch/dev/graph/badge.svg?token=QOFGNVHGNP
:target: https://codecov.io/gh/haxsaw/hikaru
.. |logo| image:: hikaru-model-26-logo.png
:alt: Hikaru
|logo|
Version 1.1.1
|travis| |license| |versions| |coverage|
`Try it: see Hikaru convert your K8s YAML <http://www.incisivetech.co.uk/try-hikaru.html>`_
`Release notes <https://github.com/haxsaw/hikaru/blob/main/release_notes.rst>`_
`Full documentation at Read the Docs <https://hikaru.readthedocs.io/en/latest/index.html>`_
Hikaru is a collection of tools that allow you to work with Kubernetes resources from within Python in
a variety of ways:
- Hikaru provides type-annotated classes that model all of the Kubernetes resources in Python
and supports CRUD operations on those classes to manage their lifecycle in your Kubernetes cluster.
- Hikaru also provides tooling to shift formats for these objects, allowing you to turn K8s YAML
into Python objects, JSON, or Python dicts, and vice-versa. It can also generate Python source code for K8s
objects loaded from non-Python sources.
- Hikaru also supports a number of features that aid in the management of
your objects such as searching for specific fields or diffing two instances of a K8s resource.
- Hikaru includes support for creating 'watches' on your objects, providing a means to monitor events
on your provisioned K8s resources.
- Hikaru provides support for creation of CRDs which support all the above features such as CRUD operations
and watches.
- Finally, Hikaru includes a facility to specify a collection of
resources as an 'application', similar in spirit to a Helm chart, and provides the same CRUD,
watch, and management capabilities on the entire application as it does on single resource objects
(full format shifting support to come).
**This package supports resources from the Kubernetes Python client version 26.x**. It depends on the
``hikaru-core`` package which will be installed automatically when this packages is installed. This package
will work with any version of the Kubernetes Python client >= 26.x; if you need to constrain which release
is installed then you should establish your own requirement limts on the Kubernetes Python client package.
See README-core.rst for the main README and links to overall documentation.
About
~~~~~
Hikaru is Mr. Sulu’s first name, a famed fictional helmsman.
Raw data
{
"_id": null,
"home_page": "https://github.com/haxsaw/hikaru",
"name": "hikaru-model-26",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Kubernetes,modelling,YAML,JSON,modeling,translate,translator,reformatter,transform",
"author": "Tom Carroll",
"author_email": "tcarroll@incisivetech.co.uk",
"download_url": "https://github.com/haxsaw/hikaru/archive/1.1.1.tar.gz",
"platform": null,
"description": "\n.. |travis| image:: https://travis-ci.com/haxsaw/hikaru.svg?branch=dev\n :target: https://app.travis-ci.com/github/haxsaw/hikaru\n\n.. |license| image:: https://img.shields.io/github/license/haxsaw/hikaru\n :alt: GitHub license :target: https://github.com/haxsaw/hikaru/blob/main/LICENSE\n\n.. |versions| image:: https://img.shields.io/pypi/pyversions/hikaru\n :alt: PyPI - Python Version\n\n.. |coverage| image:: https://codecov.io/gh/haxsaw/hikaru/branch/dev/graph/badge.svg?token=QOFGNVHGNP\n :target: https://codecov.io/gh/haxsaw/hikaru\n \n.. |logo| image:: hikaru-model-26-logo.png\n :alt: Hikaru\n\n|logo|\n\n\nVersion 1.1.1\n\n|travis| |license| |versions| |coverage|\n\n`Try it: see Hikaru convert your K8s YAML <http://www.incisivetech.co.uk/try-hikaru.html>`_\n\n`Release notes <https://github.com/haxsaw/hikaru/blob/main/release_notes.rst>`_\n\n`Full documentation at Read the Docs <https://hikaru.readthedocs.io/en/latest/index.html>`_\n\nHikaru is a collection of tools that allow you to work with Kubernetes resources from within Python in\na variety of ways:\n\n- Hikaru provides type-annotated classes that model all of the Kubernetes resources in Python\n and supports CRUD operations on those classes to manage their lifecycle in your Kubernetes cluster.\n- Hikaru also provides tooling to shift formats for these objects, allowing you to turn K8s YAML\n into Python objects, JSON, or Python dicts, and vice-versa. It can also generate Python source code for K8s\n objects loaded from non-Python sources.\n- Hikaru also supports a number of features that aid in the management of\n your objects such as searching for specific fields or diffing two instances of a K8s resource.\n- Hikaru includes support for creating 'watches' on your objects, providing a means to monitor events\n on your provisioned K8s resources.\n- Hikaru provides support for creation of CRDs which support all the above features such as CRUD operations\n and watches.\n- Finally, Hikaru includes a facility to specify a collection of\n resources as an 'application', similar in spirit to a Helm chart, and provides the same CRUD,\n watch, and management capabilities on the entire application as it does on single resource objects\n (full format shifting support to come).\n\n**This package supports resources from the Kubernetes Python client version 26.x**. It depends on the\n``hikaru-core`` package which will be installed automatically when this packages is installed. This package\nwill work with any version of the Kubernetes Python client >= 26.x; if you need to constrain which release\nis installed then you should establish your own requirement limts on the Kubernetes Python client package.\n\nSee README-core.rst for the main README and links to overall documentation.\n\nAbout\n~~~~~\n\nHikaru is Mr. Sulu\u2019s first name, a famed fictional helmsman.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Hikaru allows you to smoothly move between Kubernetes YAML, Python objects, and Python source, in any direction",
"version": "1.1.1",
"project_urls": {
"Download": "https://github.com/haxsaw/hikaru/archive/1.1.1.tar.gz",
"Homepage": "https://github.com/haxsaw/hikaru"
},
"split_keywords": [
"kubernetes",
"modelling",
"yaml",
"json",
"modeling",
"translate",
"translator",
"reformatter",
"transform"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f384b508188132a5b7931cac4c98cc2cefbb8b4cd53c27b078310465c7377fa9",
"md5": "e91280bfa7274e3f0e1806b9290fa739",
"sha256": "ac574b3b4ef64650d7beb3ef814b24edaf08ad8714f41ac53c0ebe536e8692dd"
},
"downloads": -1,
"filename": "hikaru_model_26-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e91280bfa7274e3f0e1806b9290fa739",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 532662,
"upload_time": "2023-10-06T21:01:03",
"upload_time_iso_8601": "2023-10-06T21:01:03.456450Z",
"url": "https://files.pythonhosted.org/packages/f3/84/b508188132a5b7931cac4c98cc2cefbb8b4cd53c27b078310465c7377fa9/hikaru_model_26-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-06 21:01:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "haxsaw",
"github_project": "hikaru",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "hikaru-model-25",
"specs": [
[
">=",
"1.1.0"
]
]
},
{
"name": "hikaru-model-26",
"specs": [
[
">=",
"1.1.0"
]
]
},
{
"name": "hikaru-model-27",
"specs": [
[
">=",
"1.1.0"
]
]
},
{
"name": "hikaru-model-28",
"specs": [
[
">=",
"1.1.0"
]
]
},
{
"name": "hikaru-codegen",
"specs": [
[
">=",
"1.1.0"
]
]
}
],
"lcname": "hikaru-model-26"
}
JSON
