badgeshield 0.1.0__tar.gz

badgeshield-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,116 @@
+# ==============================================================================
+# 🚢 Release Workflow — Project Caller
+# ==============================================================================
+# Save this file in YOUR PROJECT repo at:
+#   .github/workflows/release.yml
+#
+# TRIGGERS & JOB MATRIX:
+#
+#   Event            │ docs │ publish
+#   ─────────────────┼──────┼────────
+#   Push to main     │  ✅  │   ⛔
+#   Push tag X.X.X   │  ⛔  │   ✅
+#   Manual dispatch  │  ✅  │   ⛔
+#
+# PUBLISH TARGET FLAG (controls where the package is published):
+#
+#   publish-target: 'both'     → TestPyPI first, then PyPI  ← default
+#   publish-target: 'pypi'     → PyPI only
+#   publish-target: 'testpypi' → TestPyPI only
+#
+# RELEASE FLOW:
+#   1. Merge PRs to main as normal — docs deploy automatically
+#   2. When ready to release, push a bare SemVer tag:
+#        git tag 1.2.1
+#        git push origin 1.2.1
+#   3. The publish job runs: validate → test → build → testpypi → pypi
+#
+# SECRETS REQUIRED (Settings → Secrets and variables → Actions):
+#   TEST_PYPI_API_TOKEN  — from test.pypi.org/manage/account/token/
+#   PYPI_API_TOKEN       — from pypi.org (only if not using Trusted Publishing)
+#
+# PRE-REQUISITES (once per project):
+#
+#   1. Enable GitHub Pages:
+#      Settings → Pages → Source → GitHub Actions
+#
+#   2. Create GitHub Environments:
+#      Settings → Environments → New environment
+#        - "pypi"      (real PyPI — add Required reviewers for safety)
+#        - "test-pypi" (TestPyPI sandbox — no reviewers needed)
+#
+#   3. Register Trusted Publisher on pypi.org:
+#      pypi.org → your project → Publishing → Add publisher
+#        owner    = vertex-ai-automations
+#        repo     = THIS-REPO-NAME
+#        workflow = release.yml
+#        env      = pypi
+#
+#   4. Create docs/requirements.txt:
+#        mkdocs-material==9.5.18
+#        mkdocstrings[python]==0.24.3
+#
+# CUSTOMISE PER PROJECT:
+#   python-version   — match your project's Python version
+#   test-command     — your test runner command
+#   publish-target   — 'both' | 'pypi' | 'testpypi'
+#   src-layout       — true if you use a src/ directory layout
+#   mkdocs-strict    — false to allow doc build warnings
+# ==============================================================================
+
+name: 🚢 Release
+
+on:
+  push:
+    branches:
+      - main          # Docs deploy only
+    tags:
+      - "*.*.*"       # Publish only — bare SemVer e.g. 1.2.1
+  workflow_dispatch:  # Manual trigger — docs only
+
+jobs:
+
+  # ============================================================
+  # 📚 Deploy MkDocs to GitHub Pages
+  # Runs on: push to main, manual dispatch
+  # ============================================================
+  docs:
+    name: 📚 Deploy Docs
+    uses: vertex-ai-automations/shared-workflows/.github/workflows/publish-mkdocs.yml@main
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    with:
+      python-version: "3.11"
+      docs-requirements: "docs/requirements.txt"
+      src-layout: true       # ← set false if not using src/ layout
+      mkdocs-strict: true    # ← set false to allow doc build warnings
+    secrets: inherit
+
+  # ============================================================
+  # 📦 Build and Publish Package
+  # Runs on: tag push only (tag guard is enforced inside the
+  # reusable workflow — non-tag pushes skip cleanly)
+  #
+  # publish-target controls which registries receive the package:
+  #   'both'     → TestPyPI first, then PyPI (recommended)
+  #   'pypi'     → PyPI only
+  #   'testpypi' → TestPyPI only
+  #
+  # No permissions block needed — declared inside python-publish.yml
+  # ============================================================
+  publish:
+    name: 📦 Publish Package
+    uses: vertex-ai-automations/shared-workflows/.github/workflows/python-publish.yml@main
+    permissions:
+      contents: read
+      id-token: write
+    with:
+      python-version: "3.11"
+      run-tests: true
+      test-command: "pytest tests/ -v --tb=short"
+      publish-target: "pypi"          # 'both' | 'pypi' | 'testpypi'
+      use-trusted-publishing: false    # set false to use PYPI_API_TOKEN instead
+    secrets: inherit
+

