kubed-krm 0.0.1__tar.gz

kubed_krm-0.0.1/.devcontainer.json

@@ -0,0 +1,62 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
+{
+	"name": "Kubed KRM Dev",
+
+	// Update the 'dockerComposeFile' list if you have more compose files or use different names.
+	// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
+	// "service": "kubed-dev",
+	// "runServices": [],
+	// "dockerComposeFile": [
+	// 	"docker-compose.yaml"
+	// ],
+	
+	"build": {
+		"dockerfile": "Dockerfile",
+		"target": "dev"
+	},
+	// The optional 'workspaceFolder' property is the path VS Code should open by default when
+	// connected. This is typically a file mount in .devcontainer/docker-compose.yml
+	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	"features": {
+		"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
+		"ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {}
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+	// "shutdownAction": "none",
+
+	// Uncomment the next line to run commands after the container is created.
+	// "postCreateCommand": "echo hello",
+
+	"postStartCommand": "echo 'eval \"$(direnv hook bash)\"' >> ~/.bashrc",
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-python.python",
+				"ms-python.vscode-pylance",
+				"ms-python.debugpy",
+				"redhat.vscode-yaml",
+				"charliermarsh.ruff",
+				"ms-kubernetes-tools.vscode-kubernetes-tools",
+				"mads-hartmann.bash-ide-vscode",
+				"github.copilot",
+				"tamasfe.even-better-toml",
+				"github.vscode-github-actions"
+			],
+			"settings": {
+				"python.defaultInterpreterPath": "/workspaces/krm-py/.direnv/python-3.12.11/bin/python"
+			}
+		}
+	}
+
+	// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "devcontainer"
+}

kubed_krm-0.0.1/.dockerignore

@@ -0,0 +1,14 @@
+.vscode
+build
+dist
+examples
+helm
+lpass
+.editorconfig
+.gitignore
+!.git
+.gitmodules
+docker-compose.yaml
+Dockerfile
+ecr.yaml 
+.DS_STORE

kubed_krm-0.0.1/.editorconfig

@@ -0,0 +1,3 @@
+[*]
+indent_style = space
+indent_size = 2

kubed_krm-0.0.1/.envrc

@@ -0,0 +1 @@
+layout python3

kubed_krm-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,57 @@
+name: 📦 Publish
+
+on:
+  push:
+    tags:
+    - 'v*'
+  workflow_dispatch: {}
+
+permissions:
+  id-token: write
+
+jobs:
+  package:
+    name: Publish PyPI Package
+    runs-on: ubuntu-latest
+    environment: 
+      name: pypi
+      url: https://pypi.org/project/kubed-krm
+    outputs:
+      version: ${{ steps.check_version.outputs.version }}
+    steps:
+
+    - name: Checkout Code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        cache: pip
+
+    - name: Install Dependencies
+      run: pip install '.[build]'
+
+    - name: Check True Version
+      id: check_version
+      run: |
+        version=$(python -m setuptools_scm)
+        package="kubed_krm-${version}"
+        echo "Building Version: $version"
+        echo "version=$version" >> $GITHUB_OUTPUT
+        echo "package=$package" >> $GITHUB_OUTPUT
+    
+    - name: Run the Build
+      run: python -m build
+
+    - name: Show Files
+      run: ls -l dist
+
+    - name: Github Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ steps.check_version.outputs.package }}
+        path: dist/*.tar.gz
+        
+    - name: Publish Package to PyPI
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+      uses: pypa/gh-action-pypi-publish@release/v1

kubed_krm-0.0.1/.gitignore

@@ -0,0 +1,29 @@
+.secrets
+.project
+.coverage
+secretkey
+credentials.json
+/logs
+/helm
+/rclone
+/apps/**/charts
+/charts/**/charts
+/examples/**/charts
+*.identifier
+*.pyc
+__pycache__
+.DS_Store
+*.egg-info
+.pytest_cache
+/dist
+/build
+/configstore
+.vscode/settings.json
+nvm
+*.log
+_build
+bin
+mume
+/kustomize/plugin/kubed.io
+/packer
+.direnv

kubed_krm-0.0.1/.python-version

@@ -0,0 +1 @@
+3.12.11

kubed_krm-0.0.1/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "tamasfe.even-better-toml",
+    "github.vscode-github-actions"
+  ]
+}

