devops-maturity 0.1.1__py3-none-any.whl

badges/generator.py

@@ -0,0 +1,9 @@
+import pybadges
+
+
+def generate_badge(score: float, level: str, output: str):
+    svg = pybadges.badge(
+        left_text="DevOps Maturity", right_text=level, right_color="green"
+    )
+    with open(output, "w") as f:
+        f.write(svg)

cli/main.py

@@ -0,0 +1,43 @@
+import typer
+from src.core.model import UserResponse, Assessment, SessionLocal
+from src.core.scorer import calculate_score, score_to_level
+from src.web.main import criteria
+
+app = typer.Typer(help="Run DevOps maturity assessment interactively.")
+
+
+@app.command(name="assess")
+def assess():
+    """Run an interactive DevOps maturity assessment."""
+    responses = []
+    typer.echo("DevOps Maturity Assessment\n")
+    for c in criteria:
+        answer = typer.confirm(f"{c.question} (yes/no)", default=False)
+        responses.append(UserResponse(id=c.id, answer=answer))
+    score = calculate_score(criteria, responses)
+    level = score_to_level(score)
+    typer.echo(f"\nYour score: {score:.2f}")
+    typer.echo(f"Your maturity level: {level}")
+
+    # Save to database
+    db = SessionLocal()
+    responses_dict = {r.id: r.answer for r in responses}
+    assessment = Assessment(responses=responses_dict)
+    db.add(assessment)
+    db.commit()
+    db.close()
+    typer.echo("Assessment saved to database.")
+
+
+@app.command(name="list")
+def list_assessments():
+    """List all assessments from the database."""
+    db = SessionLocal()
+    assessments = db.query(Assessment).all()
+    db.close()
+    for a in assessments:
+        typer.echo(f"ID: {a.id} | Responses: {a.responses}")
+
+
+if __name__ == "__main__":
+    app()

core/model.py

@@ -0,0 +1,34 @@
+from pydantic import BaseModel
+from sqlalchemy import Column, Integer, JSON, create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+
+Base = declarative_base()
+
+
+class Criteria(BaseModel):
+    id: str
+    question: str
+    weight: float
+
+
+class UserResponse(BaseModel):
+    id: str
+    answer: bool
+
+
+class Assessment(Base):  # type: ignore
+    __tablename__ = "assessments"
+    id = Column(Integer, primary_key=True, index=True)
+    responses = Column(JSON)
+
+
+engine = None
+SessionLocal = sessionmaker(autocommit=False, autoflush=False)
+
+
+def init_db():
+    global engine
+    engine = create_engine("sqlite:///./devops_maturity.db")
+    SessionLocal.configure(bind=engine)
+    Base.metadata.create_all(bind=engine)

core/scorer.py

@@ -0,0 +1,28 @@
+from typing import List
+from .model import Criteria, UserResponse
+
+
+def calculate_score(criteria: List[Criteria], responses: List[UserResponse]) -> float:
+    total = 0.0
+    max_score = 0.0
+    response_map = {r.id: r.answer for r in responses}
+
+    for c in criteria:
+        max_score += c.weight
+        if response_map.get(c.id):
+            total += c.weight
+
+    return (total / max_score) * 100 if max_score else 0.0
+
+
+def score_to_level(score: float) -> str:
+    if score == 0:
+        return "WIP"
+    elif score < 50:
+        return "PASSING"
+    elif score < 70:
+        return "BRONZE"
+    elif score < 90:
+        return "SILVER"
+    else:
+        return "GOLD"

