cloudmesh-ai-theme 7.0.1__py3-none-any.whl

cloudmesh_ai_theme/__init__.py

@@ -0,0 +1,29 @@
+from importlib.metadata import version, PackageNotFoundError
+from pathlib import Path
+
+def get_version():
+    # 1. Try to read from VERSION file in the package root (installed)
+    try:
+        version_file = Path(__file__).parent / "VERSION"
+        if version_file.exists():
+            return version_file.read_text().strip()
+    except Exception:
+        pass
+
+    # 2. Try to read from VERSION file in the project root (development)
+    try:
+        # __file__ is .../src/cloudmesh_ai_theme/__init__.py
+        # Project root is two levels up from src/
+        project_root_version = Path(__file__).parent.parent.parent / "VERSION"
+        if project_root_version.exists():
+            return project_root_version.read_text().strip()
+    except Exception:
+        pass
+
+    # 3. Fallback to importlib.metadata
+    try:
+        return version("cloudmesh-ai-theme")
+    except PackageNotFoundError:
+        return "0.0.0"
+
+__version__ = get_version()

cloudmesh_ai_theme/assets/favicon.svg

@@ -0,0 +1,48 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" width="512" height="512">
+  <defs>
+    <linearGradient id="cloudBlue" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" stop-color="#1e90ff"/>
+      <stop offset="100%" stop-color="#006dff"/>
+    </linearGradient>
+
+    <filter id="shadow" x="-50%" y="-50%" width="200%" height="200%">
+      <feDropShadow dx="0" dy="8" stdDeviation="16" flood-color="#000000" flood-opacity="0.18"/>
+    </filter>
+  </defs>
+
+  <!-- Transparent Background -->
+  <rect width="512" height="512" fill="transparent"/>
+
+  <!-- Cloud -->
+  <g filter="url(#shadow)">
+    <path
+      d="
+        M95 400
+        H417
+        C470 400 502 362 502 307
+        C502 258 468 223 423 223
+        H405
+        C390 138 326 92 255 92
+        C182 92 124 140 105 205
+        C53 210 18 248 18 305
+        C18 362 48 400 95 400
+        Z
+      "
+      fill="url(#cloudBlue)"
+    />
+  </g>
+
+  <!-- Perfectly Centered AI -->
+  <text
+    x="230"
+    y="285"
+    text-anchor="middle"
+    dominant-baseline="middle"
+    font-family="Arial, Helvetica, sans-serif"
+    font-size="245"
+    font-weight="900"
+    fill="#ffffff"
+    letter-spacing="-18">
+    AI
+  </text>
+</svg>

cloudmesh_ai_theme/css/custom.css