kubed_krm-0.0.1/.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    "configurations": [
+        {
+            "name": "Kubed KRM",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "src/krm/common.py",
+            "console": "integratedTerminal",
+            "consoleName": "KRM Debugger",
+            "justMyCode": true,
+            "args": [
+
+            ],
+            "cwd": "${workspaceFolder}",
+            "env": {}
+        }
+    ]
+}

kubed_krm-0.0.1/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- skeleton of the project
+- working build

kubed_krm-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,135 @@
+# Contributing
+
+Follow these steps to be proper. There is a lot of very specific steps and automations, please read this entire document before starting. Many questions will be answered by simply getting everything setup exactly the same way in the instructions.
+
+## Clone the Repo
+
+Clone the repo with the wiki submodule. The wiki submodule contains the static content and templates for mkdocs.
+
+```sh
+git clone --recurse-submodules git@github.com:kubed-io/krm-py.git
+```
+
+## [Direnv](https://github.com/direnv/direnv) Setup
+
+Here is a good start for a decent `.envrc` file.
+
+```sh
+layout python3 # creates the python venv using direnv and sets the VIRTUAL_ENV environment variable to use it
+```
+
+## Installation
+
+Install dependencies in editable mode so you can use step through debugging. All of the optional dependencies are included within the square brackets. You can see what they all are in the [`pyproject.toml`](pyproject.toml) file.
+
+```sh
+pip install --editable '.[build]'
+```
+
+The unit tests are a good starting place for development.
+
+```sh
+pytest src -m unit
+```
+
+At least this should work: 
+
+```sh
+kustomize build ./examples/embed --enable-alpha-plugins --enable-exec
+```
+
+
+## Changelog
+
+Make sure to take note of your changes in the changelog. This is done by updating the `CHANGELOG.md` file. Add any new details under the `## [Unreleased]` section. When a new version is published, the word `Unreleased` will be replaced with the version number and the date. The section will also be the detailed release notes under releases in Github. The checks on the PR will fail if you don't add any notes in the changelog.
+
+## Signed Commits
+
+This is a public repo, one cannot simply trust that a commit came from who it says it did. To ensure the integrity of the commits, all commits must be signed. Your commits and PR will be rejected if they are not signed. Please read more about how to do this here if you do not know how: [Github Signing Commits](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits). Ideally, if you have 1password, please follow these instructions: [1Password Signing Commits](https://blog.1password.com/git-commit-signing/).
+
+## Building Artifacts
+
+Build the pip package. This will cache in the build folder and the final output will be in the dist folder. This package is deployed to [pypi](https://pypi.org/project/kubed-krm/).
+
+```sh
+python -m build
+```
+
+## Version Bump
+
+Get the current version:
+
+```sh
+python -m setuptools_scm
+```
+
+When building the artifact the setuptools scm tool will use the a snazzy semver logic to determine version.
+
+_ref:_ [SetupTools SCM](https://pypi.org/project/setuptools-scm/)
+
+When Ready to publish a new version live, go to the workflow and run the workflow manually. This will bump the version, build the artifact, and push the new version to pypi.
+
+## Docker Image
+
+The docker file uses a couple of stages to do a few different tasks. Mainly the official image is the runner target. The bin target is for generating multiarch binaries.
+
+Build the main image locally for your machine using compose.
+
+```sh
+docker compose build
+```
+
+Or use bake to for a multiarch image. You just can't export images that are not your arch locally. So use compose to actually build the image locally.
+
+```sh
+docker buildx bake
+```
+
+
+
+## Documentation
+
+The wiki is a static generated website using mkdocs. All of the resource docs are pulled out from the pydoc strings in the code. The convention for docs in code is [Google style docstrings](https://google.github.io/styleguide/pyguide.html).
+
+Here is an example of the docstring format.
+
+```python
+def my_function(param1, param2) -> dict:
+    """This is a function that does something.
+
+    Args:
+      param1: The first parameter.
+      param2: The second parameter.
+
+    Returns:
+      message: The return value.
+
+    Raises:
+        KubedError: If the value is not correct.
+    """
+    return {}
+```
+
+## VSCode Setup
+
+To be helpful as possible, all of the sweet spot configurations for VSCode are included in the `.vscode` folder. Although these files are committed they have been ignored from the working tree, so feel free to update them as you see fit and they will not be committed.
+
+Here is how git is ignoring the files.
+
+```sh
+git update-index --skip-worktree .vscode/settings.json
+```
+
+### Step Through Debugging
+
+Within the `.vscode/launch.json`, change the `args` to the command you want to debug, this is equivelent to running from the command line. Remember to install the project with `--editable` so you can step through the code easily.
+
+### Tasks
+
+All of the commands described above have been implemented as VSCode tasks in the `.vscode/tasks.json`. This goes well with the [spmeesseman.vscode-taskexplorer](https://marketplace.visualstudio.com/items?itemName=spmeesseman.vscode-taskexplorer) extension which gives you a nice little button to run the tasks.
+
+### Devcontainer
+
+The `.devcontainer.json` file is included for quickly spinning up a working enviornment. This is a good way to ensure that all of the dependencies are installed and the correct version of python is being used without fighting with any nuances present in your local environment.
+
+

kubed_krm-0.0.1/Dockerfile

@@ -0,0 +1,61 @@
+ARG PY_VERSION=3.12 \
+    TARGETPLATFORM \
+    BUILDPLATFORM
+##
+# Base setup step
+# Simply copy project and install
+## 
+FROM python:$PY_VERSION AS setup
+WORKDIR /app
+COPY . . 
+RUN <<EOF
+pip install --no-cache-dir --upgrade pip
+pip install --no-cache-dir .[build]
+EOF
+
+##
+# Package builder intermediate step
+# Allows for successive steps to simple copy the built package
+##
+FROM setup AS builder
+RUN python -m build --no-isolation
+
+##
+# Final runtime image
+# This is pushed to the registry.
+##
+FROM kubed/krm:latest AS runner
+ARG TARGETPLATFORM \
+    BUILDPLATFORM
+
+RUN apk --no-cache add \
+        python3 \
+        py3-pip \
+        ncurses
+
+COPY --from=builder /app/dist ./dist/
+
+RUN pip install --break-system-packages --no-cache-dir ./dist/*.whl && \
+    rm -rf ./dist
+
+SHELL [ "/bin/bash", "-c" ]
+
+CMD ["kubed"]
+
+##
+# Dev container build
+# docs: https://github.com/microsoft/vscode-dev-containers/blob/main/containers/python-3/README.md
+# Makes the dev container environment
+##
+FROM mcr.microsoft.com/vscode/devcontainers/python:${PY_VERSION} AS dev
+ARG NODE_VERSION="none" \
+    KUSTOMIZE_VERSION="v5.7.1" \
+    TARGETPLATFORM \
+    BUILDPLATFORM
+RUN <<EOF 
+export DEBIAN_FRONTEND=noninteractive && apt-get update
+apt-get -y install --no-install-recommends direnv python3-venv
+apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/library-scripts 
+curl -L "https://github.com/kubernetes-sigs/kustomize/releases/download/kustomize%2F${KUSTOMIZE_VERSION}/kustomize_${KUSTOMIZE_VERSION}_linux_amd64.tar.gz" | tar -xz -C /usr/local/bin kustomize
+chmod +x /usr/local/bin/kustomize
+EOF

kubed_krm-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 DuploCloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kubed_krm-0.0.1/Makefile

@@ -0,0 +1,31 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = ./docs
+BUILDDIR      = ./dist/docs
+
+.PHONY: help Makefile clean image
+
+build:
+	pip3 install . --cache-dir dist/cache -t dist/target
+	pip3 install -r docs/requirements.txt
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -rf build dist
+
+image:
+	docker buildx bake -f docker-bake.hcl
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: build
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+

kubed_krm-0.0.1/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: kubed-krm
+Version: 0.0.1
+Summary: Python implementation of the Kubernetes KRM Function Interface
+Author-email: Kelly <admin@kellyferrone.com>
+Maintainer-email: Kelly <admin@kellyferrone.com>
+Project-URL: Homepage, https://github.com/kubed-io
+Project-URL: Documentation, https://github.com/kubed-io/krm-py
+Project-URL: Repository, https://github.com/kubed-io/krm-py
+Project-URL: Issues, https://github.com/kubed-io/krm-py/issues
+Project-URL: Changelog, https://github.com/kubed-io/krm-py/blob/main/CHANGELOG.md
+Project-URL: LatestRelease, https://github.com/kubed-io/krm-py/releases
+Keywords: kubernetes,krm,kustomize,kubectl,krew
+Requires-Python: >=3.10.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.22.0
+Requires-Dist: cachetools>=5.2.0
+Requires-Dist: jmespath>=1.0.1
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: jsonpatch>=1.33
+Requires-Dist: jsonpointer>=2.4
+Requires-Dist: netaddr>=0.8.0
+Requires-Dist: kubernetes>=33.1.0
+Provides-Extra: build
+Requires-Dist: invoke; extra == "build"
+Requires-Dist: setuptools_scm; extra == "build"
+Requires-Dist: build; extra == "build"
+Requires-Dist: wheel; extra == "build"
+Requires-Dist: twine; extra == "build"
+Requires-Dist: pyinstaller; extra == "build"
+Requires-Dist: toml; extra == "build"
+Requires-Dist: semver; extra == "build"
+Dynamic: license-file
+
+# Kubed KRM
+
+A python Implementation of KRM function by Kustomize and Google. 
+

kubed_krm-0.0.1/README.md

@@ -0,0 +1,4 @@
+# Kubed KRM
+
+A python Implementation of KRM function by Kustomize and Google. 
+

kubed_krm-0.0.1/build.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+function krm_clean() {
+    rm -rf \
+        dist build \
+        .coverage .pytest_cache .tmp \
+        *.egg-info src/*.egg-info **/__pycache__ \
+        .direnv .ruff_cache requirements.txt
+
+    find . | grep -E "(/__pycache__$|\.pyc$|\.pyo$)" | xargs rm -rf
+}
+
+krm_${@}

kubed_krm-0.0.1/docker-compose.yaml

@@ -0,0 +1,30 @@
+services:
+
+  kubed-krm-py:
+    image: &image kubed/krm-py:latest
+    build:
+      target: runner
+      tags:
+      - *image
+      - kubed/krm-py:${GIT_SHA:-latest}
+      - kubed/krm-py:${GIT_REF:-latest}
+      - kubed/krm-py:${GIT_TAG:-latest}
+      x-bake:
+        platforms:
+        - linux/amd64
+        - linux/arm64
+        cache-to: type=gha,mode=max,scope=kubed-krm-py
+        cache-from: type=gha,scope=kubed-krm-py
+    container_name: kubed-krm-py
+    stdin_open: true
+    tty: true
+    privileged: true
+    volumes:
+    - ./examples:/examples
+    entrypoint:
+    - /bin/bash
+    - -c
+    command: 
+    - tail
+    - -f
+    - /dev/null

kubed_krm-0.0.1/docs/conf.py

@@ -0,0 +1,99 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../lib'))
+from kubed.krm import common as c, files as f
+import sphinx_theme
+from sphinx_gallery.sorting import FileNameSortKey
+
+# -- Project information -----------------------------------------------------
+
+project = 'kubed-krm-docs'
+copyright = '2022, Kelly Ferrone'
+author = 'Kelly Ferrone'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
+    # 'sphinx_gallery.gen_gallery',
+    # 'sphinx.ext.intersphinx',
+    'myst_parser',
+    'sphinx_jinja',
+    'sphinx_rtd_theme',
+    'sphinx_panels',
+    'sphinx_copybutton',
+    'sphinx-jsonschema'
+    ]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'stanford_theme'
+html_theme_path = [sphinx_theme.get_html_theme_path('stanford-theme')]
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# sphinx-gallery configuration
+# sphinx_gallery_conf = {
+#     # path to your example scripts
+#     'examples_dirs': [],
+#     # path to where to save gallery generated output
+#     'gallery_dirs': [],
+#     # specify that examples should be ordered according to filename
+#     'within_subsection_order': FileNameSortKey,
+#     # directory where function granular galleries are stored
+#     'backreferences_dir': 'gen_modules/backreferences',
+#     # Modules for which function level galleries are created.  In
+#     # this case sphinx_gallery and numpy in a tuple of strings.
+#     'doc_module': ('SampleModule'),
+# }
+
+# configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {}
+
+myst_enable_extensions = [
+  "colon_fence",
+  "deflist",
+  "linkify",
+  "substitution"
+]
+
+
+jinja_contexts = {
+    'replicate': f.load_yaml('../examples/replicate/kustomization.yaml')
+}

kubed_krm-0.0.1/docs/generators/lastpass.md

@@ -0,0 +1,3 @@
+# LastPass Secret  
+
+Generates a Secret kind based on a secret from extracted from LastPass cli.