feat: make logging WARNING by default, controllable by flags. Inform user about progress

Author: mxmehl

gh_org_mgr/__init__.py

@@ -4,23 +4,6 @@
 
 """Global init file"""
 
-import logging
 from importlib.metadata import version
 
 __version__ = version("github-org-manager")
-
-
-def configure_logger(debug: bool = False) -> logging.Logger:
-    """Set logging options"""
-    log = logging.getLogger()
-    logging.basicConfig(
-        encoding="utf-8",
-        format="[%(asctime)s] %(levelname)s: %(message)s",
-        datefmt="%Y-%m-%d %H:%M:%S",
-    )
-    if debug:
-        log.setLevel(logging.DEBUG)
-    else:
-        log.setLevel(logging.INFO)
-
-    return log

gh_org_mgr/_helpers.py

@@ -4,9 +4,40 @@
 
 """Helper functions"""
 
+import logging
+import sys
 from dataclasses import asdict
 
 
+def configure_logger(verbose: bool = False, debug: bool = False) -> logging.Logger:
+    """Set logging options"""
+    log = logging.getLogger()
+    logging.basicConfig(
+        encoding="utf-8",
+        format="[%(asctime)s] %(levelname)s: %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+    )
+    if debug:
+        log.setLevel(logging.DEBUG)
+    elif verbose:
+        log.setLevel(logging.INFO)
+    else:
+        log.setLevel(logging.WARNING)
+
+    return log
+
+
+def log_progress(message: str) -> None:
+    """Log progress messages to stderr"""
+    # Clear line if no message is given
+    if not message:
+        sys.stderr.write("\r\033[K")
+        sys.stderr.flush()
+    else:
+        sys.stderr.write(f"\r\033[K⏳ {message}")
+        sys.stderr.flush()
+
+
 def sluggify_teamname(team: str) -> str:
     """Slugify a GitHub team name"""
     # TODO: this is very naive, no other special chars are

gh_org_mgr/manage.py

@@ -8,9 +8,10 @@
 import logging
 import sys
 
-from . import __version__, configure_logger
+from . import __version__
 from ._config import parse_config_files
 from ._gh_org import GHorg
+from ._helpers import configure_logger, log_progress
 from ._setup_team import setup_team
 
 # Main parser with root-level flags
@@ -26,7 +27,8 @@
 
 # Common flags, usable for all effective subcommands
 common_flags = argparse.ArgumentParser(add_help=False)  # No automatic help to avoid duplication
-common_flags.add_argument("--debug", action="store_true", help="Get verbose logging output")
+common_flags.add_argument("-v", "--verbose", action="store_true", help="Get INFO logging output")
+common_flags.add_argument("-vv", "--debug", action="store_true", help="Get DEBUG logging output")
 
 # Sync commands
 parser_sync = subparsers.add_parser(
@@ -95,14 +97,15 @@ def main():
     # Process arguments
     args = parser.parse_args()
 
-    configure_logger(args.debug)
+    configure_logger(verbose=args.verbose, debug=args.debug)
 
     # Sync command
     if args.command == "sync":
+        log_progress("Preparing...")
         if args.dry:
             logging.info("Dry-run mode activated, will not make any changes at GitHub")
         if args.force:
-            logging.info("Force mode activated, will make potentially dangerous actions")
+            logging.warning("Force mode activated, will make potentially dangerous actions")
 
         org = GHorg()
 
@@ -129,33 +132,43 @@ def main():
         org.ratelimit()
 
         # Synchronise organisation owners
+        log_progress("Synchronising organisation owners...")
         org.sync_org_owners(dry=args.dry, force=args.force)
         # Create teams that aren't present at Github yet
+        log_progress("Creating missing teams...")
         org.create_missing_teams(dry=args.dry)
         # Configure general settings of teams
+        log_progress("Configuring team settings...")
         org.sync_current_teams_settings(dry=args.dry)
         # Synchronise the team memberships
+        log_progress("Synchronising team memberships...")
         org.sync_teams_members(dry=args.dry)
         # Report and act on teams that are not configured locally
+        log_progress("Checking for unconfigured teams...")
         org.get_unconfigured_teams(
             dry=args.dry,
             delete_unconfigured_teams=cfg_app.get("delete_unconfigured_teams", False),
         )
         # Report and act on organisation members that do not belong to any team
+        log_progress("Checking for members without team...")
         org.get_members_without_team(
             dry=args.dry,
             remove_members_without_team=cfg_app.get("remove_members_without_team", False),
         )
         # Synchronise the permissions of teams for all repositories
+        log_progress("Synchronising team permissions...")
         org.sync_repo_permissions(dry=args.dry, ignore_archived=args.ignore_archived)
         # Remove individual collaborator permissions if they are higher than the one
         # from team membership (or if they are in no configured team at all)
+        log_progress("Synchronising individual collaborator permissions...")
         org.sync_repo_collaborator_permissions(dry=args.dry)
 
         # Debug output
+        log_progress("")  # clear progress
         logging.debug("Final dataclass:\n%s", org.pretty_print_dataclass())
         org.ratelimit()
 
+        # Print changes
         org.stats.print_changes(
             orgname=cfg_org.get("org_name", ""), output=args.output, dry=args.dry
         )