@@ -0,0 +1,11 @@
+.doc-object { 
+    border: 1px solid rgba(0, 0, 0, 0.2) !important; 
+    border-radius: 4px !important; 
+    padding: 0.5rem !important; 
+    margin: 0.5rem 0 !important; 
+    background-color: var(--md-code-bg-color, #ffffff) !important;
+}
+
+[data-md-color-scheme="slate"] .doc-object {
+    border: 1px solid rgba(255, 255, 255, 0.2) !important;
+}

cloudmesh_ai_theme/plugin.py

@@ -0,0 +1,64 @@
+from mkdocs.plugins import BasePlugin
+from mkdocs.config import config_options
+
+
+class CloudmeshAIThemePlugin(BasePlugin):
+    """
+    Clean MkDocs plugin:
+    - Injects branding defaults
+    - Configures theme safely
+    - Does NOT modify filesystem
+    """
+
+    config_scheme = (
+        ("primary_color", config_options.Type(str, default="#1e90ff")),
+        ("logo", config_options.Type(str, default=None)),
+        ("favicon", config_options.Type(str, default=None)),
+        ("inject_css", config_options.Type(bool, default=True)),
+    )
+
+    def on_config(self, config):
+        theme = config.get("theme")
+
+        if not theme:
+            config["theme"] = {}
+            theme = config["theme"]
+
+        # Ensure Material theme baseline
+        theme["name"] = theme.get("name", "material")
+
+        # Branding defaults
+        if self.config["logo"]:
+            theme["logo"] = self.config["logo"]
+
+        if self.config["favicon"]:
+            theme["favicon"] = self.config["favicon"]
+
+        # Inject palette safely (do not overwrite user config)
+        theme.setdefault("palette", [
+            {
+                "scheme": "default",
+                "primary": self.config["primary_color"],
+                "accent": self.config["primary_color"],
+                "toggle": {
+                    "icon": "brightness-7",
+                    "name": "Switch to dark mode",
+                },
+            },
+            {
+                "scheme": "slate",
+                "primary": self.config["primary_color"],
+                "accent": self.config["primary_color"],
+                "toggle": {
+                    "icon": "brightness-4",
+                    "name": "Switch to light mode",
+                },
+            },
+        ])
+
+        # Inject CSS via MkDocs native mechanism
+        if self.config["inject_css"]:
+            config.setdefault("extra_css", [])
+            config["extra_css"].append("cloudmesh_ai_theme/custom.css")
+
+        return config

cloudmesh_ai_theme/theme/main.html

@@ -0,0 +1,30 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+  {{ super() }}
+  <link rel="stylesheet" href="{{ path.rel_path('theme/custom.css') }}">
+  {% if theme.primary_color %}
+  <style>
+    :root {
+      --md-primary-color: {{ theme.primary_color }};
+    }
+  </style>
+  {% endif %}
+{% endblock %}
+
+{% block site_name %}
+  <a href="{{ 'home'|url }}" class="site-title">
+    {% if theme.logo %}
+      <img src="{{ theme.logo }}" alt="Logo">
+    {% else %}
+      Cloudmesh AI
+    {% endif %}
+  </a>
+{% endblock %}
+
+{% block footer %}
+  {{ super() }}
+  <div class="footer-branding" style="text-align: center; padding: 1em; font-size: 0.8em; opacity: 0.7;">
+    &copy; {{ now().year }} Cloudmesh AI. All rights reserved.
+  </div>
+{% endblock %}

cloudmesh_ai_theme/theme.yml

@@ -0,0 +1 @@
+base_theme: material

cloudmesh_ai_theme-7.0.1.dist-info/METADATA

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: cloudmesh-ai-theme
+Version: 7.0.1
+Summary: Theme for Cloudmesh AI documentation
+Author: Cloudmesh AI Contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/cloudmesh/cloudmesh-ai-theme
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: mkdocs
+
+# Cloudmesh AI Theme Guide
+
+Welcome to the guide for the **Cloudmesh AI Theme**. This package provides a consistent look and feel for Cloudmesh AI project documentation, built as an extension of the Material for MkDocs theme.
+
+## Table of Contents
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage-guide)
+  - [Primary Method (Recommended)](#primary-method-recommended)
+  - [Configuration Options](#configuration-options)
+  - [Alternative: Manual Asset Deployment](#alternative-manual-asset-deployment)
+- [Development & Contribution](#development--contribution)
+  - [Local Development](#local-development)
+  - [Running Tests](#running-tests)
+- [Maintainer's Guide](#maintainers-guide)
+  - [Project Structure](#project-structure)
+  - [Version Management](#version-management)
+  - [Release Process](#release-process)
+
+---
+
+## Introduction
+
+The `cloudmesh-ai-theme` is a Python package that provides branding for Cloudmesh AI documentation. Instead of copying CSS and images into every project, this package allows you to apply the theme via a configuration change in your `mkdocs.yml`.
+
+It automatically handles:
+- **Branding**: Injects the "Cloudmesh AI" site name and a standardized footer.
+- **Styling**: Applies custom CSS.
+- **Assets**: Provides shared logos and favicons.
+
+---
+
+## Installation
+
+The theme is distributed as a Python package. You can install it using `pip`:
+
+```bash
+pip install cloudmesh-ai-theme
+```
+
+---
+
+## Usage
+
+### Primary Method (Recommended)
+
+The simplest way to use the theme is to specify it by name in your `mkdocs.yml` file. This method automatically applies all branding, styles, and assets.
+
+```yaml
+theme:
+  name: cloudmesh-ai-theme
+```
+
+### Configuration Options
+
+You can customize the theme while maintaining the Cloudmesh AI layout. Currently, the following options are supported:
+
+#### `primary_color`
+Change the primary accent color of the theme.
+```yaml
+theme:
+  name: cloudmesh-ai-theme
+  primary_color: "#ff0000" # Example: Red
+```
+
+#### `logo` and `favicon`
+You can override the default Cloudmesh AI logo and favicon by specifying their paths in your `mkdocs.yml`. SVG favicons are recommended for better scalability and quality.
+```yaml
+theme:
+  name: cloudmesh-ai-theme
+  logo: assets/my-logo.png
+  favicon: assets/my-favicon.svg
+```
+
+### Alternative: Manual Asset Deployment
+
+If you need direct access to the CSS and image files within your project directory (e.g., for further local overrides), you can deploy the assets manually.
+
+1. **Run the deployment command**:
+   ```bash
+   cloudmesh-ai-theme-install
+   ```
+   This will copy the assets into `docs/theme/` in your current project.
+
+2. **Reference assets in `mkdocs.yml`**:
+   ```yaml
+   extra_css:
+     - theme/custom.css
+
+   theme:
+     favicon: theme/assets/favicon.svg
+     logo: theme/assets/logo-white.png
+     name: material
+   ```
+
+---
+
+## Development & Contribution
+
+### Local Development
+
+To make changes to the theme and see them reflected in your projects immediately, install the package in editable mode:
+
+```bash
+cd cloudmesh-ai-theme
+pip install -e .
+```
+
+### Running Tests
+
+The theme includes a verification suite to ensure that the package builds and renders correctly.
+
+```bash
+cd cloudmesh-ai-theme/tests
+python test_theme.py
+```
+
+---
+
+## Maintainer's Guide
+
+### Project Structure
+
+```text
+cloudmesh-ai-theme/
+├── .github/workflows/  # CI/CD pipelines
+├── src/
+│   └── cloudmesh_ai_theme/
+│       ├── __init__.py  # Package logic & versioning
+│       ├── assets/      # Logos and favicons
+│       ├── css/         # Custom stylesheets
+│       └── theme/       # MkDocs templates (main.html)
+├── tests/              # Verification suite
+├── VERSION             # Single source of truth for version
+├── pyproject.toml      # Build system & metadata
+└── README.md           # This guide
+```
+
+### Version Management
+
+The version is managed in the `VERSION` file at the root of the repository. To bump the version:
+1. Edit the `VERSION` file (e.g., change `0.1.0` to `0.1.1`).
+2. Commit the change:
+   ```bash
+   git add VERSION
+   git commit -m "Bump version to 0.1.1"
+   ```
+
+### Release Process
+
+Releases are automated via GitHub Actions. To trigger a new release:
+1. Create a git tag following the `v*` pattern:
+   ```bash
+   git tag v0.1.0
+   git push origin v0.1.0
+   ```
+2. The GitHub Action will automatically build the `.whl` and `.tar.gz` distributions and upload them as artifacts.
+
+#### Publishing to PyPI
+
+The easiest way to upload the package to PyPI is using the provided `Makefile`:
+
+```bash
+make pypi
+```
+
+This command automatically installs the necessary build tools, builds the distribution, and uploads it to PyPI using `twine`.
+
+**Manual Upload (without Makefile):**
+1. Install build tools:
+   ```bash
+   pip install build twine
+   ```
+2. Build the distribution:
+   ```bash
+   python -m build
+   ```
+3. Upload to PyPI:
+   ```bash
+   python -m twine upload dist/*
+   ```
+
+**Automated Upload (GitHub Actions):**
+To automate publishing, add a `pypi-publish` step to the `.github/workflows/release.yml` file and configure a `PYPI_API_TOKEN` in your GitHub repository secrets.

cloudmesh_ai_theme-7.0.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+cloudmesh_ai_theme/__init__.py,sha256=cOfMm5NKT3RNNsIdF1Plm6trcQkNge2bwEoX6oInxw4,953
+cloudmesh_ai_theme/plugin.py,sha256=EhOcwBKTsy57VDxRwd6mhVMpmZfUXepmIenyB-kR4zo,1984
+cloudmesh_ai_theme/theme.yml,sha256=U7XjlFg2874RqIF5klDrH9g1Y2nJIu8g2S2dJHewxQg,20
+cloudmesh_ai_theme/assets/favicon copy.ico,sha256=tucsh653IAXPoED-dJC1nCjiSDT_xsjZyPQbdwC9TCU,8147
+cloudmesh_ai_theme/assets/favicon.svg,sha256=cPv3SmvO27aVZ9VUqPlgwovI01dlk7YAL9IUbyEM-eI,1205
+cloudmesh_ai_theme/assets/logo-white.png,sha256=fyWFcQVO32E0XOJ3-sBOdq8UcwbVqlgoIsGGvkk_W6A,12448
+cloudmesh_ai_theme/css/custom.css,sha256=tdJyHtidi1A8kdjqECJZ8HwWygvpJI8VoPRKnRsoGiA,348
+cloudmesh_ai_theme/theme/main.html,sha256=iHcWKL8ggcDozvpY9wjBdQSCioePzEvOi0-FbmSR_KU,733
+cloudmesh_ai_theme-7.0.1.dist-info/METADATA,sha256=vPKWWPFiG6W6DOgNv-DG4Ni-OP9EnBxDPHr_hJPXP6Q,5695
+cloudmesh_ai_theme-7.0.1.dist-info/WHEEL,sha256=YLJXdYXQ2FQ0Uqn2J-6iEIC-3iOey8lH3xCtvFLkd8Q,91
+cloudmesh_ai_theme-7.0.1.dist-info/entry_points.txt,sha256=D4tjbJpNUbyIp7g8otJPfTDuuclf1sy9D5QYnzHIb6U,169
+cloudmesh_ai_theme-7.0.1.dist-info/top_level.txt,sha256=ZjhIWObUVQ8d6lu2QiMTcS4blgiZq34XkdXo-LZ86VA,19
+cloudmesh_ai_theme-7.0.1.dist-info/RECORD,,

cloudmesh_ai_theme-7.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (81.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cloudmesh_ai_theme-7.0.1.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+cloudmesh-ai-theme-install = cloudmesh_ai_theme:install_assets
+
+[mkdocs.plugins]
+cloudmesh-ai-theme = cloudmesh_ai_theme.plugin:CloudmeshAIThemePlugin

cloudmesh_ai_theme-7.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+cloudmesh_ai_theme