Add some logging to help troubleshoot

yambs/commands/common.py

@@ -5,6 +5,7 @@
 # built-in
 from argparse import ArgumentParser as _ArgumentParser
 from argparse import Namespace as _Namespace
+from logging import getLogger
 from pathlib import Path as _Path
 from shutil import which
 from subprocess import run
@@ -15,9 +16,16 @@
 from rcmpy.watch.params import WatchParams
 
 # internal
-from yambs import PKG_NAME
+from yambs import DESCRIPTION, PKG_NAME, VERSION
 from yambs.config.common import DEFAULT_CONFIG
 
+LOG = getLogger(__name__)
+
+
+def log_package() -> None:
+    """Log some basic package information."""
+    LOG.info("%s-%s - %s.", PKG_NAME, VERSION, DESCRIPTION)
+
 
 def add_config_arg(parser: _ArgumentParser) -> None:
     """Add an argument for specifying a configuration file."""

yambs/commands/compile_config.py

@@ -12,6 +12,9 @@
 from vcorelib.dict import MergeStrategy, merge_dicts
 from vcorelib.io import ARBITER, DEFAULT_INCLUDES_KEY
 
+# internal
+from yambs.commands.common import log_package
+
 
 def compile_config_cmd(args: _Namespace) -> int:
     """Execute the compile_config command."""
@@ -20,6 +23,8 @@ def compile_config_cmd(args: _Namespace) -> int:
     if args.update:
         merge_strat = MergeStrategy.UPDATE
 
+    log_package()
+
     return (
         0
         if ARBITER.encode(

yambs/commands/native.py

@@ -10,14 +10,21 @@
 from vcorelib.args import CommandFunction as _CommandFunction
 
 # internal
-from yambs.commands.common import add_common_args, handle_build, run_watch
+from yambs.commands.common import (
+    add_common_args,
+    handle_build,
+    log_package,
+    run_watch,
+)
 from yambs.config.native import load_native
 from yambs.environment.native import NativeBuildEnvironment
 
 
 def native_cmd(args: _Namespace) -> int:
     """Execute the native command."""
 
+    log_package()
+
     config = load_native(path=args.config, root=args.dir)
 
     NativeBuildEnvironment(config).generate(sources_only=args.sources)