badgeshield-0.1.0/.gitignore

@@ -0,0 +1,190 @@
+# Derived from basic .gitignore template for python projects:
+#   https://github.com/github/gitignore/blob/main/Python.gitignore
+# Please maintain the alphabetic order of the section titles
+# To debug why a file is being ignored, use the command:
+#    git check-ignore -v $my_ignored_file
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Cython debug symbols
+cython_debug/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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
+
+# Django stuff
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Flask stuff
+instance/
+.webassets-cache
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Jupyter Notebook
+*.ipynb_checkpoints
+
+# mkdocs documentation
+/site
+
+# Model saving / checkpointing
+*.pt
+*.pth
+*.ckpt
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# PyBuilder
+.pybuilder/
+target/
+
+# 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/
+
+# 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
+
+# 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
+
+# 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
+
+# PEP 582: https://peps.python.org/pep-0582/
+#   This PEP proposes to add to Python a mechanism to automatically recognize a __pypackages__
+#   directory and prefer importing packages installed in this location over user or global site-packages.
+#   This will avoid the steps to create, activate or deactivate virtual environments. Python will use
+#   the __pypackages__ from the base directory of the script when present.
+__pypackages__/
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Rope project settings
+.ropeproject
+
+# SageMath parsed files
+*.sage.py
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/build
+# sphinx-gallery
+docs/source/generated_examples/
+docs/source/gen_modules/
+docs/source/generated/
+docs/source/sg_execution_times.rst
+# pytorch-sphinx-theme gets installed here
+docs/src
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# System / program generated files
+*.err
+*.log
+*.swp
+.DS_Store
+
+# Translations
+*.mo
+*.pot
+
+# TorchX
+*.torchxconfig
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# VSCode
+.vscode/
+
+# wandb
+wandb/
+.worktrees/

badgeshield-0.1.0/CLAUDE.md

