Merge pull request #26 from nsec/rich

Use `rich` library

Author: MOBergeron

.github/workflows/tests.yml

@@ -36,6 +36,11 @@ jobs:
         run: |
           pip install -e .
 
+      - name: ruff
+        run: |
+          ruff format --check ./ctf
+          ruff check ./ctf
+
       - name: ctf init
         run: |
           ctf init test-ctf

ctf/__main__.py

@@ -1,7 +1,10 @@
 #!/usr/bin/env python3
+import logging
 import os
 
+import typer
 from typer import Typer
+from typing_extensions import Annotated
 
 from ctf import (
     CTF_ROOT_DIRECTORY,
@@ -39,6 +42,17 @@
 app.add_typer(version_app)
 
 
+@app.callback()
+def global_options(
+    verbose: Annotated[
+        bool, typer.Option("--verbose", "-v", help="Enable DEBUG logging.")
+    ] = False,
+):
+    if verbose:
+        LOG.setLevel(logging.DEBUG)
+        LOG.handlers[0].setLevel(logging.DEBUG)
+
+
 def main():
     app()
 

ctf/flags.py

@@ -4,6 +4,7 @@
 import os
 from enum import StrEnum, unique
 
+import rich
 import typer
 import yaml
 from typing_extensions import Annotated
@@ -66,12 +67,12 @@ def flags(
         return
 
     if format == OutputFormat.JSON:
-        print(json.dumps(obj=flags, indent=2))
+        rich.print(json.dumps(obj=flags, indent=2))
     elif format == OutputFormat.CSV:
         output = io.StringIO()
         writer = csv.DictWriter(f=output, fieldnames=flags[0].keys())
         writer.writeheader()
         writer.writerows(rowdicts=flags)
-        print(output.getvalue())
+        rich.print(output.getvalue())
     elif format == OutputFormat.YAML:
-        print(yaml.safe_dump(data=flags))
+        rich.print(yaml.safe_dump(data=flags))

ctf/list.py

@@ -1,12 +1,12 @@
 import os
 from enum import StrEnum
 
+import rich
 import typer
-from tabulate import tabulate
+from rich.table import Table
 from typing_extensions import Annotated
 
 from ctf import CTF_ROOT_DIRECTORY
-from ctf.logger import LOG
 from ctf.utils import parse_post_yamls, parse_track_yaml
 
 app = typer.Typer()
@@ -52,19 +52,16 @@ def list_tracks(
         )
 
     if format.value == "pretty":
-        LOG.info(
-            "\n"
-            + tabulate(
-                parsed_tracks,
-                headers=[
-                    "Internal track name",
-                    "Discourse Topic Name",
-                    "Dev",
-                    "Support",
-                    "QA",
-                ],
-                tablefmt="fancy_grid",
-            )
-        )
+        table = Table(title="Tracks")
+        table.add_column("Internal track name", style="cyan")
+        table.add_column("Discourse topic name", style="magenta")
+        table.add_column("Dev")
+        table.add_column("Support")
+        table.add_column("QA")
+
+        for parsed_track in sorted(parsed_tracks, key=lambda x: x[0].lower()):
+            table.add_row(*parsed_track)
+
+        rich.print(table)
     else:
         raise ValueError(f"Invalid format: {format.value}")

ctf/logger.py

@@ -1,7 +1,13 @@
 import logging
 
-import coloredlogs
+from rich.logging import RichHandler
 
 LOG = logging.getLogger()
-LOG.setLevel(level=logging.DEBUG)
-coloredlogs.install(level="DEBUG", logger=LOG)
+LOG.setLevel(level=logging.INFO)
+FORMAT = "%(message)s"
+logging.basicConfig(
+    level=logging.DEBUG,
+    format=FORMAT,
+    datefmt="[%X]",
+    handlers=[RichHandler(level=logging.INFO)],
+)

ctf/new.py

@@ -34,7 +34,12 @@ def new(
     ],
     template: Annotated[
         Template,
-        typer.Option("--template", "-t", help="Template to use for the track."),
+        typer.Option(
+            "--template",
+            "-t",
+            help="Template to use for the track.",
+            prompt="Template to use for the track.",
+        ),
     ] = Template.APACHE_PHP,
     force: Annotated[
         bool,

ctf/services.py

@@ -1,5 +1,6 @@
 import os
 
+import rich
 import typer
 from typing_extensions import Annotated
 
@@ -49,4 +50,4 @@ def services(
             check = service["check"]
             port = service["port"]
 
-            print(f"{track}/{instance}/{name} {contact} {address} {check} {port}")
+            rich.print(f"{track}/{instance}/{name} {contact} {address} {check} {port}")

ctf/stats.py

@@ -5,6 +5,7 @@
 import subprocess
 from datetime import datetime
 
+import rich
 import typer
 from typing_extensions import Annotated
 
@@ -151,7 +152,7 @@ def stats(
         sorted(stats["number_of_points_per_track"].items(), key=lambda item: item[1])
     )
 
-    print(json.dumps(stats, indent=2, ensure_ascii=False))
+    rich.print(json.dumps(stats, indent=2, ensure_ascii=False))
     if generate_badges:
         if not _has_pybadges:
             LOG.critical(msg="Module pybadges was not found.")
@@ -291,7 +292,7 @@ def stats(
                     # Execute your command here (replace with what you need)
                     result = (
                         subprocess.run(
-                            ["python", "scripts/ctf.py", "stats"],
+                            ["ctf", "stats"],
                             check=False,
                             capture_output=True,
                             text=True,

ctf/templates/init/.gitignore

@@ -21,3 +21,4 @@ challenges/*/terraform/versions.tf
 !.vscode/settings.json
 !.vscode/extensions.json
 
+.idea

ctf/templates/init/.vscode/settings.json

@@ -3,7 +3,7 @@
         "editor.tabSize": 2
     },
     "yaml.schemas": {
-        "scripts/schemas/track.yaml.json": "challenges/**/track.yaml",
-        "scripts/schemas/post.json": "challenges/*/posts/*.yaml"
+        "schemas/track.yaml.json": "challenges/*/track.yaml",
+        "schemas/post.json": "challenges/*/posts/*.yaml"
     }
 }