kdebug 0.2.0__tar.gz

kdebug-0.2.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: "chore(deps)"

kdebug-0.2.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,40 @@
+# Uses PyPI Trusted Publisher (OIDC) - no token required
+# Configure at: https://pypi.org/manage/project/kdebug/settings/publishing/
+
+name: Publish to PyPI
+
+on:
+  workflow_call:
+    inputs:
+      ref:
+        description: 'Git reference to checkout'
+        required: false
+        type: string
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref || github.ref }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package
+        run: uv publish --trusted-publishing always

kdebug-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,87 @@
+name: Create Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: 'Release type'
+        required: true
+        default: 'patch'
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.new.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Get current version
+        id: current
+        run: |
+          VERSION=$(grep -oP '^version = "\K[^"]+' pyproject.toml)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Calculate new version
+        id: new
+        run: |
+          IFS='.' read -r major minor patch <<< "${{ steps.current.outputs.version }}"
+          case "${{ inputs.release_type }}" in
+            major) major=$((major + 1)); minor=0; patch=0 ;;
+            minor) minor=$((minor + 1)); patch=0 ;;
+            patch) patch=$((patch + 1)) ;;
+          esac
+          echo "version=${major}.${minor}.${patch}" >> $GITHUB_OUTPUT
+
+      - name: Update version in pyproject.toml
+        run: |
+          sed -i 's/^version = "[^"]*"/version = "${{ steps.new.outputs.version }}"/' pyproject.toml
+
+      - name: Commit and tag
+        run: |
+          git add pyproject.toml
+          git commit -m "Release v${{ steps.new.outputs.version }}"
+          git tag "v${{ steps.new.outputs.version }}"
+
+      - name: Push changes
+        run: |
+          git push origin HEAD:${{ github.ref_name }}
+          git push --tags
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create "v${{ steps.new.outputs.version }}" \
+            --generate-notes \
+            --latest
+
+  update-homebrew:
+    needs: release
+    uses: ./.github/workflows/update-homebrew.yml
+    with:
+      version: v${{ needs.release.outputs.version }}
+    secrets: inherit
+
+  publish-pypi:
+    needs: release
+    uses: ./.github/workflows/pypi-publish.yml
+    with:
+      ref: v${{ needs.release.outputs.version }}
+    secrets: inherit

kdebug-0.2.0/.github/workflows/update-homebrew.yml

@@ -0,0 +1,50 @@
+name: Update Homebrew Tap
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+  workflow_call:
+    inputs:
+      version:
+        description: 'Version tag (e.g., v1.0.0)'
+        required: false
+        type: string
+
+jobs:
+  update-homebrew-tap:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get release info
+        id: release-info
+        run: |
+          # Use input version if provided, otherwise extract from GITHUB_REF
+          if [[ -n "${{ inputs.version }}" ]]; then
+            VERSION="${{ inputs.version }}"
+          else
+            VERSION=${GITHUB_REF#refs/tags/}
+          fi
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Release version: $VERSION"
+
+      - name: Trigger Homebrew tap update
+        run: |
+          curl -L \
+            -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ secrets.HOMEBREW_TAP_TOKEN }}" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            https://api.github.com/repos/jessegoodier/homebrew-kdebug/dispatches \
+            -d '{
+              "event_type": "update-homebrew-formula",
+              "client_payload": {
+                "version": "${{ steps.release-info.outputs.version }}",
+                "repository": "${{ github.repository }}"
+              }
+            }'
+
+      - name: Create workflow summary
+        run: |
+          echo "🍺 Triggered Homebrew tap update for kdebug version ${{ steps.release-info.outputs.version }}" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "The Homebrew formula will be updated automatically in the [homebrew-kdebug](https://github.com/jessegoodier/homebrew-kdebug) repository." >> $GITHUB_STEP_SUMMARY

kdebug-0.2.0/.gitignore

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

kdebug-0.2.0/AGENTS.md

