turn off color if rich dependency is present, and enforce its presence

Author: top-on

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.1] - 2023-12-26
+### Fixed
+- turn off color if rich dependency is present, and enforce its presence
+
 ## [0.7.0] - 2023-12-24
 ### Added
 - command 'next' to list upcoming events, filtered by minimum rating

README.md

@@ -20,23 +20,25 @@ pip install optimal-congress
 `optimal-congress` provides the following commands:
 
 ```
-$ optimal-congress --help
-Usage: optimal-congress [OPTIONS] COMMAND [ARGS]...
-
-  Optimize your personal schedule for the 37c3.
-
-Options:
-  -v, --verbose
-  -h, --help     Show this message and exit.
-
-Commands:
-  dump      Export all latest ratings to CSV, for bulk editing.
-  fetch     Fetch events and rooms from API, and update local cache.
-  load      Bulk import ratings from CSV.
-  next      List next upcoming events, filtered by minimum rating.
-  optimize  Optimize the schedule based on ratings.
-  rate      Interactively rate those events that have not been rated yet.
-  ratings   List all latest ratings.
+$ optimal-congress -h
+                                                                                                                                                                                
+ Usage: optimal-congress [OPTIONS] COMMAND [ARGS]...                                                                                                                            
+                                                                                                                                                                                
+ Optimize your personal schedule for the 37c3.                                                                                                                                  
+                                                                                                                                                                                
+╭─ Options ────────────────────────────────────────────────────────────────────────────╮
+│ --verbose  -v        Include debug messages in output.                               │
+│ --help     -h        Show this message and exit.                                     │
+╰──────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────────────────╮
+│ dump                   Export all latest ratings to CSV, for bulk editing.           │
+│ fetch                  Fetch events and rooms from API, and update local cache.      │
+│ load                   Bulk import ratings from CSV.                                 │
+│ next                   List next upcoming events, filtered by minimum rating.        │
+│ optimize               Optimize the schedule based on ratings.                       │
+│ rate                   Interactively rate those events that have not been rated yet. │
+│ ratings                List all latest ratings.                                      │
+╰──────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
 ## Example Workflow

optimal_congress/cli.py

@@ -1,6 +1,7 @@
 """Main entry point for the 37c3 schedule optimizer."""
 # %%
 import logging
+import os
 from pathlib import Path
 
 import pandas as pd
@@ -25,6 +26,9 @@
     join_events_with_ratings,
 )
 
+# deactivate color for rich/colorama
+os.environ["NO_COLOR"] = "1"
+
 app = typer.Typer(
     add_completion=False,
     context_settings={"help_option_names": ["-h", "--help"]},
@@ -33,7 +37,14 @@
 
 # %%
 @app.callback()
-def users_callback(verbose: bool = typer.Option(False, "-v", "--verbose")) -> None:
+def users_callback(
+    verbose: bool = typer.Option(
+        False,
+        "-v",
+        "--verbose",
+        help="Include debug messages in output.",
+    ),
+) -> None:
     """Optimize your personal schedule for the 37c3."""
     # set log level
     log_level = logging.DEBUG if verbose else logging.INFO

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "optimal-congress"
-version = "0.7.0"
+version = "0.7.1"
 description = "CLI to find an optimal, personal schedule for the 37c3 congress."
 homepage = "https://github.com/top-on/optimal-congress"
 authors = ["top-on <top-on@posteo.de>"]
@@ -10,7 +10,7 @@ packages = [{ include = "optimal_congress" }]
 [tool.poetry.dependencies]
 python = "^3.10"
 pydantic = "^2.5.2"
-typer = "^0.9.0"
+typer = { extras = ["all"], version = "^0.9.0" } # extras include rich
 pytz = "^2023.3.post1"
 pulp = "^2.7.0"
 pandas = "^2.1.4"