corclient 0.1.0__tar.gz

corclient-0.1.0/.github/workflows/homebrew-formula.yaml

@@ -0,0 +1,104 @@
+name: Update Homebrew Formula
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to update formula for'
+        required: true
+        type: string
+
+jobs:
+  update-formula:
+    name: Update Homebrew Formula
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get release info
+        id: release
+        run: |
+          if [ "${{ github.event_name }}" == "release" ]; then
+            VERSION="${{ github.event.release.tag_name }}"
+            VERSION="${VERSION#v}"  # Remove 'v' prefix if present
+          else
+            VERSION="${{ inputs.version }}"
+          fi
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          
+          # Wait a bit for PyPI to have the package available
+          sleep 30
+          
+          # Download the tarball from PyPI
+          wget "https://files.pythonhosted.org/packages/source/c/corclient/corclient-${VERSION}.tar.gz"
+          
+          # Calculate SHA256
+          SHA256=$(sha256sum "corclient-${VERSION}.tar.gz" | awk '{print $1}')
+          echo "sha256=${SHA256}" >> $GITHUB_OUTPUT
+
+      - name: Update Formula
+        run: |
+          VERSION="${{ steps.release.outputs.version }}"
+          SHA256="${{ steps.release.outputs.sha256 }}"
+          
+          cat > HomebrewFormula/corclient.rb << EOF
+          class Corclient < Formula
+            include Language::Python::Virtualenv
+
+            desc "Internal CLI tool for microservices management and infrastructure administration"
+            homepage "https://github.com/ProjectCORTeam/corcli"
+            url "https://files.pythonhosted.org/packages/source/c/corclient/corclient-${VERSION}.tar.gz"
+            sha256 "${SHA256}"
+            license "MIT"
+
+            depends_on "python@3.11"
+
+            resource "typer" do
+              url "https://files.pythonhosted.org/packages/source/t/typer/typer-0.12.5.tar.gz"
+              sha256 "f592f089bedcc8ec1b974125d64851029c3b1af145f04aca64d69410f0c9b722"
+            end
+
+            resource "rich" do
+              url "https://files.pythonhosted.org/packages/source/r/rich/rich-13.7.1.tar.gz"
+              sha256 "9be308cb1fe2f1f57d67ce99e95af38a1e2bc71ad9813b0e247cf7ffbcc3a432"
+            end
+
+            resource "click" do
+              url "https://files.pythonhosted.org/packages/source/c/click/click-8.1.7.tar.gz"
+              sha256 "ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"
+            end
+
+            resource "flask" do
+              url "https://files.pythonhosted.org/packages/source/f/flask/flask-3.0.3.tar.gz"
+              sha256 "ceb27b0af3823ea2737928a4d99d125a06175b8512c445cbd9a9ce200ef76842"
+            end
+
+            resource "requests" do
+              url "https://files.pythonhosted.org/packages/source/r/requests/requests-2.31.0.tar.gz"
+              sha256 "942c5a758f98d5e85e407a9981bdc7c9f82e2e1b9f8e6c2f4f4f4f4f4f4f4f4f"
+            end
+
+            def install
+              virtualenv_install_with_resources
+            end
+
+            test do
+              assert_match "CoreCLI", shell_output("#{bin}/cor --help")
+            end
+          end
+          EOF
+
+      - name: Commit and push formula
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add HomebrewFormula/corclient.rb
+          git commit -m "chore: update Homebrew formula to ${{ steps.release.outputs.version }}" || echo "No changes to commit"
+          git push

corclient-0.1.0/.github/workflows/pr-title.yml

@@ -0,0 +1,50 @@
+name: "Validate PR title"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.ACTIONS_TOKEN }}
+        with:
+          # Configure which types are allowed.
+          # Default: https://github.com/commitizen/conventional-commit-types
+          types: |
+            fix
+            feat
+            docs
+            ci
+            chore
+          # Configure that a scope must always be provided.
+          requireScope: false
+          # Configure additional validation for the subject based on a regex.
+          # This example ensures the subject starts with an uppercase character.
+          subjectPattern: ^[a-zA-Z].+$
+          # If `subjectPattern` is configured, you can use this property to override
+          # the default error message that is shown when the pattern doesn't match.
+          # The variables `subject` and `title` can be used within the message.
+          subjectPatternError: |
+            The subject "{subject}" found in the pull request title "{title}"
+            didn't match the configured pattern. Please ensure that the subject
+            starts with an uppercase character.
+          # For work-in-progress PRs you can typically use draft pull requests
+          # from Github. However, private repositories on the free plan don't have
+          # this option and therefore this action allows you to opt-in to using the
+          # special "[WIP]" prefix to indicate this state. This will avoid the
+          # validation of the PR title and the pull request checks remain pending.
+          # Note that a second check will be reported if this is enabled.
+          wip: true
+          # When using "Squash and merge" on a PR with only one commit, GitHub
+          # will suggest using that commit message instead of the PR title for the
+          # merge commit, and it's easy to commit this by mistake. Enable this option
+          # to also validate the commit message for one commit PRs.
+          validateSingleCommit: false

