FORGE-X: Upload source (a71cef49-api.zip)

README.md

@@ -1,13 +1,98 @@
 ---
-title: Docker Kubernetes Document Generation Api A71c
-emoji: 💻
-colorFrom: green
+title: "Docker & Kubernetes Document Generation API"
+emoji: 🤖
+colorFrom: blue
 colorTo: gray
 sdk: gradio
-sdk_version: 6.14.0
-python_version: '3.13'
+sdk_version: 4.44.0
 app_file: app.py
 pinned: false
+license: mit
+tags:
+  - docker
+  - kubernetes
+  - container
+  - devops
+  - data
+  - validation
+  - enrichment
+  - document
+  - generation
+  - docker-kubernetes
 ---
+# Docker & Kubernetes Document Generation API
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Stop wrestling with outdated READMEs and inconsistent deployment docs. If you're tired of manually syncing your Dockerfiles and Kubernetes manifests with documentation that's always behind, this API automates the entire document generation process.
+
+The Docker & Kubernetes Document Generation API solves the pain of creating and maintaining accurate documentation for containerized environments. It parses your actual Dockerfiles, docker-compose files, and Kubernetes YAMLs to produce structured, up-to-date documents—eliminating manual errors and saving hours per project. Unlike generic doc tools, this is built specifically for Docker and Kubernetes workflows, ensuring every exposed port, environment variable, and volume mount is captured.
+
+## What's Included
+
+- Auto-generates detailed, structured documentation from Dockerfiles and docker-compose.yml inputs
+- Parses Kubernetes manifests (Deployments, Services, ConfigMaps, etc.) to produce resource-specific documentation
+- Supports multiple output formats: Markdown, PDF, and HTML for easy sharing and integration
+- REST API endpoint designed for CI/CD pipelines—trigger doc generation on each deployment
+- Customizable templates to match your team's documentation standards and branding
+
+## Who Is This For
+
+- DevOps engineers who need up-to-date docs for multiple microservices without manual effort
+- Platform teams building internal developer portals that require automated documentation generation
+- Technical writers supporting Kubernetes deployments who want to focus on high-level guides, not low-level YAML details
+- Startups and SMBs with small teams that can't afford to spend hours documenting every container change
+
+## How It Works
+
+Simply send your Dockerfile and/or Kubernetes YAML files to our REST API endpoint via curl or your favorite HTTP client. The API parses the content, extracts key information (environment variables, ports, resources, etc.), and returns a structured document in your chosen format. Integrate the call into your deployment pipeline to ensure documentation is regenerated on every update.
+
+## Frequently Asked Questions
+
+**Does the API support multi-container applications like those defined in docker-compose?**
+Yes, the API natively parses docker-compose.yml files and documents all services, networks, and volumes defined in them.
+
+**Can I customize the output to match my team's documentation style guide?**
+Absolutely. You can provide a custom template (in JSON) with your own headers, ordering, and formatting. The API uses sensible defaults if no template is provided.
+
+**How does the API handle sensitive data like secrets or passwords in Kubernetes manifests?**
+The API automatically redacts values from Secret resources and ConfigMaps labeled as sensitive. You can also supply a redaction pattern list to further control what appears in the generated docs.
+
+**Is this a one-time payment or a subscription?**
+The API is offered as a one-time purchase for $42.23, which includes lifetime access to the current version and all minor updates. No recurring fees.
+
+**What kind of support is available if I run into issues?**
+Email support is included with purchase. You'll also get access to a private knowledge base with integration examples for GitHub Actions, GitLab CI, and Jenkins.
+
+## What You Get
+
+- Instant digital download
+- Complete REST API with full documentation
+- Free updates for life — pay once, own forever
+- Setup guide and usage instructions
+
+**Stop documenting by hand—automate your Docker & Kubernetes docs with a single API call. Get lifetime access for only $42.23.**
+
+## 🚀 Usage
+
+1. Click **Use in Spaces** above to run the demo directly
+2. Or clone the repository and run locally:
+
+```bash
+git clone https://huggingface.co/spaces/WealthFromAI/docker-kubernetes-document-generation-api-a71c
+cd docker-kubernetes-document-generation-api-a71c
+pip install -r requirements.txt
+python app.py
+```
+
+## 💰 Pricing
+
+- **Demo**: Free on Hugging Face Spaces
+- **Full Source Code**: $42.23
+- Available on [Gumroad](https://gumroad.com) and [Whop](https://whop.com)
+
+## 📄 License
+
+MIT License — free to use, modify, and distribute.
+
+---
+
+*Built with [FORGE-X](https://github.com/WealthFromAI) — automated digital product engine*

a71cef49/Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.11-slim
+
+WORKDIR /app
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+EXPOSE 8000
+
+HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
+    CMD python -c "import httpx; httpx.get('http://localhost:8000/health').raise_for_status()"
+
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000", "--workers", "2"]

a71cef49/README.md

@@ -0,0 +1,89 @@
+# Docker & Kubernetes Document Generation API
+
+> Generate PDFs, contracts, reports, and forms from templates with dynamic Docker & Kubernetes data. Embed document generation in any app.
+
+## Features
+
+- Full REST API
+
+## Quick Start
+
+```bash
+# 1. Install dependencies
+pip install -r requirements.txt
+
+# 2. Configure environment
+cp .env.example .env
+# Edit .env with your settings
+
+# 3. Run locally
+uvicorn main:app --reload --port 8000
+
+# 4. View interactive docs
+open http://localhost:8000/docs
+```
+
+## Docker Deployment
+
+```bash
+# Build and run
+docker compose up -d
+
+# Check health
+curl http://localhost:8000/health
+```
+
+## Authentication
+
+Get a token first:
+```bash
+curl -X POST "http://localhost:8000/auth/token?username=admin&password=admin123"
+```
+
+Use the token in subsequent requests:
+```bash
+curl -H "Authorization: Bearer YOUR_TOKEN" http://localhost:8000/items
+```
+
+## API Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| GET | `/health` | System health |
+| POST | `/auth/token` | Get JWT token |
+| GET | `/items` | List all items |
+| POST | `/items` | Create item |
+| GET | `/items/{id}` | Get item |
+| PATCH | `/items/{id}` | Update item |
+| DELETE | `/items/{id}` | Delete item |
+| GET | `/stats` | API statistics |
+
+Full interactive docs: `http://localhost:8000/docs`
+
+## Rate Limits
+
+| Endpoint | Limit |
+|----------|-------|
+| `/auth/token` | 10/minute |
+| `GET /items` | 60/minute |
+| `POST /items` | 30/minute |
+| `DELETE /items` | 20/minute |
+
+## Running Tests
+
+```bash
+pip install pytest httpx
+pytest tests/ -v
+```
+
+## Production Notes
+
+- Change `SECRET_KEY` in `.env` before deploying
+- Replace in-memory `_db` with a real database
+- Add proper user management to `auth.py`
+- Configure `ALLOWED_ORIGINS` for CORS
+- Use Nginx/Traefik as reverse proxy
+
+## License
+
+MIT

a71cef49/auth.py

@@ -0,0 +1,53 @@
+"""
+Simple JWT auth — swap for OAuth2/API keys in production.
+"""
+import os
+from datetime import datetime, timedelta, timezone
+from typing import Optional
+from fastapi import Depends, HTTPException, status
+from fastapi.security import HTTPBearer, HTTPAuthorizationCredentials
+from jose import JWTError, jwt
+from passlib.context import CryptContext
+
+SECRET_KEY = os.getenv("SECRET_KEY", "changeme-in-production-please")
+ALGORITHM = os.getenv("ALGORITHM", "HS256")
+EXPIRE_MINUTES = int(os.getenv("ACCESS_TOKEN_EXPIRE_MINUTES", "30"))
+
+pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
+security = HTTPBearer()
+
+# Demo users — replace with real DB lookup
+USERS: dict[str, str] = {
+    "admin": pwd_context.hash("admin123"),
+    "demo": pwd_context.hash("demo123"),
+}
+
+
+def verify_password(username: str, password: str) -> bool:
+    hashed = USERS.get(username)
+    if not hashed:
+        return False
+    return pwd_context.verify(password, hashed)
+
+
+def create_access_token(data: dict) -> str:
+    to_encode = data.copy()
+    expire = datetime.now(timezone.utc) + timedelta(minutes=EXPIRE_MINUTES)
+    to_encode["exp"] = expire
+    return jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
+
+
+def get_current_user(credentials: HTTPAuthorizationCredentials = Depends(security)) -> str:
+    token = credentials.credentials
+    try:
+        payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
+        username: Optional[str] = payload.get("sub")
+        if not username:
+            raise HTTPException(status_code=401, detail="Invalid token payload")
+        return username
+    except JWTError:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Invalid or expired token",
+            headers={"WWW-Authenticate": "Bearer"},
+        )

a71cef49/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3.8'
+services:
+  api:
+    build: .
+    ports:
+      - "8000:8000"
+    env_file: .env
+    restart: unless-stopped
+    volumes:
+      - ./data:/app/data

a71cef49/main.py

@@ -0,0 +1,184 @@
+"""
+Docker & Kubernetes Document Generation API — REST API Service
+Generate PDFs, contracts, reports, and forms from templates with dynamic Docker & Kubernetes data. Embed document generation in any app.
+
+Features:
+
+"""
+import os
+from contextlib import asynccontextmanager
+from typing import Optional, List
+from datetime import datetime, timezone
+
+from fastapi import FastAPI, Depends, HTTPException, Request, status
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
+from slowapi import Limiter
+from slowapi.util import get_remote_address
+from slowapi.errors import RateLimitExceeded
+from dotenv import load_dotenv
+
+from models import ItemCreate, ItemUpdate, ItemResponse, HealthResponse
+from auth import get_current_user, create_access_token, verify_password
+
+load_dotenv()
+
+limiter = Limiter(key_func=get_remote_address)
+_db: dict = {}  # In-memory store — swap for real DB in production
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    print(f"{app.title} starting up...")
+    yield
+    print(f"{app.title} shutting down...")
+
+
+app = FastAPI(
+    title="Docker & Kubernetes Document Generation API",
+    description="Generate PDFs, contracts, reports, and forms from templates with dynamic Docker & Kubernetes data. Embed document generation in any app.",
+    version="1.0.0",
+    lifespan=lifespan,
+    docs_url="/docs",
+    redoc_url="/redoc",
+    openapi_url="/openapi.json",
+)
+
+app.state.limiter = limiter
+
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=os.getenv("ALLOWED_ORIGINS", "*").split(","),
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+
+@app.exception_handler(RateLimitExceeded)
+async def rate_limit_handler(request: Request, exc: RateLimitExceeded):
+    return JSONResponse(
+        status_code=status.HTTP_429_TOO_MANY_REQUESTS,
+        content={"error": "Rate limit exceeded", "detail": str(exc)},
+    )
+
+
+@app.exception_handler(Exception)
+async def global_exception_handler(request: Request, exc: Exception):
+    return JSONResponse(
+        status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+        content={"error": "Internal server error", "detail": str(exc)},
+    )
+
+
+# ── Health ────────────────────────────────────────────────────────────────────
+
+@app.get("/health", response_model=HealthResponse, tags=["System"])
+async def health():
+    return {
+        "status": "healthy",
+        "service": "Docker & Kubernetes Document Generation API",
+        "version": "1.0.0",
+        "timestamp": datetime.now(timezone.utc).isoformat(),
+        "items_count": len(_db),
+    }
+
+
+# ── Auth ──────────────────────────────────────────────────────────────────────
+
+@app.post("/auth/token", tags=["Auth"], summary="Get API token")
+@limiter.limit("10/minute")
+async def login(request: Request, username: str, password: str):
+    if not verify_password(username, password):
+        raise HTTPException(status_code=401, detail="Invalid credentials")
+    token = create_access_token({"sub": username})
+    return {"access_token": token, "token_type": "bearer"}
+
+
+# ── CRUD ──────────────────────────────────────────────────────────────────────
+
+@app.get("/items", response_model=List[ItemResponse], tags=["Items"])
+@limiter.limit("60/minute")
+async def list_items(
+    request: Request,
+    skip: int = 0,
+    limit: int = 50,
+    search: Optional[str] = None,
+    current_user: str = Depends(get_current_user),
+):
+    items = list(_db.values())
+    if search:
+        items = [i for i in items if search.lower() in i.get("name", "").lower()]
+    return items[skip : skip + limit]
+
+
+@app.post("/items", response_model=ItemResponse, status_code=201, tags=["Items"])
+@limiter.limit("30/minute")
+async def create_item(
+    request: Request,
+    item: ItemCreate,
+    current_user: str = Depends(get_current_user),
+):
+    item_id = f"item_{len(_db) + 1:06d}"
+    record = {
+        "id": item_id,
+        **item.model_dump(),
+        "created_by": current_user,
+        "created_at": datetime.now(timezone.utc).isoformat(),
+        "updated_at": datetime.now(timezone.utc).isoformat(),
+    }
+    _db[item_id] = record
+    return record
+
+
+@app.get("/items/{item_id}", response_model=ItemResponse, tags=["Items"])
+@limiter.limit("120/minute")
+async def get_item(
+    request: Request,
+    item_id: str,
+    current_user: str = Depends(get_current_user),
+):
+    if item_id not in _db:
+        raise HTTPException(status_code=404, detail=f"Item {item_id} not found")
+    return _db[item_id]
+
+
+@app.patch("/items/{item_id}", response_model=ItemResponse, tags=["Items"])
+@limiter.limit("30/minute")
+async def update_item(
+    request: Request,
+    item_id: str,
+    item: ItemUpdate,
+    current_user: str = Depends(get_current_user),
+):
+    if item_id not in _db:
+        raise HTTPException(status_code=404, detail=f"Item {item_id} not found")
+    record = _db[item_id]
+    updates = item.model_dump(exclude_unset=True)
+    record.update({**updates, "updated_at": datetime.now(timezone.utc).isoformat()})
+    _db[item_id] = record
+    return record
+
+
+@app.delete("/items/{item_id}", status_code=204, tags=["Items"])
+@limiter.limit("20/minute")
+async def delete_item(
+    request: Request,
+    item_id: str,
+    current_user: str = Depends(get_current_user),
+):
+    if item_id not in _db:
+        raise HTTPException(status_code=404, detail=f"Item {item_id} not found")
+    del _db[item_id]
+
+
+# ── Stats ─────────────────────────────────────────────────────────────────────
+
+@app.get("/stats", tags=["System"])
+@limiter.limit("30/minute")
+async def stats(request: Request, current_user: str = Depends(get_current_user)):
+    return {
+        "total_items": len(_db),
+        "service": "Docker & Kubernetes Document Generation API",
+        "niche": "docker_kubernetes",
+    }

a71cef49/models.py

@@ -0,0 +1,47 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+from datetime import datetime
+
+
+class ItemCreate(BaseModel):
+    name: str = Field(..., min_length=1, max_length=200, description="Item name")
+    description: Optional[str] = Field(None, max_length=2000)
+    category: Optional[str] = Field(None, max_length=100)
+    tags: list[str] = Field(default_factory=list)
+    metadata: dict = Field(default_factory=dict)
+
+    model_config = {"json_schema_extra": {"example": {
+        "name": "Sample Item",
+        "description": "A sample docker_kubernetes item",
+        "category": "default",
+        "tags": ["docker_kubernetes"],
+        "metadata": {},
+    }}}
+
+
+class ItemUpdate(BaseModel):
+    name: Optional[str] = Field(None, min_length=1, max_length=200)
+    description: Optional[str] = Field(None, max_length=2000)
+    category: Optional[str] = None
+    tags: Optional[list[str]] = None
+    metadata: Optional[dict] = None
+
+
+class ItemResponse(BaseModel):
+    id: str
+    name: str
+    description: Optional[str]
+    category: Optional[str]
+    tags: list[str]
+    metadata: dict
+    created_by: str
+    created_at: str
+    updated_at: str
+
+
+class HealthResponse(BaseModel):
+    status: str
+    service: str
+    version: str
+    timestamp: str
+    items_count: int

a71cef49/requirements.txt

@@ -0,0 +1,9 @@
+fastapi>=0.110.0
+uvicorn[standard]>=0.27.0
+pydantic>=2.0.0
+python-jose[cryptography]>=3.3.0
+passlib[bcrypt]>=1.7.4
+python-multipart>=0.0.9
+slowapi>=0.1.9
+python-dotenv>=1.0.0
+httpx>=0.27.0

a71cef49/tests/test_main.py

@@ -0,0 +1,96 @@
+"""
+Tests for Docker & Kubernetes Document Generation API API.
+"""
+import pytest
+from fastapi.testclient import TestClient
+from main import app
+
+client = TestClient(app)
+
+
+def test_health():
+    r = client.get("/health")
+    assert r.status_code == 200
+    data = r.json()
+    assert data["status"] == "healthy"
+    assert "version" in data
+
+
+def test_unauthorized():
+    r = client.get("/items")
+    assert r.status_code == 403
+
+
+def test_login():
+    r = client.post("/auth/token", params={"username": "admin", "password": "admin123"})
+    assert r.status_code == 200
+    assert "access_token" in r.json()
+
+
+def _auth_headers():
+    r = client.post("/auth/token", params={"username": "admin", "password": "admin123"})
+    token = r.json()["access_token"]
+    return {"Authorization": f"Bearer {token}"}
+
+
+def test_create_item():
+    headers = _auth_headers()
+    payload = {"name": "Test Item", "description": "A test", "tags": ["test"]}
+    r = client.post("/items", json=payload, headers=headers)
+    assert r.status_code == 201
+    data = r.json()
+    assert data["name"] == "Test Item"
+    assert "id" in data
+
+
+def test_list_items():
+    headers = _auth_headers()
+    r = client.get("/items", headers=headers)
+    assert r.status_code == 200
+    assert isinstance(r.json(), list)
+
+
+def test_get_item():
+    headers = _auth_headers()
+    # Create
+    payload = {"name": "Get Test", "tags": []}
+    r = client.post("/items", json=payload, headers=headers)
+    item_id = r.json()["id"]
+    # Get
+    r = client.get(f"/items/{item_id}", headers=headers)
+    assert r.status_code == 200
+    assert r.json()["id"] == item_id
+
+
+def test_update_item():
+    headers = _auth_headers()
+    payload = {"name": "Update Test", "tags": []}
+    r = client.post("/items", json=payload, headers=headers)
+    item_id = r.json()["id"]
+    r = client.patch(f"/items/{item_id}", json={"name": "Updated"}, headers=headers)
+    assert r.status_code == 200
+    assert r.json()["name"] == "Updated"
+
+
+def test_delete_item():
+    headers = _auth_headers()
+    payload = {"name": "Delete Test", "tags": []}
+    r = client.post("/items", json=payload, headers=headers)
+    item_id = r.json()["id"]
+    r = client.delete(f"/items/{item_id}", headers=headers)
+    assert r.status_code == 204
+    r = client.get(f"/items/{item_id}", headers=headers)
+    assert r.status_code == 404
+
+
+def test_stats():
+    headers = _auth_headers()
+    r = client.get("/stats", headers=headers)
+    assert r.status_code == 200
+    assert "total_items" in r.json()
+
+
+def test_openapi_docs():
+    r = client.get("/openapi.json")
+    assert r.status_code == 200
+    assert "openapi" in r.json()