# Charmed Kubeflow Chisme
Chisme: a Spanish word for gossip, or a story worth telling to your friends.
This repository is for chisme within the Charmed Kubeflow team's codebase - it is a collection of helpers for use in
both the Charmed Operators maintained by the [Charmed Kubeflow](ckf) team as well as anyone else who benefits from them.
# Contents
* [Exceptions](./src/charmed_kubeflow_chisme/exceptions/README.md): A collection of standard Exceptions for use when writing charms.
* [Kubernetes](./src/charmed_kubeflow_chisme/kubernetes/README.md): Helpers for interacting with Kubernetes
* [Lightkube](./src/charmed_kubeflow_chisme/lightkube/README.md): Helpers specific to using or extending [Lightkube](lightkube-rtd)
* [Pebble](./src/charmed_kubeflow_chisme/pebble/README.md): Helpers for managing pebble when writing charms
* [Reusable Charm Components](./src/charmed_kubeflow_chisme/components/README.md): The `Component` abstraction that encapsulates any piece of logic for a Charm, a reusable reconcile function `CharmReconciler` that executes `Components`, and a collection of `Components` for things like running Pebble containers or deploying Kubernetes resources
* [Rock](./src/charmed_kubeflow_chisme/README.md): Utilities for testing rocks
* [Status Handling](./src/charmed_kubeflow_chisme/status_handling/README.md): Helpers for working with Charm Status objects
* [Testing](./src/charmed_kubeflow_chisme/testing/README.md): Utilities for testing Charms
* [Types](./src/charmed_kubeflow_chisme/types/README.md): Reusable typing definitions, useful for adding type hints
[ckf]: https://charmed-kubeflow.io/
[lightkube-rtd]: https://lightkube.readthedocs.io/en/latest/
# Publishing to PyPi
To publish a new release to Pypi:
1. Update [setup.cfg](https://github.com/canonical/charmed-kubeflow-chisme/blob/main/setup.cfg#L3) to the new version
and commit it to the repo via a completed PR
2. Apply local git tag according to the format `X.X.X` (semantic versioning) on the main branch
3. Push tag to the repo. Example: `git push origin 0.0.8`
4. GitHub Action will create a new release on GitHub
5. Edit release via GitHub UI and click publish
6. GitHub Action will automatically publish the same commit to PyPi repository
Raw data
{
"_id": null,
"home_page": "https://github.com/canonical/charmed-kubeflow-chisme",
"name": "charmed-kubeflow-chisme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Charmed Kubeflow",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/50/a1/8906b4fd0919a8b1c7e54e42d8a782f66d047ba09a1667fa452127ab82e6/charmed_kubeflow_chisme-0.4.6.tar.gz",
"platform": null,
"description": "# Charmed Kubeflow Chisme\n\nChisme: a Spanish word for gossip, or a story worth telling to your friends. \n\nThis repository is for chisme within the Charmed Kubeflow team's codebase - it is a collection of helpers for use in \nboth the Charmed Operators maintained by the [Charmed Kubeflow](ckf) team as well as anyone else who benefits from them.\n\n# Contents\n\n* [Exceptions](./src/charmed_kubeflow_chisme/exceptions/README.md): A collection of standard Exceptions for use when writing charms.\n* [Kubernetes](./src/charmed_kubeflow_chisme/kubernetes/README.md): Helpers for interacting with Kubernetes\n* [Lightkube](./src/charmed_kubeflow_chisme/lightkube/README.md): Helpers specific to using or extending [Lightkube](lightkube-rtd)\n* [Pebble](./src/charmed_kubeflow_chisme/pebble/README.md): Helpers for managing pebble when writing charms\n* [Reusable Charm Components](./src/charmed_kubeflow_chisme/components/README.md): The `Component` abstraction that encapsulates any piece of logic for a Charm, a reusable reconcile function `CharmReconciler` that executes `Components`, and a collection of `Components` for things like running Pebble containers or deploying Kubernetes resources\n* [Rock](./src/charmed_kubeflow_chisme/README.md): Utilities for testing rocks\n* [Status Handling](./src/charmed_kubeflow_chisme/status_handling/README.md): Helpers for working with Charm Status objects\n* [Testing](./src/charmed_kubeflow_chisme/testing/README.md): Utilities for testing Charms\n* [Types](./src/charmed_kubeflow_chisme/types/README.md): Reusable typing definitions, useful for adding type hints\n\n[ckf]: https://charmed-kubeflow.io/\n[lightkube-rtd]: https://lightkube.readthedocs.io/en/latest/\n\n# Publishing to PyPi\n\nTo publish a new release to Pypi:\n1. Update [setup.cfg](https://github.com/canonical/charmed-kubeflow-chisme/blob/main/setup.cfg#L3) to the new version \n and commit it to the repo via a completed PR\n2. Apply local git tag according to the format `X.X.X` (semantic versioning) on the main branch\n3. Push tag to the repo. Example: `git push origin 0.0.8`\n4. GitHub Action will create a new release on GitHub\n5. Edit release via GitHub UI and click publish\n6. GitHub Action will automatically publish the same commit to PyPi repository \n",
"bugtrack_url": null,
"license": null,
"summary": "A collection of helpers for Charms maintained by the Charmed Kubeflow team",
"version": "0.4.6",
"project_urls": {
"Homepage": "https://github.com/canonical/charmed-kubeflow-chisme"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91b0f4bb4b65721f3644a384428f004c9803411d642e613f6f9b2cbbe988737d",
"md5": "38d0c0a4c7d1552d09d0f4445937284c",
"sha256": "69680323ec9767a3c3e26f687e19ced22bce96e90d70fe5ecf70f9cbe4758b93"
},
"downloads": -1,
"filename": "charmed_kubeflow_chisme-0.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "38d0c0a4c7d1552d09d0f4445937284c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 58928,
"upload_time": "2025-01-09T12:01:06",
"upload_time_iso_8601": "2025-01-09T12:01:06.731052Z",
"url": "https://files.pythonhosted.org/packages/91/b0/f4bb4b65721f3644a384428f004c9803411d642e613f6f9b2cbbe988737d/charmed_kubeflow_chisme-0.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "50a18906b4fd0919a8b1c7e54e42d8a782f66d047ba09a1667fa452127ab82e6",
"md5": "fabfe792bc66e0ba749802b5ae78b088",
"sha256": "4a07ddba9fc53cfe8bfe3a799b8f647aed2c3ae565783510c0957581d70491eb"
},
"downloads": -1,
"filename": "charmed_kubeflow_chisme-0.4.6.tar.gz",
"has_sig": false,
"md5_digest": "fabfe792bc66e0ba749802b5ae78b088",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 43458,
"upload_time": "2025-01-09T12:01:07",
"upload_time_iso_8601": "2025-01-09T12:01:07.976705Z",
"url": "https://files.pythonhosted.org/packages/50/a1/8906b4fd0919a8b1c7e54e42d8a782f66d047ba09a1667fa452127ab82e6/charmed_kubeflow_chisme-0.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-09 12:01:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "canonical",
"github_project": "charmed-kubeflow-chisme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "charmed-kubeflow-chisme"
}
JSON
