added base cli and log modules

Author: edublancas

setup.py

@@ -46,6 +46,8 @@ def read(*names, **kwargs):
 DEV = [
     "pytest",
     "twine",
+    # to test logging in the template
+    "structlog",
     # optional dependency for test module
     "jupytext",
     "nbclient",

src/pkgmt/assets/template/setup.py

@@ -41,6 +41,6 @@
         "dev": DEV,
     },
     entry_points={
-        # 'console_scripts': ['$project_name=$package_name.cli:cli'],
+        "console_scripts": ["$project_name=$package_name.cli:cli"],
     },
 )

src/pkgmt/assets/template/src/package_name/cli.py

@@ -0,0 +1,33 @@
+"""
+Sample CLI (requires click, tested with click==8.1.3)
+"""
+
+import click
+
+
+@click.group()
+def cli():
+    """Command-line interface"""
+    pass
+
+
+@cli.command()
+@click.argument("name")
+def hello(name):
+    """Say hello to someone"""
+    print(f"Hello, {name}!")
+
+
+@cli.command()
+@click.argument("name")
+def log(name):
+    """Log a message"""
+    from $package_name.log import configure_file_and_print_logger, get_logger
+
+    configure_file_and_print_logger()
+    logger = get_logger()
+    logger.info(f"Hello, {name}!", name=name)
+
+
+if __name__ == "__main__":
+    cli()

src/pkgmt/assets/template/src/package_name/log.py

@@ -0,0 +1,91 @@
+"""
+A sample logger (requires structlog, tested with structlog==25.1.0)
+
+Usage
+-----
+
+>>> from $package_name.log import configure_file_and_print_logger, get_logger
+>>> configure_file_and_print_logger("app.log")
+>>> # OR
+>>> configure_print_logger()
+>>> logger = get_logger()
+>>> logger.info("Hello, world!")
+"""
+
+import logging
+import structlog
+from typing import Any, TextIO
+import os
+
+import structlog
+from structlog import WriteLogger, PrintLogger
+
+
+class CustomLogger:
+    """
+    A custom logger that writes to a file and prints to the console
+    """
+
+    def __init__(self, file: TextIO | None = None):
+        self._file = file
+        self._write_logger = WriteLogger(self._file)
+        self._print_logger = PrintLogger()
+
+    def msg(self, message: str) -> None:
+        self._write_logger.msg(message)
+        self._print_logger.msg(message)
+
+    log = debug = info = warn = warning = msg
+    fatal = failure = err = error = critical = exception = msg
+
+
+class CustomLoggerFactory:
+    def __init__(self, file: TextIO | None = None):
+        self._file = file
+
+    def __call__(self, *args: Any) -> CustomLogger:
+        return CustomLogger(self._file)
+
+
+def configure_file_and_print_logger(file_path: str = "app.log") -> None:
+    structlog.configure(
+        processors=[
+            structlog.contextvars.merge_contextvars,
+            structlog.processors.add_log_level,
+            structlog.processors.StackInfoRenderer(),
+            structlog.dev.set_exc_info,
+            structlog.processors.TimeStamper(fmt="%Y-%m-%d %H:%M:%S", utc=False),
+            structlog.processors.JSONRenderer(),
+        ],
+        wrapper_class=structlog.make_filtering_bound_logger(logging.NOTSET),
+        context_class=dict,
+        logger_factory=CustomLoggerFactory(open(file_path, "at")),
+        cache_logger_on_first_use=False,
+    )
+
+
+def configure_print_logger() -> None:
+    structlog.configure(
+        processors=[
+            structlog.contextvars.merge_contextvars,
+            structlog.processors.add_log_level,
+            structlog.processors.StackInfoRenderer(),
+            structlog.dev.set_exc_info,
+            structlog.processors.TimeStamper(fmt="%Y-%m-%d %H:%M:%S", utc=False),
+            structlog.dev.ConsoleRenderer(),
+        ],
+        wrapper_class=structlog.make_filtering_bound_logger(logging.NOTSET),
+        context_class=dict,
+        logger_factory=structlog.PrintLoggerFactory(),
+        cache_logger_on_first_use=False,
+    )
+
+
+def configure_no_logging() -> None:
+    structlog.configure(
+        logger_factory=structlog.PrintLoggerFactory(open(os.devnull, "w")),
+    )
+
+
+def get_logger():
+    return structlog.get_logger()

src/pkgmt/assets/template/tasks.py

@@ -6,8 +6,8 @@ def setup(c, version=None):
     """
     Setup dev environment, requires conda
     """
-    version = version or "3.9"
-    suffix = "" if version == "3.9" else version.replace(".", "")
+    version = version or "3.12"
+    suffix = "" if version == "3.12" else version.replace(".", "")
     env_name = f"$project_name{suffix}"
 
     c.run(f"conda create --name {env_name} python={version} --yes")

src/pkgmt/new.py

@@ -34,6 +34,8 @@ def package(name, use_setup_py=False):
         "pyproject.toml",
         "pyproject-setup.toml",
         ".github/workflows/ci.yml",
+        "src/package_name/cli.py",
+        "src/package_name/log.py",
     ):
         render_inplace(
             root / file,

tests/test_new.py

@@ -1,3 +1,5 @@
+import json
+from unittest.mock import ANY
 from pathlib import Path
 import subprocess
 from pkgmt import new
@@ -8,7 +10,7 @@
 @pytest.fixture
 def uninstall():
     yield
-    subprocess.check_call(["pip", "uninstall", "somepkg", "-y"])
+    subprocess.check_call(["pip", "uninstall", "some-cool-pkg", "-y"])
 
 
 def test_package_setup_py(tmp_empty, uninstall):
@@ -31,6 +33,14 @@ def test_package_setup_py(tmp_empty, uninstall):
     assert 'python -c "import some_cool_pkg"' in ci
     assert "graft src/some_cool_pkg/assets" in manifest
 
+    subprocess.check_call(["some-cool-pkg", "log", "user"])
+    assert json.loads(Path("app.log").read_text()) == {
+        "name": "user",
+        "event": "Hello, user!",
+        "level": "info",
+        "timestamp": ANY,
+    }
+
 
 def test_package_pyproject_toml(tmp_empty, uninstall):
     new.package("some-cool_pkg", use_setup_py=False)
@@ -56,3 +66,11 @@ def test_package_pyproject_toml(tmp_empty, uninstall):
     assert 'package-data = { "some_cool_pkg" = ["assets/*", "*.md"] }' in pyproject
 
     assert 'python -c "import some_cool_pkg"' in ci
+
+    subprocess.check_call(["some-cool-pkg", "log", "user"])
+    assert json.loads(Path("app.log").read_text()) == {
+        "name": "user",
+        "event": "Hello, user!",
+        "level": "info",
+        "timestamp": ANY,
+    }