Merge pull request #132 from spjuhel/develop

v0.6.0 - Grace Brewster Hopper

Author: spjuhel

.github/dependabot.yml

@@ -10,7 +10,7 @@ updates:
     target-branch: "develop"
     schedule:
       interval: "weekly"
-      
+
   - package-ecosystem: "github-actions"
     # Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
     directory: "/"

.github/pull_request_template.md

@@ -1,6 +1,6 @@
 Changes proposed in this PR:
-- 
-- 
+-
+-
 
 This PR fixes #
 

.github/workflows/CI.yml

@@ -6,7 +6,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.12"]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -22,4 +22,4 @@ jobs:
       - name: Run black
         run: poetry run black --check --verbose ./boario
       - name: Run the automated tests (for example)
-        run: poetry run pytest -v
+        run: poetry run pytest -v

.gitignore

@@ -9,6 +9,7 @@ pyrightconfig.json
 shortlicence
 src/docs/source/_build
 docs/pages
+docs/source/_autosummary/
 testing
 
 snakejob.*

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+# See https://pre-commit.com for more information
+default_language_version:
+  python: python3
+
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: '24.4.2'
+    hooks:
+      - id: black-jupyter

CONTRIBUTING.rst

@@ -39,8 +39,8 @@ If you want to start working on a bug then please write short message on the iss
 Implement Features
 ==================
 
-Look through the Github issues for features or add your own request 
-using the Code feature request template `here <https://github.com/spjuhel/BoARIO/issues/new/choose>`_ 
+Look through the Github issues for features or add your own request
+using the Code feature request template `here <https://github.com/spjuhel/BoARIO/issues/new/choose>`_
 and assign yourself.
 
 Write Documentation
@@ -101,4 +101,4 @@ From the base BoARIO folder you call :code:`pytest` to run all the tests, or cho
    $ pytest
    $ pytest tests/tests.py::test_log_input
 
-If you introduce a new feature you should add a new test to the tests directory. See the folder for examples.
+If you introduce a new feature you should add a new test to the tests directory. See the folder for examples.

README.rst

@@ -159,7 +159,7 @@ This work was supported by the French Environment and Energy Management Agency
 Development
 ------------
 
-** Samuel Juhel (pro@sjuhel.org)
+ - Samuel Juhel (pro@sjuhel.org)
 
 Contributions
 ---------------

api-examples/simulation/example-read_events_from_list.rstinc

@@ -50,4 +50,4 @@
 >>>    }
 >>> ]
 >>> model.read_events_from_list(events)
-15:00:25 [INFO] - [simulation.py > read_events_from_list() > 417] - Reading events from given list and adding them to the model
+15:00:25 [INFO] - [simulation.py > read_events_from_list() > 417] - Reading events from given list and adding them to the model

boario/__init__.py

@@ -16,72 +16,27 @@
 
 """BoARIO : The Adaptative Regional Input Output model in python."""
 
-try:
-    import coloredlogs as coloredlogs  # noqa: F401
-except ImportError:
-    _has_coloredlogs = False
-else:
-    _has_coloredlogs = True
-
 import importlib.metadata
 import logging
-from functools import lru_cache
 
 __version__ = importlib.metadata.version("boario")
 __author__ = "sjuhel <pro@sjuhel.org>"
 
+DEBUG_TRACE = False
 DEBUGFORMATTER = logging.Formatter(
-    fmt="%(asctime)s - boario - [%(levelname)s] - [%(filename)s > %(funcName)s() > %(lineno)s] - %(message)s",
+    fmt="%(asctime)s - [%(levelname)s] - [%(filename)s > %(funcName)s() > %(lineno)s] - %(message)s",
     datefmt="%H:%M:%S",
 )
 """Debug file formatter."""
 
-INFOFORMATTER = logging.Formatter(
-    fmt="%(asctime)s - boario - [%(levelname)s] - %(message)s",
-    datefmt="%H:%M:%S",
-)
-"""Info file formatter."""
-
+# INFOFORMATTER = logging.Formatter(
+#     fmt="%(asctime)s - [%(levelname)s] - %(message)s",
+#     datefmt="%H:%M:%S",
+# )
+# """Info file formatter."""
 
 # Create a logger object.
 logger = logging.getLogger(__name__)
-logger.setLevel(logging.INFO)
-
-# Console logger
-ch = logging.StreamHandler()
-ch.setLevel(logging.INFO)
-ch.setFormatter(INFOFORMATTER)
-
-# Avoid adding multiple handlers in case of repeated imports
-if not logger.handlers:
-    logger.addHandler(ch)
-
-
-# Functions to activate/deactivate logging
-def deactivate_logging():
-    """Deactivate logging for the package."""
-    logger.disabled = True
-
-
-def activate_logging():
-    """Activate logging for the package."""
-    logger.disabled = False
-
-
-# Functions to disable/enable console logging
-def disable_console_logging():
-    """Disable console logging for the package."""
-    logger.info(
-        "Disabling logging. You can reenable it with `boario.enable_console_logging()`"
-    )
-    logger.removeHandler(ch)
-
-
-def enable_console_logging():
-    """Enable console logging for the package."""
-    if ch not in logger.handlers:
-        logger.addHandler(ch)
-
 
 try:
     import pygit2
@@ -95,16 +50,3 @@ def enable_console_logging():
         )
 except ModuleNotFoundError:
     logger.info("Unable to tell git branch as pygit2 was not found.")
-
-
-logger.info(
-    "Loaded boario module. You can disable logging in console with `boario.disable_console_logging()`."
-)
-
-
-@lru_cache(10)
-def warn_once(logger, msg: str):
-    logger.warning(msg)
-
-
-logger.propagate = False

boario/config.py

@@ -0,0 +1,31 @@
+from configparser import ConfigParser
+import os
+from pathlib import Path
+
+
+class Config:
+    def __init__(self, user_conf_path=None):
+        # Define paths for default and user configuration
+        self.default_conf_path = (
+            Path(__file__).parent / "boario-tools.conf"
+        )  # Package folder
+        self.user_conf_path = Path(user_conf_path or Path.home() / ".boario-tools.conf")
+
+        # Initialize the ConfigParser and load configurations
+        self.settings = self._load_config()
+
+    def _load_config(self):
+        config = ConfigParser(os.environ)
+
+        config.read(self.default_conf_path)
+
+        if self.user_conf_path.exists():
+            config.read(self.user_conf_path)
+        return config
+
+    def get(self, section, option, fallback=None):
+        return self.settings.get(section, option, fallback=fallback)
+
+
+# Then pass this config to custom_utils when using its functionality
+config = Config()