devops_maturity-0.1.1.dist-info/METADATA

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: devops-maturity
+Version: 0.1.1
+Summary: A DevOps maturity assessment tool with CLI and Web interface.
+Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/devops-maturity
+Project-URL: source, https://github.com/devops-maturity/devops-maturity
+Project-URL: tracker, https://github.com/devops-maturity/devops-maturity/issues
+Keywords: devops,maturity,assessment,cli,web
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi
+Requires-Dist: badgepy
+Requires-Dist: typer
+Requires-Dist: jinja2
+Requires-Dist: pydantic
+Requires-Dist: python-multipart
+Requires-Dist: sqlalchemy
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: uvicorn; extra == "dev"
+Provides-Extra: test
+Requires-Dist: fastapi; extra == "test"
+Requires-Dist: httpx; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+
+# DevOps Maturity Assessment
+
+[![CI](https://github.com/devops-maturity/devops-maturity/actions/workflows/ci.yml/badge.svg)](https://github.com/devops-maturity/devops-maturity/actions/workflows/ci.yml)
+
+## Overview
+
+This repository contains a DevOps Maturity Assessment tool designed to help organizations evaluate their DevOps practices and identify areas for improvement. The assessment is based on a set of questions that cover various aspects of DevOps, including culture, automation, measurement, sharing, and security.
+
+## Usage
+
+### Launch Web Application
+
+To launch the web application, you can use the following command:
+
+```bash
+uvicorn src.web.main:app --reload
+```
+
+Then open [http://localhost:8000](http://localhost:8000) in your browser to access the DevOps Maturity Assessment web interface.
+
+### Use the CLI
+
+To run the assessment in your terminal, use:
+
+```bash
+python -m src.cli.main check
+```
+
+This will prompt you to answer questions interactively and generate a badge based on your score.
+
+## Assessment Categories & Criteria
+
+The assessment covers the following categories and criteria:
+
+### CI/CD Basics
+- Build a specific branch (must have)
+- Build upon pull request (must have)
+- Docker (nice to have)
+
+### Quality
+- Automated Testing: Functional testing (must have)
+- Automated Testing: Performance testing (must have)
+- Code Coverage (nice to have)
+- Accessibility Testing (nice to have)
+
+### Security
+- Security scan (must have)
+- License scan (nice to have)
+
+### Secure Supply Chain
+- Documented Build Chain (must have)
+- CICD as coded (must have)
+- Artifacts are signed (nice to have)
+- Artifactory download for Package Managers (nice to have)
+
+### Reporting
+- Email/Slack reporting functionality
+
+### Analysis
+- Quality Gate (nice to have)
+- Code Lint (nice to have)
+- Static code analysis (nice to have)
+- Dynamic code analysis (nice to have)
+
+## Badge Levels
+
+Your score will generate one of the following badges:
+- **WIP**: 0%
+- **PASSING**: 1–49%
+- **BRONZE**: 50–69%
+- **SILVER**: 70–89%
+- **GOLD**: 90–100%

devops_maturity-0.1.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+badges/generator.py,sha256=YBKvXIeOMyZf5uf9mGb7mQ4dhjr5He4062We0uWDepM,238
+cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cli/main.py,sha256=lfBf9LMimOIEj2qfOT9xnIZBLqVRc1jAg3fioOXa1w8,1320
+core/model.py,sha256=4lpFpPwjKClry8rX9YXtrizJf8T0Bo6ybFIHus3-no0,770
+core/scorer.py,sha256=1Efv275N75QDojlEQlm_B0d-7TUEfbipMAi0mlb-hw4,676
+web/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+web/main.py,sha256=hfaVIrDCIaIG6i_WlusD6MpzCI5xmIosCAeaR5JXOcM,5160
+web/static/badge.svg,sha256=XM2p4Kd51GPom86SPHtW1VwkItR5MMnMcq-X3axKcpA,1142
+web/static/devops-maturity.svg,sha256=XM2p4Kd51GPom86SPHtW1VwkItR5MMnMcq-X3axKcpA,1142
+web/static/logo.png,sha256=4IcAsfCrVv_OtpC8e0vnNfweRvcBHt-Lb8Z4dtM_mT4,41001
+web/templates/assessments.html,sha256=gXlyF3UINJV39pn_rrJ9uCAfVPGdyY_QM7BRyET4QuE,1373
+web/templates/form.html,sha256=FpFgIjUZ-gdkAmcoMc1wh1x1lDh_ie1RgfkEhm50EwA,2377
+web/templates/result.html,sha256=hdR03fYLY-hrHq1UTOGwy3j0Aik3oSrVFt5ihCFl-GU,1276
+devops_maturity-0.1.1.dist-info/METADATA,sha256=5CExjXxrd_0SBBno5DpBy-grL_DahTJ40nm8qiOjP6c,3421
+devops_maturity-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+devops_maturity-0.1.1.dist-info/entry_points.txt,sha256=GuidsCU_0PQjWHUhkA4RIP9apBLQDHIslthHq6dveao,53
+devops_maturity-0.1.1.dist-info/top_level.txt,sha256=HGiqY6MLXG0GFsMgFEltq_citYFbCNCKie1-7dW-n-I,29
+devops_maturity-0.1.1.dist-info/RECORD,,

devops_maturity-0.1.1.dist-info/WHEEL

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

devops_maturity-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+devops-maturity = src.cli.main:app

devops_maturity-0.1.1.dist-info/top_level.txt

@@ -0,0 +1,5 @@
+__init__
+badges
+cli
+core
+web

web/main.py

@@ -0,0 +1,168 @@
+from fastapi import FastAPI, Request
+from fastapi.responses import HTMLResponse, FileResponse
+from fastapi.staticfiles import StaticFiles
+from fastapi.templating import Jinja2Templates
+from ..core.model import Criteria, UserResponse, Assessment, SessionLocal
+from ..core.scorer import calculate_score, score_to_level
+from ..badges.generator import generate_badge
+
+app = FastAPI()
+templates = Jinja2Templates(directory="src/web/templates")
+app.mount("/static", StaticFiles(directory="src/web/static"), name="static")
+
+# categories of criteria
+categories = {
+    "CI/CD Basics": "CI/CD Basics",
+    "Quality": "Quality",
+    "Security": "Security",
+    "Secure Supply Chain": "Secure Supply Chain",
+    "Reporting": "Reporting",
+    "Analysis": "Analysis",
+}
+
+criteria = [
+    # CI/CD Basics
+    Criteria(
+        id="build_branch",
+        question="Build a specific branch (CI/CD Basics, must have)",
+        weight=1.0,
+    ),
+    Criteria(
+        id="build_pr",
+        question="Build upon pull request (CI/CD Basics, must have)",
+        weight=1.0,
+    ),
+    Criteria(id="docker", question="Docker (CI/CD Basics, nice to have)", weight=0.5),
+    # Quality
+    Criteria(
+        id="func_test",
+        question="Automated Testing: Functional testing (Quality, must have)",
+        weight=1.0,
+    ),
+    Criteria(
+        id="perf_test",
+        question="Automated Testing: Performance testing (Quality, must have)",
+        weight=1.0,
+    ),
+    Criteria(
+        id="code_coverage", question="Code Coverage (Quality, nice to have)", weight=0.5
+    ),
+    Criteria(
+        id="accessibility",
+        question="Accessibility Testing (Quality, nice to have)",
+        weight=0.5,
+    ),
+    # Security
+    Criteria(
+        id="security_scan", question="Security scan (Security, must have)", weight=1.0
+    ),
+    Criteria(
+        id="license_scan", question="License scan (Security, nice to have)", weight=0.5
+    ),
+    # Secure Supply Chain
+    Criteria(
+        id="doc_build_chain",
+        question="Documented Build Chain (Secure Supply Chain, must have)",
+        weight=1.0,
+    ),
+    Criteria(
+        id="cicd_as_code",
+        question="CICD as coded (Secure Supply Chain, must have)",
+        weight=1.0,
+    ),
+    Criteria(
+        id="signed_artifacts",
+        question="Artifacts are signed (Secure Supply Chain, nice to have)",
+        weight=0.5,
+    ),
+    Criteria(
+        id="artifactory_download",
+        question="Artifactory download for Package Managers (Secure Supply Chain, nice to have)",
+        weight=0.5,
+    ),
+    # Reporting
+    Criteria(
+        id="reporting",
+        question="Email/Slack reporting functionality (Reporting, must have)",
+        weight=1.0,
+    ),
+    # Analysis
+    Criteria(
+        id="quality_gate", question="Quality Gate (Analysis, nice to have)", weight=0.5
+    ),
+    Criteria(id="code_lint", question="Code Lint (Analysis, nice to have)", weight=0.5),
+    Criteria(
+        id="static_analysis",
+        question="Static code analysis (Analysis, nice to have)",
+        weight=0.5,
+    ),
+    Criteria(
+        id="dynamic_analysis",
+        question="Dynamic code analysis (Analysis, nice to have)",
+        weight=0.5,
+    ),
+]
+
+
+@app.get("/", response_class=HTMLResponse)
+def read_form(request: Request):
+    return templates.TemplateResponse(
+        "form.html",
+        {"request": request, "criteria": criteria, "categories": categories},
+    )
+
+
+@app.post("/submit")
+async def submit(request: Request):
+    form = await request.form()
+    responses = []
+    responses_dict = {}
+    for k, v in form.items():
+        answer = v == "yes"
+        responses.append(UserResponse(id=k, answer=answer))
+        responses_dict[k] = answer  # store as dict for database
+
+    # Save to database
+    db = SessionLocal()
+    assessment = Assessment(responses=responses_dict)
+    db.add(assessment)
+    db.commit()
+    db.close()
+
+    score = calculate_score(criteria, responses)
+    level = score_to_level(score)
+    badge_filename = "devops-maturity.svg"
+    badge_path = f"src/web/static/{badge_filename}"
+    badge_url = f"/static/{badge_filename}"
+    generate_badge(score, level, badge_path)
+    return templates.TemplateResponse(
+        "result.html",
+        {
+            "request": request,
+            "score": score,
+            "level": level,
+            "badge_url": badge_url,
+        },
+    )
+
+
+@app.get("/badge.svg")
+def get_badge():
+    return FileResponse("src/web/static/badge.svg", media_type="image/svg+xml")
+
+
+@app.get("/assessments", response_class=HTMLResponse)
+def list_assessments(request: Request):
+    db = SessionLocal()
+    assessments = db.query(Assessment).all()
+    db.close()
+    assessment_data = []
+    for a in assessments:
+        # Convert responses from dict to UserResponse objects
+        responses = [UserResponse(id=k, answer=v) for k, v in a.responses.items()]
+        point = calculate_score(criteria, responses)
+        assessment_data.append({"id": a.id, "responses": a.responses, "point": point})
+    return templates.TemplateResponse(
+        "assessments.html",
+        {"request": request, "assessments": assessment_data},
+    )

web/static/badge.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="160.6" height="20"><linearGradient id="smooth" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="round"><rect width="160.6" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#round)"><rect width="102.6" height="20" fill="#555"/><rect x="102.6" width="58.0" height="20" fill="#97CA00"/><rect width="160.6" height="20" fill="url(#smooth)"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"><text x="523.0" y="150" fill="#010101" fill-opacity=".3" transform="scale(0.1)" textLength="926.0" lengthAdjust="spacing">DevOps Maturity</text><text x="523.0" y="140" transform="scale(0.1)" textLength="926.0" lengthAdjust="spacing">DevOps Maturity</text><text x="1306.0" y="150" fill="#010101" fill-opacity=".3" transform="scale(0.1)" textLength="480.0" lengthAdjust="spacing">PASSING</text><text x="1306.0" y="140" transform="scale(0.1)" textLength="480.0" lengthAdjust="spacing">PASSING</text></g></svg>

web/static/devops-maturity.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="160.6" height="20"><linearGradient id="smooth" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="round"><rect width="160.6" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#round)"><rect width="102.6" height="20" fill="#555"/><rect x="102.6" width="58.0" height="20" fill="#97CA00"/><rect width="160.6" height="20" fill="url(#smooth)"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"><text x="523.0" y="150" fill="#010101" fill-opacity=".3" transform="scale(0.1)" textLength="926.0" lengthAdjust="spacing">DevOps Maturity</text><text x="523.0" y="140" transform="scale(0.1)" textLength="926.0" lengthAdjust="spacing">DevOps Maturity</text><text x="1306.0" y="150" fill="#010101" fill-opacity=".3" transform="scale(0.1)" textLength="480.0" lengthAdjust="spacing">PASSING</text><text x="1306.0" y="140" transform="scale(0.1)" textLength="480.0" lengthAdjust="spacing">PASSING</text></g></svg>

web/templates/assessments.html

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>All Assessments</title>
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet">
+</head>
+<body>
+    <div class="container mt-4">
+        <h1>All Assessments</h1>
+        <a href="/" class="btn btn-secondary mb-3">Back to Home Page</a>
+        <table class="table table-bordered table-striped">
+            <thead>
+                <tr>
+                    <th>ID</th>
+                    <th>Responses</th>
+                    <th>Point</th>
+                </tr>
+            </thead>
+            <tbody>
+                {% for a in assessments %}
+                <tr>
+                    <td>{{ a.id }}</td>
+                    <td>
+                        <ul class="mb-0">
+                        {% for key, value in a.responses.items() %}
+                            <li><strong>{{ key }}</strong>: {{ value }}</li>
+                        {% endfor %}
+                        </ul>
+                    </td>
+                    <td>{{ '%.2f' | format(a.point) }}</td>
+                </tr>
+                {% endfor %}
+            </tbody>
+        </table>
+    </div>
+    <footer class="footer mt-5 py-3 bg-light border-top">
+        <div class="container text-center text-muted">
+            &copy; 2025 DevOps Maturity Assessment
+        </div>
+    </footer>
+</body>
+</html>

web/templates/form.html

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>DevOps Maturity Assessment</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet">
+    <link rel="icon" type="image/png" href="/static/logo.png">
+    <style>
+        body { background: #FFFFFF; }
+        .container { max-width: 800px; margin-top: 40px; }
+        .category-title { margin-top: 32px; margin-bottom: 16px; font-size: 1.3em; font-weight: bold; color: #2c3e50;}
+        .card { margin-bottom: 20px; }
+        .badge-level { font-size: 1.2em; }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <ul class="nav nav-tabs mb-4">
+            <li class="nav-item">
+                <a class="nav-link active" aria-current="page" href="/">Assessment</a>
+            </li>
+            <li class="nav-item">
+                <a class="nav-link" href="/assessments">All Assessments</a>
+            </li>
+        </ul>
+        <div class="text-center mb-4">
+            <img src="/static/logo.png" alt="DevOps Maturity Logo" style="max-height:104px; background:#FFFFFF; padding:8px; border-radius:8px;">
+        </div>
+        <h1 class="mb-4 text-center">DevOps Maturity Assessment</h1>
+        <form method="post" action="/submit">
+            {% for cat in categories %}
+                <div class="category-title">{{ cat }}</div>
+                {% for c in criteria if cat in c.question %}
+                    <div class="card">
+                        <div class="card-body">
+                            <label class="form-label fw-bold">{{ c.question }}</label>
+                            <div>
+                                <input type="radio" name="{{ c.id }}" value="yes"> Yes
+                                <input type="radio" name="{{ c.id }}" value="no" checked> No
+                            </div>
+                        </div>
+                    </div>
+                {% endfor %}
+            {% endfor %}
+            <div class="text-center">
+                <button type="submit" class="btn btn-primary btn-lg">Submit Assessment</button>
+            </div>
+        </form>
+        <footer class="mt-5 text-center text-muted">
+            &copy; {{ 2025 }} DevOps Maturity Assessment
+        </footer>
+    </div>
+</body>
+</html>

web/templates/result.html

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Assessment Result</title>
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet">
+    <style>
+        .badge-img { max-width: 220px; margin-bottom: 20px; }
+        .copy-box { font-family: monospace; background: #FFFFFF; padding: 8px; border-radius: 4px; margin-bottom: 10px; }
+    </style>
+</head>
+<body>
+<div class="container mt-5">
+    <h2 class="mb-4 text-center">Your DevOps Maturity Badge</h2>
+    <div class="text-center">
+        <img src="{{ badge_url }}" alt="DevOps Maturity Badge" class="badge-img">
+    </div>
+    <h4 class="mt-4">Copy Badge Code</h4>
+    <div>
+        <strong>Markdown:</strong>
+        <div class="copy-box">![]({{ badge_url }})</div>
+        <strong>reStructuredText:</strong>
+        <div class="copy-box">.. image:: {{ badge_url }}</div>
+        <strong>HTML:</strong>
+        <div class="copy-box">&lt;img src="{{ badge_url }}" alt="DevOps Maturity Badge"&gt;</div>
+        <strong>AsciiDoc:</strong>
+        <div class="copy-box">image::{{ badge_url }}[]</div>
+    </div>
+    <div class="mt-4 text-center">
+        <a href="/" class="btn btn-secondary">Back to Assessment</a>
+    </div>
+</div>
+</body>
+</html>