base-cli 0.3.0__tar.gz → 0.4.1__tar.gz

base_cli-0.4.1/.github/ISSUE_TEMPLATE/support.md

@@ -0,0 +1,28 @@
+---
+name: Adoption support
+about: Request migration or downstream compatibility help
+title: "[Support] "
+labels: ""
+assignees: ""
+---
+
+## What are you adopting?
+
+Describe the CLI, its Click/Typer version, and the intended production use case.
+
+## Reproduction
+
+Provide a minimal command and the exact exit code. Remove credentials, tokens,
+customer data, and private paths.
+
+## Environment
+
+- `base-cli` version:
+- Python version:
+- Operating system:
+- Click/Typer and optional integration versions:
+
+## Evidence
+
+Attach or link a redacted log/run bundle and say whether the failure occurs
+against an installed wheel. Security-sensitive reports belong in `SECURITY.md`.

base_cli-0.4.1/.github/base-project.yml

@@ -0,0 +1,9 @@
+project:
+  areas: []
+  initiatives: []
+  issue_defaults:
+    status: Backlog
+    priority: P2
+    area: Product
+    initiative: Adoption Polish
+    size: S

base_cli-0.4.1/.github/pull_request_template.md

@@ -0,0 +1,25 @@
+## Summary
+
+<!-- What changed and why. Focus on decisions and user impact, not just the diff. -->
+
+## Issue
+
+Closes #
+
+## Validation
+
+<!-- Commands run and relevant output. Include narrow checks and any broader suite used. -->
+
+## Notes
+
+<!-- Optional: tradeoffs, follow-up work, or reviewer context. -->
+
+## Checklist
+
+- [ ] Branch name follows `<category>/<issue>-<YYYYMMDD>-<slug>`, and its category prefix matches the issue's single standard category label.
+- [ ] Pull request is scoped to one issue, unless a documented multi-issue exception applies.
+- [ ] Pull request body explains what changed and how it was validated.
+- [ ] Relevant project checks pass.
+- [ ] Documentation is updated when behavior or user-facing commands change.
+- [ ] CHANGELOG is updated for notable user-visible or release-worthy changes.
+- [ ] Pull request includes `Fixes #<issue>` or `Closes #<issue>` when merge should close the issue.

base_cli-0.4.1/.github/workflows/compatibility.yml

@@ -0,0 +1,68 @@
+name: Reference consumers
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  typer-matrix:
+    name: Typer ${{ matrix.typer-version }} / Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        typer-version: ["0.25.1", "0.26.0", "0.27.1"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install framework and exact Typer line
+        run: |
+          python -m pip install "setuptools<77" "wheel"
+          python -m pip install ".[dev]"
+          python -m pip install --upgrade "typer==${{ matrix.typer-version }}"
+      - name: Install Beacon fixture without dependency resolution
+        run: python -m pip install --no-deps compatibility/consumers/beacon_typer
+      - name: Run adapter and Beacon compatibility tests
+        run: python -m pytest tests/test_typer_adapter.py compatibility/consumers/beacon_typer/tests
+
+  downstream:
+    name: Install and test independent consumers
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.13"
+      - name: Install framework build and test dependencies
+        run: python -m pip install ".[dev,typer,rich,telemetry]"
+      - name: Build and install the framework wheel
+        run: |
+          python -m build --wheel
+          python -m pip uninstall --yes base-cli
+          python -m pip install dist/*.whl
+      - name: Validate consumer manifest
+        run: python scripts/validate_consumers.py
+      - name: Install consumers independently
+        run: |
+          python -m pip install compatibility/consumers/atlas_click
+          python -m pip install compatibility/consumers/beacon_typer
+          python -m pip install "compatibility/consumers/cinder_automation[observability]"
+      - name: Run downstream compatibility suites
+        run: |
+          for tests in compatibility/consumers/*/tests; do
+            python -m pytest "$tests"
+          done

base_cli-0.4.1/.github/workflows/docs.yml

@@ -0,0 +1,81 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "README.md"
+      - "SECURITY.md"
+      - "docs/**"
+      - "mkdocs.yml"
+      - "pyproject.toml"
+      - "scripts/validate_docs.py"
+      - "tests/validate.sh"
+      - ".github/workflows/docs.yml"
+  pull_request:
+    paths:
+      - "README.md"
+      - "SECURITY.md"
+      - "docs/**"
+      - "mkdocs.yml"
+      - "pyproject.toml"
+      - "scripts/validate_docs.py"
+      - "tests/validate.sh"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build and validate documentation
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Check out source
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.13"
+
+      - name: Install documentation tools
+        run: python -m pip install ".[docs]"
+
+      - name: Validate repository links and examples
+        run: python scripts/validate_docs.py
+
+      - name: Build documentation with strict warnings
+        run: python -m mkdocs build --strict --site-dir site
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
+        with:
+          path: site
+
+  deploy:
+    name: Deploy documentation site
+    if: ${{ (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main' }}
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@f33f41b675f0ab2dc5a6863c9a170fe83af3571e # v4.0.0

base_cli-0.4.1/.github/workflows/examples.yml

@@ -0,0 +1,45 @@
+name: Reference examples
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  install-and-test:
+    name: Build wheel, install examples, and test
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.13"
+      - name: Install framework build and test dependencies
+        run: python -m pip install ".[dev,typer,rich,telemetry]"
+      - name: Build and install the framework wheel
+        run: |
+          python -m build --wheel
+          python -m pip uninstall --yes base-cli
+          python -m pip install dist/*.whl
+      - name: Validate reference-app structure
+        run: python scripts/validate_examples.py
+      - name: Install each example independently
+        run: |
+          for example in examples/*; do
+            if [[ -f "$example/pyproject.toml" ]]; then
+              python -m pip install "$example"
+            fi
+          done
+      - name: Run reference-app tests
+        run: |
+          for tests in examples/*/tests; do
+            python -m pytest "$tests"
+          done