Merge pull request #3 from matthew-on-git/pre_commit

feat: linting and pre-commit

Author: matthew-on-git

.github/workflows/pylint.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10"]
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
@@ -17,6 +17,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        pip install -r requirements.txt
         pip install pylint
     - name: Analysing the code with pylint
       run: |

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+- repo: https://github.com/matthew-on-git/pre-commit-conventional-commits.git
+  rev: 747218c92008b8af09f278a11bcffb6d3d34a20f
+  hooks:
+    -
+      id: conventional-commit-check
+      stages:
+        - commit-msg

README.md

@@ -60,31 +60,31 @@ Mutually exclusive options (one required):
 #### Export Non-Secured Variables
 To export non-secured variables from the "development" environment to `variables.json`:
 ```
-./manage-bitbucket-env.py -w your_workspace -r your_repo -d development -o variables.json
+./manage_bitbucket_env.py -w your_workspace -r your_repo -d development -o variables.json
 ```
 
 #### Export All Variables
 To export all variables from the "development" environment to `all_variables.json`:
 ```
-./manage-bitbucket-env.py -w your_workspace -r your_repo -d development -a all_variables.json
+./manage_bitbucket_env.py -w your_workspace -r your_repo -d development -a all_variables.json
 ```
 
 #### Export Secured Variable Keys
 To export the keys of secured variables from the "development" environment to `secret_keys.json`:
 ```
-./manage-bitbucket-env.py -w your_workspace -r your_repo -d development -e secret_keys.json
+./manage_bitbucket_env.py -w your_workspace -r your_repo -d development -e secret_keys.json
 ```
 
 #### Import Non-Secured Variables
 To import non-secured variables from `variables.json` to the "development" environment:
 ```
-./manage-bitbucket-env.py -w your_workspace -r your_repo -d development -i variables.json
+./manage_bitbucket_env.py -w your_workspace -r your_repo -d development -i variables.json
 ```
 
 #### Import All Variables
 To import all variables from `all_variables.json` to the "development" environment:
 ```
-./manage-bitbucket-env.py -w your_workspace -r your_repo -d development --import-all all_variables.json
+./manage_bitbucket_env.py -w your_workspace -r your_repo -d development --import-all all_variables.json
 ```
 
 ## JSON File Formats

helpers/bitbucket_logging.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+"""
+Logging module for Bitbucket environment manager.
+
+This module provides a custom Logger class that extends the standard logging.Logger
+to provide colored console output and optional file logging capabilities.
+"""
+
+# pylint: disable=too-many-arguments, too-many-positional-arguments
+
+import datetime
+import inspect
+import logging
+import os
+
+import coloredlogs  # type: ignore
+
+
+class BitbucketLogger(logging.Logger):
+    """Build Logger"""
+    def __init__(
+        self,
+        enable_log_file: bool = False,
+        log_level: str = 'INFO'
+    ):
+        super().__init__(os.path.basename(inspect.stack()[1].filename))
+        self.log_name: str = os.path.basename(inspect.stack()[1].filename)
+        self.log_level: str = log_level
+        self.enable_log_file: bool = enable_log_file
+
+    def _setup_logging(self) -> logging.Logger:
+        """Create and configure the logger instance."""
+        datestamp = datetime.datetime.today().strftime("%m-%d-%Y")
+        logger = logging.getLogger(self.log_name)
+        logging.captureWarnings(True)
+        coloredlogs.install(level=self.log_level)  # type: ignore
+        if self.enable_log_file:
+            formatter = logging.Formatter(
+                fmt=("[%(asctime)s] - [%(levelname)s] - "
+                     "[%(name)s.%(funcName)s:%(lineno)d] - [%(message)s]")
+            )
+            file_handler = logging.FileHandler(
+                filename=f"{self.log_name}-{datestamp}.log",
+                mode="a"
+            )
+            file_handler.setFormatter(formatter)
+            logger.addHandler(file_handler)
+
+        return logger
+
+    def create_logger(self) -> logging.Logger:
+        """Create and return a configured logger instance."""
+        return self._setup_logging()
+
+    def get_log_name(self) -> str:
+        """Get the log name."""
+        return self.log_name