localargo 0.1.0__tar.gz

localargo-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,115 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+permissions:
+  contents: read
+
+jobs:
+  fmt:
+    name: hatch fmt
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - name: Install Hatch
+        run: python -m pip install --upgrade pip hatch
+      - name: Run formatter
+        run: hatch fmt
+      - name: Fail if formatting changed files
+        run: |
+          git add -A
+          git diff --cached --exit-code
+
+  typecheck:
+    name: hatch run typecheck
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - name: Install Hatch
+        run: python -m pip install --upgrade pip hatch
+      - name: Type check
+        run: hatch run typecheck
+
+  test:
+    name: hatch run test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - name: Install Hatch
+        run: python -m pip install --upgrade pip hatch
+      - name: Run tests
+        run: hatch run test
+
+  pylint:
+    name: hatch run pylint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - name: Install Hatch
+        run: python -m pip install --upgrade pip hatch
+      - name: Run pylint
+        run: hatch run pylint
+
+  pydoclint:
+    name: hatch run pydoclint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - name: Install Hatch
+        run: python -m pip install --upgrade pip hatch
+      - name: Run pydoclint
+        run: hatch run pydoclint
+
+  lizard:
+    name: hatch run lizard
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - name: Install Hatch
+        run: python -m pip install --upgrade pip hatch
+      - name: Run lizard
+        run: hatch run lizard
+
+

localargo-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

localargo-0.1.0/.gitignore

@@ -0,0 +1,72 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Testing
+.coverage
+htmlcov/
+.tox/
+.nox/
+.pytest_cache/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.__*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Documentation build output
+docs/book/
+
+# Hatch
+.hatch/
+dist/
+build/
+
+# Mise
+.mise/
+
+# tarballs
+*.tar.gz
+*.tar
+
+.localargo/

localargo-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 williamkborn
+
+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.