corclient-0.1.0/.github/workflows/pypi-release.yaml

@@ -0,0 +1,49 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+  workflow_call:  # Allow being called from other workflows
+  release:
+    types: [published]
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build-and-publish:
+    name: Build and publish package
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch all history and tags for setuptools-scm
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Upgrade pip and install build tooling
+        run: |
+          python -m pip install --upgrade pip
+          pip install --upgrade setuptools wheel build twine
+
+      - name: Build sdist and wheel
+        run: |
+          python -m build
+
+      - name: Verify package metadata
+        run: |
+          twine check dist/*
+
+      - name: Publish to PyPI
+        if: github.event_name == 'workflow_dispatch' || github.event_name == 'release' || startsWith(github.ref, 'refs/tags/v')
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # No password needed - uses OIDC trusted publishing
+          skip-existing: true
+

corclient-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,106 @@
+name: Release
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - beta
+    paths:
+      - '**/*'
+      - '.github/workflows/release.yml'
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    # Skip running release workflow on forks
+    if: github.repository_owner == 'ProjectCORTeam'
+    outputs:
+      new_release_published: ${{ steps.semantic.outputs.new_release_published }}
+      new_release_version: ${{ steps.semantic.outputs.new_release_version }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine ruff black mypy types-requests
+
+      - name: Run linting (Ruff)
+        run: |
+          ruff check corecli/
+
+      - name: Check code formatting (Black)
+        run: |
+          black --check corecli/
+
+      - name: Run type checking (MyPy)
+        run: |
+          mypy corecli/
+
+      - name: Verify package can be built
+        run: |
+          python -m build
+          twine check dist/*
+
+      - name: Clean build artifacts
+        run: |
+          rm -rf dist/ build/ *.egg-info
+
+      - name: Release
+        id: semantic
+        uses: cycjimmy/semantic-release-action@v3
+        env:
+          GITHUB_TOKEN: ${{ secrets.ACTIONS_TOKEN }}
+        with:
+          branches: |
+            [
+              '+([0-9])?(.{+([0-9]),x}).x',
+              'master',
+              'next',
+              'next-major',
+              {
+                name: 'beta',
+                prerelease: true
+              }
+            ]
+          semantic_version: 18.0.0
+          extra_plugins: |
+            @semantic-release/changelog@6.0.0
+            @semantic-release/git@10.0.0
+            conventional-changelog-conventionalcommits@4.6.3
+
+      - name: Do something when a new release published
+        if: steps.semantic.outputs.new_release_published == 'true'
+        run: |
+          echo ${{ steps.semantic.outputs.new_release_version }}
+          echo ${{ steps.semantic.outputs.new_release_major_version }}
+          echo ${{ steps.semantic.outputs.new_release_minor_version }}
+          echo ${{ steps.semantic.outputs.new_release_patch_version }}
+
+      - name: Google Chat Notification
+        uses: nakamuraos/google-chat-notifications@v2.0.1
+        with:
+          title: Release
+          subtitle: ${{ steps.semantic.outputs.new_release_version }}
+          webhookUrl: ${{ secrets.GOOGLE_WEBHOOK }}
+          status: ${{ job.status }}
+        if: always()
+
+  # Publish to PyPI after creating release
+  publish-pypi:
+    name: Publish to PyPI
+    needs: release
+    if: needs.release.outputs.new_release_published == 'true'
+    uses: ./.github/workflows/pypi-release.yaml
+    secrets: inherit

corclient-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

corclient-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.9
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/psf/black
+    rev: 24.1.1
+    hooks:
+      - id: black
+        language_version: python3.11
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-toml
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-requests]

corclient-0.1.0/.releaserc.json

@@ -0,0 +1,30 @@
+{
+  "branches": [
+    "+([0-9])?(.{+([0-9]),x}).x",
+    "master",
+    "next",
+    "next-major",
+    {
+      "name": "beta",
+      "prerelease": true
+    }
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["CHANGELOG.md"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "assets": []
+      }
+    ]
+  ]
+}

corclient-0.1.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 1.0.0 (2025-09-30)
+
+
+### Features
+
+* add linting and code quality tools ([a0a8a28](https://github.com/ProjectCORTeam/corcli/commit/a0a8a28f310005ddc3de4bf3dcb11c2722f2faf8))
+* add linting and code quality tools ([e5ee76d](https://github.com/ProjectCORTeam/corcli/commit/e5ee76d89a853f83b6681c30756c0207b34aa469))
+* configure semantic-release for Python project ([6944590](https://github.com/ProjectCORTeam/corcli/commit/6944590667bf498fea5c9938b35b3a16659f40cc))
+* configure semantic-release for Python with setuptools-scm ([b43fea1](https://github.com/ProjectCORTeam/corcli/commit/b43fea15f4d658f2cc8209a42ef770a86f257494))
+* initial version ([deac096](https://github.com/ProjectCORTeam/corcli/commit/deac0960690fdf43208efcd893472ce3f95283ee))

corclient-0.1.0/HOMEBREW.md

@@ -0,0 +1,196 @@
+# Homebrew Distribution Guide
+
+This guide explains how to install `corclient` via Homebrew using the same repository as a custom Tap.
+
+## 🍺 Installation
+
+### For Users
+
+Users can install `corclient` directly from this repository:
+
+```bash
+# Add the tap (one-time setup)
+brew tap ProjectCORTeam/corcli https://github.com/ProjectCORTeam/corcli.git
+
+# Install corclient
+brew install corclient
+
+# Or in one command
+brew install ProjectCORTeam/corcli/corclient
+```
+
+### Update
+
+```bash
+brew update
+brew upgrade corclient
+```
+
+### Uninstall
+
+```bash
+brew uninstall corclient
+brew untap ProjectCORTeam/corcli
+```
+
+## 🔧 How It Works
+
+This repository serves dual purposes:
+1. **Source code repository** - Contains the Python package code
+2. **Homebrew Tap** - Contains Homebrew formulae in `HomebrewFormula/`
+
+When users tap this repository, Homebrew looks for formulae in the `HomebrewFormula/` directory.
+
+## 🚀 Automated Updates
+
+The workflow `.github/workflows/homebrew-formula.yaml` automatically:
+
+1. **Triggers when a GitHub Release is published**
+2. **Downloads the tarball from PyPI**
+3. **Calculates the SHA256 hash**
+4. **Updates the Homebrew formula** in `HomebrewFormula/corclient.rb`
+5. **Commits and pushes to the repository**
+
+No separate repository needed!
+
+## 📦 Manual Formula Update
+
+If you need to manually update the formula:
+
+```bash
+# 1. Get the version and tarball
+VERSION="1.0.0"
+wget "https://files.pythonhosted.org/packages/source/c/corclient/corclient-${VERSION}.tar.gz"
+
+# 2. Calculate SHA256
+SHA256=$(sha256sum corclient-${VERSION}.tar.gz | awk '{print $1}')
+
+# 3. Update HomebrewFormula/corclient.rb
+# Replace the url and sha256 values
+
+# 4. Test the formula
+brew install --build-from-source ./HomebrewFormula/corclient.rb
+
+# 5. Commit and push
+git add HomebrewFormula/corclient.rb
+git commit -m "chore: update Homebrew formula to ${VERSION}"
+git push
+```
+
+## 🧪 Testing
+
+### Local Testing
+
+```bash
+# Test installation from local formula
+brew install --build-from-source ./HomebrewFormula/corclient.rb
+
+# Verify it works
+cor --help
+
+# Run formula audit
+brew audit --strict ./HomebrewFormula/corclient.rb
+
+# Test uninstall
+brew uninstall corclient
+```
+
+### Test the Tap
+
+```bash
+# Add your local repo as a tap
+brew tap ProjectCORTeam/corcli /Users/carlos/Documents/04-Repositories/COR/corcli-cli
+
+# Install from the tap
+brew install corclient
+
+# Test
+cor --help
+
+# Clean up
+brew uninstall corclient
+brew untap ProjectCORTeam/corcli
+```
+
+## 📝 Repository Structure
+
+```
+corcli/
+├── corecli/                          # Python package source
+├── HomebrewFormula/                  # Homebrew formulae directory
+│   └── corclient.rb                  # Homebrew formula
+├── .github/workflows/
+│   ├── pypi-release.yaml            # PyPI publication
+│   ├── homebrew-formula.yaml        # Auto-update Homebrew formula
+│   └── release.yaml                 # Semantic release
+├── pyproject.toml                   # Python package config
+└── README.md                        # Main documentation
+```
+
+## 🔍 Troubleshooting
+
+### Formula Not Found
+
+```bash
+# Re-add the tap
+brew untap ProjectCORTeam/corcli
+brew tap ProjectCORTeam/corcli https://github.com/ProjectCORTeam/corcli.git
+```
+
+### Installation Fails
+
+1. Check Python version: `brew info python@3.11`
+2. Clear cache: `brew cleanup`
+3. Try with verbose output: `brew install corclient --verbose`
+
+### Version Not Updating
+
+```bash
+# Force update the tap
+brew update
+brew upgrade corclient
+
+# Or reinstall
+brew reinstall corclient
+```
+
+## 📚 Adding the Tap to README
+
+Add this section to your main README.md:
+
+```markdown
+### Install via Homebrew
+
+\`\`\`bash
+# Add the tap
+brew tap ProjectCORTeam/corcli https://github.com/ProjectCORTeam/corcli.git
+
+# Install
+brew install corclient
+\`\`\`
+
+### Update
+
+\`\`\`bash
+brew update
+brew upgrade corclient
+\`\`\`
+```
+
+## 🎯 Advantages of Single Repository
+
+✅ **Simplified maintenance** - One repository to manage
+✅ **Synchronized versioning** - Formula updates with releases
+✅ **Automatic updates** - Workflow handles everything
+✅ **No extra setup** - No separate tap repository needed
+✅ **Single source of truth** - Code and distribution in one place
+
+## 🔗 Resources
+
+- [Homebrew Taps](https://docs.brew.sh/Taps)
+- [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook)
+- [Python Formula Guide](https://docs.brew.sh/Python-for-Formula-Authors)
+
+---
+
+**Note**: The formula directory MUST be named `HomebrewFormula/` (or `Formula/`) for Homebrew to recognize it as a tap.

corclient-0.1.0/HomebrewFormula/corclient.rb

@@ -0,0 +1,39 @@
+class Corclient < Formula
+  include Language::Python::Virtualenv
+
+  desc "Internal CLI tool for microservices management and infrastructure administration"
+  homepage "https://github.com/ProjectCORTeam/corcli"
+  url "https://files.pythonhosted.org/packages/source/c/corclient/corclient-VERSION.tar.gz"
+  sha256 "SHA256_HASH"
+  license "MIT"
+
+  depends_on "python@3.11"
+
+  resource "typer" do
+    url "https://files.pythonhosted.org/packages/source/t/typer/typer-0.12.0.tar.gz"
+    sha256 "TODO: Add actual hash"
+  end
+
+  resource "rich" do
+    url "https://files.pythonhosted.org/packages/source/r/rich/rich-13.7.0.tar.gz"
+    sha256 "TODO: Add actual hash"
+  end
+
+  resource "flask" do
+    url "https://files.pythonhosted.org/packages/source/f/flask/flask-3.0.0.tar.gz"
+    sha256 "TODO: Add actual hash"
+  end
+
+  resource "requests" do
+    url "https://files.pythonhosted.org/packages/source/r/requests/requests-2.31.0.tar.gz"
+    sha256 "TODO: Add actual hash"
+  end
+
+  def install
+    virtualenv_install_with_resources
+  end
+
+  test do
+    assert_match "CoreCLI", shell_output("#{bin}/cor --help")
+  end
+end

corclient-0.1.0/Makefile

@@ -0,0 +1,52 @@
+.PHONY: help install install-dev lint format type-check test build clean
+
+help:
+	@echo "Available commands:"
+	@echo "  make install      - Install package"
+	@echo "  make install-dev  - Install package with dev dependencies"
+	@echo "  make lint         - Run ruff linter"
+	@echo "  make format       - Format code with black"
+	@echo "  make format-check - Check code formatting without modifying"
+	@echo "  make type-check   - Run mypy type checker"
+	@echo "  make test         - Run tests"
+	@echo "  make build        - Build package"
+	@echo "  make clean        - Clean build artifacts"
+	@echo "  make all          - Run linting, formatting check, type check, and build"
+
+install:
+	pip install -e .
+
+install-dev:
+	pip install -e ".[dev]"
+	pip install pre-commit
+	pre-commit install
+
+lint:
+	ruff check corecli/
+
+lint-fix:
+	ruff check --fix corecli/
+
+format:
+	black corecli/
+
+format-check:
+	black --check corecli/
+
+type-check:
+	mypy corecli/
+
+test:
+	pytest tests/ -v
+
+build:
+	python -m build
+	twine check dist/*
+
+clean:
+	rm -rf dist/ build/ *.egg-info
+	find . -type d -name __pycache__ -exec rm -rf {} +
+	find . -type f -name '*.pyc' -delete
+
+all: lint format-check type-check build
+	@echo "✅ All checks passed!"