Merge pull request #6 from mlcommons/publishable-to-pypi

dhosterman · web-flow · commit 3518488dbd8d · 2026-02-04T10:53:30.000-05:00
Make commitable to pypi
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 __pycache__
+dist
diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
-# Modellogger
+# airrlogger
 
-The modellogger package provides a standardized logging configuration for AIRR applications.
+The airrlogger package provides a standardized logging configuration for AIRR applications.
 
 ## Usage
 
-Install in a poetry project: `poetry add git+https://github.com/mlcommons/modellogger.git`
+Install in a poetry project: `poetry add airrlogger`
 
 Near the top of any file where you want to log, do something like:
 
 ```python
-from modellogger.log_config import get_logger
+from airrlogger.log_config import get_logger
 logger = get_logger(__name__)
 ```
 
@@ -18,7 +18,7 @@ handle the logging:
 
 ```python
 import logging
-from modellogger.log_config import configure_logging
+from airrlogger.log_config import configure_logging
 
 configure_logging(app_name="myapp", level=logging.INFO)
 ```
@@ -45,7 +45,7 @@ A class that formats log messages with UTC timestamps and optional ANSI color co
 A function that configure the root logger with console and optional file output.
 
 ```
-from modellogger.log_config import configure_logging
+from airrlogger.log_config import configure_logging
 
 logger = configure_logging(app_name="modelrunner-api", file="./app.log", level=logging.DEBUG)
 ```
diff --git a/airrlogger/__init__.py b/airrlogger/__init__.py
diff --git a/airrlogger/log_config.py b/airrlogger/log_config.py
@@ -73,6 +73,7 @@ def get_config_dict(
     app_name: str = ".",
     level: int = logging.INFO,
     log_file: Optional[str] = None,
+    include_colors: bool = False,
 ) -> Dict[str, Any]:
     config: Dict[str, Any] = {
         "version": 1,
@@ -81,12 +82,12 @@ def get_config_dict(
             "default_console": {
                 "()": f"{__name__}.DefaultFormatter",
                 "app_name": app_name,
-                "include_colors": True,
+                "include_colors": include_colors,
             },
             "default_file": {
                 "()": f"{__name__}.DefaultFormatter",
                 "app_name": app_name,
-                "include_colors": False,
+                "include_colors": include_colors,
             },
         },
         "handlers": {
diff --git a/airrlogger/py.typed b/airrlogger/py.typed
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,12 +1,24 @@
 [tool.poetry]
-name = "modellogger"
+name = "airrlogger"
 version = "0.1.0"
-description = ""
-authors = ["dhosterman <daniel@danielhosterman.com>"]
+description = "Python logging configuration library for MLCommons AIRR applications."
+authors = ["Daniel Hosterman <daniel@mlcommons.org>"]
 readme = "README.md"
+packages = [{include = "airrlogger"}]
+homepage = "https://github.com/mlcommons/modellogger"
+repository = "https://github.com/mlcommons/modellogger"
+documentation = "https://github.com/mlcommons/modellogger#readme"
+keywords = ["logging", "internal"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
 
 [tool.poetry.dependencies]
-python = ">=3.10"
+python = ">=3.12,<4.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^9.0.2"
diff --git a/tests/example_cli.py b/tests/example_cli.py
@@ -1,7 +1,8 @@
 import logging
 
 import click
-from modellogger.log_config import get_logger, configure_logging
+
+from airrlogger.log_config import configure_logging, get_logger
 from tests.example_top_library import top_library_function
 
 
diff --git a/tests/example_lower_library.py b/tests/example_lower_library.py
@@ -1,4 +1,4 @@
-from modellogger.log_config import get_logger
+from airrlogger.log_config import get_logger
 
 logger = get_logger(__name__)
 
diff --git a/tests/example_top_library.py b/tests/example_top_library.py
@@ -1,4 +1,4 @@
-from modellogger.log_config import get_logger
+from airrlogger.log_config import get_logger
 from tests.example_lower_library import lower_library_function
 
 logger = get_logger(__name__)
diff --git a/tests/test_log_config.py b/tests/test_log_config.py
@@ -1,11 +1,11 @@
 import logging
 
-import modellogger.log_config as log_config
-from modellogger.log_config import (
+import airrlogger.log_config as log_config
+from airrlogger.log_config import (
     DefaultFormatter,
+    configure_logging,
     get_config_dict,
     get_logger,
-    configure_logging,
 )
 
 
@@ -74,6 +74,18 @@ def test_get_config_dict_basic():
     assert "default_console" in config["formatters"]
     console_formatter = config["formatters"]["default_console"]
     assert console_formatter["app_name"] == "test_app"
+    assert console_formatter["include_colors"] is False
+    assert "root" in config
+    assert "level" in config["root"]
+    assert config["root"]["level"] == logging.INFO
+
+
+def test_get_config_dict_with_include_colors():
+    config = get_config_dict(app_name="test_app", include_colors=True)
+    assert config["version"] == 1
+    assert "default_console" in config["formatters"]
+    console_formatter = config["formatters"]["default_console"]
+    assert console_formatter["app_name"] == "test_app"
     assert console_formatter["include_colors"] is True
     assert "root" in config
     assert "level" in config["root"]
diff --git a/tests/test_logger_compatibility.py b/tests/test_logger_compatibility.py
@@ -6,7 +6,7 @@
 
 import pytest
 
-from modellogger.log_config import DefaultFormatter, get_logger
+from airrlogger.log_config import DefaultFormatter, get_logger
 
 
 def test_standard_logging_levels():

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from modellogger.log_config import get_logger`
	`1`	`+from airrlogger.log_config import get_logger`
`2`	`2`
`3`	`3`	`logger = get_logger(__name__)`
`4`	`4`