localargo-0.1.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: localargo
+Version: 0.1.0
+Project-URL: Documentation, https://github.com/williamkborn/localargo#readme
+Project-URL: Issues, https://github.com/williamkborn/localargo/issues
+Project-URL: Source, https://github.com/williamkborn/localargo
+Author-email: William Born <william.born.git@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: click
+Requires-Dist: pyyaml
+Requires-Dist: rich
+Requires-Dist: rich-click
+Provides-Extra: dev
+Requires-Dist: lizard; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pydoclint; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: types-pyyaml; extra == 'dev'
+Provides-Extra: watch
+Requires-Dist: watchdog>=2.0.0; extra == 'watch'
+Description-Content-Type: text/markdown
+
+# localargo
+
+[![PyPI - Version](https://img.shields.io/pypi/v/localargo.svg)](https://pypi.org/project/localargo)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/localargo.svg)](https://pypi.org/project/localargo)
+
+**Convenient ArgoCD local development tool**
+
+Localargo is a command-line tool that makes ArgoCD development workflows faster and more convenient. It provides streamlined commands for managing local clusters, applications, secrets, port forwarding, and debugging - all designed specifically for ArgoCD development.
+
+## Features
+
+- 🚀 **Cluster Management**: Set up and switch between local/remote Kubernetes clusters
+- 📦 **Application Management**: Create, sync, and manage ArgoCD applications
+- 🌐 **Port Forwarding**: Easily access services running in your applications
+- 🔐 **Secrets Management**: Create and manage secrets for local development
+- 🔄 **Sync Operations**: Sync applications with watch mode for continuous development
+- 📋 **Templates**: Quick-start applications from common templates
+- 🔍 **Debug Tools**: Comprehensive debugging and troubleshooting utilities
+
+## Quick Start
+
+```bash
+# Install localargo
+pip install localargo
+
+# Initialize a local cluster with ArgoCD (uses KinD by default)
+localargo cluster init
+
+# Create an application from a template
+localargo template create my-app --repo https://github.com/myorg/myrepo
+
+# Port forward services for easy access
+localargo port-forward start my-service
+
+# Sync and watch for changes
+localargo sync my-app --watch
+```
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install localargo
+```
+
+### Development Setup
+
+For contributors and development, we recommend using [Mise](https://mise.jdx.dev/) to set up the complete development environment:
+
+```bash
+# Install Mise (macOS with Homebrew)
+brew install mise
+
+# Install all development tools
+mise install
+
+# Create Hatch environment
+hatch env create
+
+# All tools will be automatically available
+```
+
+### 🧩 Git Hook Setup
+
+To ensure code quality before every commit, enable the mise-managed pre-commit hook:
+
+```bash
+mise generate git-pre-commit --write --task=precommit
+```
+
+This creates `.git/hooks/pre-commit`, which automatically runs:
+
+- `hatch fmt`
+- `hatch run typecheck`
+- `hatch run test`
+
+If any step fails, the commit will be blocked until fixed.
+
+You can also run it manually at any time:
+
+```bash
+mise run precommit
+```
+
+### Optional Dependencies
+
+For file watching functionality:
+```console
+pip install localargo[watch]
+```
+
+## Documentation
+
+📖 Full documentation is available at [docs/](docs/) and can be built locally using mdBook.
+
+To build the documentation:
+
+```console
+# Install mdBook (if not already installed)
+cargo install mdbook
+
+# Build the docs
+cd docs && mdbook build
+
+# Or using Hatch
+hatch run docs:build
+```
+
+## License
+
+`localargo` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+# Test comment for precommit hook

localargo-0.1.0/README.md

@@ -0,0 +1,117 @@
+# localargo
+
+[![PyPI - Version](https://img.shields.io/pypi/v/localargo.svg)](https://pypi.org/project/localargo)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/localargo.svg)](https://pypi.org/project/localargo)
+
+**Convenient ArgoCD local development tool**
+
+Localargo is a command-line tool that makes ArgoCD development workflows faster and more convenient. It provides streamlined commands for managing local clusters, applications, secrets, port forwarding, and debugging - all designed specifically for ArgoCD development.
+
+## Features
+
+- 🚀 **Cluster Management**: Set up and switch between local/remote Kubernetes clusters
+- 📦 **Application Management**: Create, sync, and manage ArgoCD applications
+- 🌐 **Port Forwarding**: Easily access services running in your applications
+- 🔐 **Secrets Management**: Create and manage secrets for local development
+- 🔄 **Sync Operations**: Sync applications with watch mode for continuous development
+- 📋 **Templates**: Quick-start applications from common templates
+- 🔍 **Debug Tools**: Comprehensive debugging and troubleshooting utilities
+
+## Quick Start
+
+```bash
+# Install localargo
+pip install localargo
+
+# Initialize a local cluster with ArgoCD (uses KinD by default)
+localargo cluster init
+
+# Create an application from a template
+localargo template create my-app --repo https://github.com/myorg/myrepo
+
+# Port forward services for easy access
+localargo port-forward start my-service
+
+# Sync and watch for changes
+localargo sync my-app --watch
+```
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install localargo
+```
+
+### Development Setup
+
+For contributors and development, we recommend using [Mise](https://mise.jdx.dev/) to set up the complete development environment:
+
+```bash
+# Install Mise (macOS with Homebrew)
+brew install mise
+
+# Install all development tools
+mise install
+
+# Create Hatch environment
+hatch env create
+
+# All tools will be automatically available
+```
+
+### 🧩 Git Hook Setup
+
+To ensure code quality before every commit, enable the mise-managed pre-commit hook:
+
+```bash
+mise generate git-pre-commit --write --task=precommit
+```
+
+This creates `.git/hooks/pre-commit`, which automatically runs:
+
+- `hatch fmt`
+- `hatch run typecheck`
+- `hatch run test`
+
+If any step fails, the commit will be blocked until fixed.
+
+You can also run it manually at any time:
+
+```bash
+mise run precommit
+```
+
+### Optional Dependencies
+
+For file watching functionality:
+```console
+pip install localargo[watch]
+```
+
+## Documentation
+
+📖 Full documentation is available at [docs/](docs/) and can be built locally using mdBook.
+
+To build the documentation:
+
+```console
+# Install mdBook (if not already installed)
+cargo install mdbook
+
+# Build the docs
+cd docs && mdbook build
+
+# Or using Hatch
+hatch run docs:build
+```
+
+## License
+
+`localargo` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+# Test comment for precommit hook

localargo-0.1.0/clusters.yaml

@@ -0,0 +1,20 @@
+# Example cluster manifest for LocalArgo
+# This file defines clusters that can be managed declaratively
+
+clusters:
+  # Development cluster using KinD
+  - name: dev-cluster
+    provider: kind
+    # Additional provider-specific options can be added here
+    # For example, you could specify Kubernetes version, node configuration, etc.
+
+  # Staging cluster using k3s
+  - name: staging-cluster
+    provider: k3s
+    # Provider-specific configuration would go here
+    # For k3s, you might specify server configuration, networking options, etc.
+
+  # Production-like cluster for testing
+  - name: prod-like-cluster
+    provider: kind
+    # Multiple clusters of the same provider type are supported

localargo-0.1.0/docs/README.md

@@ -0,0 +1,52 @@
+# Localargo Documentation
+
+This directory contains the documentation for Localargo, built using [mdBook](https://rust-lang.github.io/mdBook/).
+
+## Building the Documentation
+
+### Prerequisites
+
+Install mdBook:
+
+```bash
+# Using cargo (recommended)
+cargo install mdbook
+
+# Or download pre-built binaries from:
+# https://github.com/rust-lang/mdBook/releases
+```
+
+### Build
+
+```bash
+# From the docs directory
+./build.sh
+
+# Or manually
+mdbook build
+```
+
+### Serve Locally
+
+To serve the documentation with live reloading during development:
+
+```bash
+mdbook serve
+```
+
+Then open http://localhost:3000 in your browser.
+
+## Documentation Structure
+
+- `book.toml`: mdBook configuration
+- `src/`: Markdown source files
+  - `SUMMARY.md`: Table of contents
+  - `introduction.md`: Project introduction
+  - `installation.md`: Installation instructions
+  - `usage.md`: Usage guide
+  - `contributing.md`: Contributing guidelines
+- `build.sh`: Build script
+
+## Output
+
+Built documentation will be available in the `book/` directory.

localargo-0.1.0/docs/book.toml

@@ -0,0 +1,23 @@
+[book]
+title = "Localargo Documentation"
+authors = ["William Born"]
+description = "Documentation for Localargo, a Python CLI tool"
+language = "en"
+
+[build]
+build-dir = "book"
+create-missing = false
+
+[output.html]
+default-theme = "ayu"
+preferred-dark-theme = "ayu"
+smart-punctuation = true
+mathjax-support = false
+copy-fonts = true
+additional-css = []
+additional-js = []
+no-section-label = false
+git-repository-url = "https://github.com/William Born/localargo"
+git-repository-icon = "fa-github"
+edit-url-template = "https://github.com/William Born/localargo/edit/main/docs/{path}"
+site-url = "/localargo/"

localargo-0.1.0/docs/src/SUMMARY.md

@@ -0,0 +1,8 @@
+# Summary
+
+[Introduction](./introduction.md)
+[Installation](./installation.md)
+[Usage](./usage.md)
+[Enhanced CLI Experience](./usage_eye_candy.md)
+[Testing Philosophy](./testing.md)
+[Contributing](./contributing.md)