Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/topics/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Generally, extensions need to be installed into the same Python environment Salt
```yaml
Install Salt Helm extension:
pip.installed:
- name: saltext-helm
- names:
- saltext-helm
- git+https://github.com/azimuth-cloud/pyhelm3.git
```
:::

Expand Down
3 changes: 3 additions & 0 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ def _install_requirements(
if install_test_requirements:
install_extras.append("tests")

# https://github.com/azimuth-cloud/pyhelm3/issues/28

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: There is no simple way to make the latest released version work? Otherwise we'll have to tell users they need to install it manually from the repository...

Sadly PyPI does not allow direct references like pyhelm3 @ git+https://github.com/azimuth-cloud/pyhelm3@c2f6bb9cbe4805010dc0b5aa0c57ad3081f70f45 in the project dependencies.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The released version is quite old and misses support for OCI containers: azimuth-cloud/pyhelm3@62922cd, so it would not behave correctly with the features implemented here...

I use the extension and all dependencies through distribution packages, so it's not an issue for me because I just build pyhelm3 from Git sources anyways.

I understand it's not convenient for users relying on online pip, unfortunately not sure how to improve it.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could check if it's possible to publish a fork to PyPi, but I have not done that before.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I don't think that's necessary, just add the requirement to the installation docs then. It should be trivial for users to add a pip.installed in their states.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding!

session.install("git+https://github.com/azimuth-cloud/pyhelm3.git")

if EXTRA_REQUIREMENTS_INSTALL:
session.log(
"Installing the following extra requirements because the "
Expand Down
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ name = "saltext.helm"
description = "Salt Extension for interacting with Helm"
authors = [
{name = "EITR Technologies, LLC", email = "devops@eitr.tech"},
{name = "Georg Pfuetzenreuter", email = "georg.pfuetzenreuter+salt@suse.com"},
]
keywords = [
"salt-extension",
Expand All @@ -38,6 +39,7 @@ requires-python = ">= 3.10"
dynamic = ["version"]
dependencies = [
"salt>=3006",
"pyhelm3",
]

[project.readme]
Expand Down
Loading
Loading