refactor: rename logging-conf to readylog

Author: fleetingbytes

README.md

@@ -1,25 +1,2 @@
-# logging_conf
-Logging_conf is a logging configuration template for Python's logging.
-
-## Files
-This repository contains two files, of which you actually only need the `logging_conf.py`.
-The other is just an example code to showcase the usage of the configuration.
-
-### `logging_conf.py`
-Copy this into your project folder and import the `create_dict_config` function from it in your app's entrypoint.
-
-Usage Example:
-```py
-from logging import getLogger
-from logging.config import dictConfig as configure_logging
-
-from .logging_conf import logging_configuration
-
-
-configure_logging(logging_configuration)
-
-logger = getLogger(__name__)
-```
-
-and you are ready to go.
-
+# readylog
+Readylog is a logging configuration template for Python's logging.

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
-name = "logging-conf"
+name = "readylog"
 version = "0.0.0"
-description = "Add your description here"
+description = "Creates a reasonable logging configuration for a Python project"
 license = "BSD-2-Clause"
 readme = "README.md"
 authors = [
@@ -13,18 +13,29 @@ classifiers = [
     "Development Status :: 4 - Beta",
     "License :: OSI Approved :: BSD License",
     "Programming Language :: Python :: 3.11",
-    "Programming Language :: Unix Shell",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
 ]
 dependencies = []
 
 [build-system]
-requires = ["uv_build>=0.8.17,<0.9.0"]
+requires = ["uv_build>=0.9,<0.10.0"]
 build-backend = "uv_build"
 
+[dependency-groups]
+lint = [
+    "ruff>=0.14.0",
+]
+test = [
+    "pytest>=8.4.2",
+]
+
 [project.urls]
-Homepage = "http://github.com/fleetingbytes/logging-conf"
-Documentation = "http://github.com/fleetingbytes/logging-conf/blob/master/README.md"
-Repository = "http://github.com/fleetingbytes/logging-conf.git"
-Issues = "http://github.com/fleetingbytes/logging-conf/issues"
-Changelog = "http://github.com/fleetingbytes/logging-conf/blob/master/CHANGELOG.md"
+Homepage = "http://github.com/fleetingbytes/readylog"
+Documentation = "http://github.com/fleetingbytes/readylog/blob/master/README.md"
+Repository = "http://github.com/fleetingbytes/readylog.git"
+Issues = "http://github.com/fleetingbytes/readylog/issues"
+Changelog = "http://github.com/fleetingbytes/readylog/blob/master/CHANGELOG.md"
 

src/logging_conf/__init__.py src/readylog/__init__.pysrc/logging_conf/__init__.py renamed to src/readylog/__init__.py

@@ -8,7 +8,7 @@
     from logging import getLogger
     from logging.config import dictConfig as configure_logging
 
-    from .logging_conf import logging_configuration
+    from readylog import logging_configuration
 
 
     configure_logging(logging_configuration)
@@ -41,13 +41,13 @@ def create_dict_config(logfile: Path) -> dict[str, str]:
     }
 
     root_file_formatter_conf = {
-        "format": f'[ROOT LOG] {custom_file_formatter_conf["format"]}',
+        "format": f"[ROOT LOG] {custom_file_formatter_conf['format']}",
         "style": "{",
         "datefmt": "%a %H:%M:%S",
     }
 
     root_console_formatter_conf = {
-        "format": f'[ROOT LOG] {custom_console_formatter_conf["format"]}',
+        "format": f"[ROOT LOG] {custom_console_formatter_conf['format']}",
         "style": "{",
         "datefmt": "%a %H:%M:%S",
     }

tests/test_readylog.py

@@ -0,0 +1,2 @@
+def test_stub():
+    pass