@@ -0,0 +1,141 @@
+# AGENTS.md - AI Assistant Guide
+
+This file helps AI coding assistants understand the kdebug project.
+
+## Project Overview
+
+kdebug is a Python CLI tool for launching ephemeral debug containers in Kubernetes pods. It provides interactive shell access, backup capabilities, and a TUI for pod selection.
+
+## Project Structure
+
+```
+kdebug/
+├── pyproject.toml           # Package metadata and build config (version source of truth)
+├── src/
+│   └── kdebug/
+│       ├── __init__.py      # Package init with __version__ from importlib.metadata
+│       └── cli.py           # Main CLI code
+├── completions/
+│   ├── kdebug.bash          # Bash completion script (generated)
+│   └── _kdebug              # Zsh completion script (generated)
+├── README.md                # User documentation
+├── AGENTS.md                # This file
+└── .github/
+    └── workflows/
+        └── release.yml      # Release automation (updates pyproject.toml)
+```
+
+## Key Architecture
+
+- **Python package**: Installable via `uv tool install kdebug` or `pip install .`
+- **Entry point**: `kdebug` command maps to `kdebug.cli:main`
+- **Version**: Single source of truth in `pyproject.toml`, accessed via `importlib.metadata`
+- **No external dependencies**: Uses Python stdlib only
+- **Completion scripts are generated**: The functions `generate_bash_completion()` and `generate_zsh_completion()` in `src/kdebug/cli.py` produce the completion files
+- **Global state pattern**: Module-level variables (`DEBUG_MODE`, `KUBECTL_CONTEXT`, `KUBECTL_KUBECONFIG`) are set after argument parsing
+
+## Making Changes
+
+### Adding a new CLI argument
+
+1. Add the argument to the appropriate `parser.add_argument_group()` in `main()`
+2. If it affects kubectl commands, update the relevant helper function or `kubectl_base_cmd()`
+3. Update `generate_bash_completion()` - add to `opts` list and add completion case if needed
+4. Update `generate_zsh_completion()` - add to `args` array with appropriate completer
+5. Regenerate completion files (see below)
+6. Update README.md if user-facing
+
+### Modifying kubectl commands
+
+All kubectl commands should use `kubectl_base_cmd()` to ensure `--context` and `--kubeconfig` are passed through:
+
+```python
+cmd = f"{kubectl_base_cmd()} get pods -n {namespace} -o json"
+```
+
+### Regenerating completion files
+
+After modifying the completion generators:
+
+```bash
+# Install package in development mode first
+uv pip install -e .
+
+# Then regenerate completions
+kdebug --completions bash > completions/kdebug.bash
+kdebug --completions zsh > completions/_kdebug
+```
+
+## Testing
+
+### Manual testing
+
+```bash
+# Install in development mode
+uv pip install -e .
+
+# Verify help output
+kdebug --help
+
+# Verify version
+kdebug --version
+
+# Test with debug mode to see kubectl commands
+kdebug --debug -n <namespace>
+
+# Test argument combinations
+kdebug --context <ctx> --kubeconfig <path> -n <ns> --pod <pod>
+```
+
+### Syntax checks
+
+```bash
+# Python syntax
+python3 -m py_compile src/kdebug/cli.py
+
+# Bash completion syntax
+bash -n completions/kdebug.bash
+
+# Zsh completion syntax
+zsh -n completions/_kdebug
+```
+
+### Testing completions
+
+```bash
+# Bash
+source <(kdebug --completions bash)
+kdebug --<TAB>
+
+# Zsh
+source <(kdebug --completions zsh)
+kdebug --<TAB>
+```
+
+## Code Conventions
+
+- Use `colorize()` for colored output
+- Use `run_command()` for executing shell commands
+- Use `print_debug_command()` to show commands when `--debug` is enabled
+- Error messages go to stderr with `file=sys.stderr`
+- Success indicators use green checkmarks: `{colorize('✓', Colors.GREEN)}`
+- Error indicators use red X: `{colorize('✗', Colors.RED)}`
+
+## Dependencies
+
+- Python 3.8+ (for `importlib.metadata`)
+- kubectl (must be in PATH and configured)
+- No pip packages required
+
+## Installation
+
+```bash
+# Via uv (recommended)
+uv tool install kdebug
+
+# Via pip
+pip install .
+
+# Development mode
+uv pip install -e .
+```