@@ -0,0 +1,86 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+**badgeshield** is a Python package for generating customizable SVG badges. It supports 5 templates (DEFAULT, CIRCLE, CIRCLE_FRAME, PILL, BANNER), 4 visual styles, 51 predefined colors, logo embedding, batch processing, and both a programmatic API and CLI.
+
+## Commands
+
+### Testing
+```bash
+pytest tests/ -v --tb=short
+# Run a single test file
+pytest tests/test_badge_generator.py -v
+# Run a single test
+pytest tests/test_badge_generator.py::test_name -v
+```
+
+### Documentation
+```bash
+mkdocs build    # Build docs
+mkdocs serve    # Serve docs locally
+```
+
+### Install for development
+```bash
+pip install -e .
+pip install -r requirements.txt
+```
+
+### CLI usage
+```bash
+badgeshield single --left_text "Build" --left_color GREEN --badge_name build_badge.svg
+badgeshield single --left_text "Status" --left_color "#555555" --badge_name s.svg --style gradient
+badgeshield batch config.json --output_path ./badges/ --style rounded
+badgeshield coverage coverage.xml --badge_name coverage.svg --metric line
+badgeshield audit badge.svg          # check SVG for external URL references
+badgeshield audit badge.svg --json   # machine-readable output
+```
+
+Note: `badge_name` must always end with `.svg`. The `--style` option accepts `FLAT | ROUNDED | GRADIENT | SHADOWED` (case-insensitive; defaults to `flat`). Per-entry `style` keys in batch JSON take priority over the CLI flag.
+
+## Architecture
+
+### Source layout (`src/badgeshield/`)
+
+- **`badge_generator.py`**: Two main classes:
+  - `BadgeBatchGenerator`: Concurrent badge generation via `ThreadPoolExecutor`. Aggregates failures and raises `RuntimeError` with a summary if any badge fails.
+  - `BadgeGenerator`: Core SVG generation. Uses Jinja2 to render templates. Text width is calculated using Pillow's `ImageFont` (DejaVuSans.ttf) with a character-width dict fallback. Logo images are base64-embedded and can be color-tinted by converting to RGBA and applying the tint while preserving alpha.
+
+- **`generate_badge_cli.py`**: Typer + Rich CLI with four subcommands: `single`, `batch`, `coverage`, and `audit`. Enum validation (template, frame, style, log_level) is done at CLI entry before calling `BadgeGenerator`. The `batch` command shows a Rich progress bar and summary table; failures exit with code 1. The `audit` command scans an SVG for external `http`/`https` URLs in attributes and inline styles.
+
+- **`coverage.py`**: Two standalone functions — `parse_coverage_xml(path, metric)` reads `line-rate` or `branch-rate` from a `coverage.xml` produced by `coverage run`, returning a float 0–100; `coverage_color(pct)` maps the percentage to a hex color. The `coverage` CLI subcommand wires these together to produce a DEFAULT-template badge.
+
+- **`utils.py`**: Four enums — `BadgeColor` (51 colors), `FrameType` (11 PNG frames), `BadgeTemplate` (5 templates), `BadgeStyle` (FLAT/ROUNDED/GRADIENT/SHADOWED). These are the canonical type-safe inputs for the generator.
+
+- **`templates/`**: Jinja2 SVG templates with autoescape enabled.
+  - `label.svg` — DEFAULT: two-part horizontal badge, dynamic width, optional logo and links
+  - `circle.svg` — CIRCLE: circle with font-size scaling based on text length
+  - `circle_frame.svg` — CIRCLE_FRAME: circle overlaid with a PNG frame asset; requires `FrameType`
+  - `pill.svg` — PILL: fully rounded ends (rx=10 always), always uses style_ctx but overrides `rx`
+  - `banner.svg` — BANNER: fixed icon-zone on left (28px) + right text section
+
+### Public API (`from badgeshield import ...`)
+
+`BadgeGenerator`, `BadgeBatchGenerator`, `BadgeColor`, `BadgeTemplate`, `BadgeStyle`, `FrameType`, `LogLevel`, `parse_coverage_xml`, `coverage_color`
+
+### Batch JSON config format
+
+The JSON file passed to `batch` must be a list of objects, each with the same keys as `BadgeGenerator.generate_badge` kwargs. Required keys per entry: `left_text`, `left_color`, `badge_name` (ending in `.svg`). The `output_path` and `template` are supplied via CLI flags, not in the JSON. An optional `style` key per entry (string, case-insensitive) overrides the CLI `--style` flag for that badge.
+
+### Key design decisions
+
+- **Versioning**: `setuptools_scm` derives version from git tags (format `X.X.X`). The `_version.py` file is auto-generated — do not edit it manually.
+- **Logging**: Uses `pylogshield` (`get_logger`), not stdlib `logging`. Log level can be passed as `LogLevel` enum or string.
+- **Color input**: Accepts either a `BadgeColor` enum member or a hex string (`#RRGGBB`). Validation is done via `is_valid_hex_color()` and `validate_color()` in `badge_generator.py`.
+- **Pillow is optional**: Only `jinja2` and `pylogshield` are required (`requirements.txt`). If Pillow is not installed, text width falls back to a char-width heuristic dict and logo tinting is silently skipped. Install the extras group for accurate text sizing: `pip install badgeshield[image]`.
+- **CIRCLE_FRAME template**: Requires `frame` parameter (a `FrameType` enum); it is not optional for that template.
+- **Renderer dispatch**: `BadgeGenerator._RENDERERS` is a class-level dict mapping `BadgeTemplate` → `_render_*` method, populated after the class body. To add a new template, add a `_render_<name>` method and register it in `_RENDERERS`.
+- **Style system**: `_style_context()` returns a dict of Jinja2 context vars (`rx`, `gradient_id`, `gradient_stop`, `gradient_base`, `shadow_id`). Templates that don't support gradient (e.g. CIRCLE_FRAME) clear gradient keys after calling `_style_context`. PILL always forces `rx="10"` regardless of style.
+
+### CI/CD (`.github/workflows/release.yml`)
+
+- **Docs job**: Triggers on push to `main` or manual dispatch — deploys MkDocs to GitHub Pages.
+- **Publish job**: Triggers on tag push matching `X.X.X` — runs tests, builds, then publishes to TestPyPI then PyPI using GitHub OIDC trusted publishing.

badgeshield-0.1.0/LICENSE.txt

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