fdc-shared-kernel 0.0.3__tar.gz

fdc_shared_kernel-0.0.3/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.1
+Name: fdc_shared_kernel
+Version: 0.0.3
+Summary: Shared library for microservice
+Author-email: Shikhil S <shikhil.s@dbizsolution.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: alembic==1.13.2
+Requires-Dist: asynctest==0.13.0
+Requires-Dist: build==1.2.1
+Requires-Dist: colorama==0.4.6
+Requires-Dist: greenlet==3.0.3
+Requires-Dist: iniconfig==2.0.0
+Requires-Dist: Mako==1.3.5
+Requires-Dist: MarkupSafe==2.1.5
+Requires-Dist: nats-py==2.8.0
+Requires-Dist: packaging==24.1
+Requires-Dist: pluggy==1.5.0
+Requires-Dist: psycopg2-binary==2.9.9
+Requires-Dist: pytest==8.2.2
+Requires-Dist: pytest-asyncio==0.23.8
+Requires-Dist: python-dotenv==1.0.1
+Requires-Dist: setuptools==71.0.0
+Requires-Dist: SQLAlchemy==2.0.31
+Requires-Dist: typing_extensions==4.12.2
+
+# Shared Kernel
+
+Shared Kernel is a lightweight, modular Python library designed to facilitate rapid development of microservices. It provides essential utilities for data manipulation, logging, configuration management, and database connectivity, making it an ideal foundation for building scalable and maintainable microservices.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+- [Usage](#usage)
+  - [Importing Modules](#importing-modules)
+  - [Initializing Database Connection](#initializing-database-connection)
+
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.6+
+- Pip
+
+### Installation
+
+To install Shared Kernel, clone the repository and install it using pip:
+
+   ```sh
+   git clone https://bitbucket.org/Weavers/shared-kernel.git 
+   cd shared-kernel pip install .
+   ```
+
+##### Step 1: Set Up Your Environment
+First, ensure you have Python installed on your system. Then, set up a virtual environment for your project to manage dependencies cleanly. Open your terminal and navigate to your project directory:
+
+```sh
+cd path/to/shared-kernel
+python -m venv venv
+source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
+```
+
+##### Step 2: Install Python build frontend.
+Ensure you python's build frontend. installed in your environment. This is necessary for building the wheel package from **.toml** file. You can install them using pip:
+```sh
+pip install --upgrade build
+```
+
+##### Step 3: Build the Wheel Package
+```sh
+python -m build
+```
+This command will build a wheel distribution and also a source distribution. After running this command, you'll find the .whl and a tar file inside the dist/ directory within your project folder.
+
+
+##### Step 4: Distribute the Wheel
+Now that you have a .whl file, you can distribute it to others. Users can install your library using pip by pointing to the .whl file:
+
+```sh
+pip install dist/shared_kernel-0.1.0-py3-none-any.whl
+```
+
+
+## Usage
+
+### Importing Modules
+
+Import the required modules from Shared Kernel into your project:
+
+```
+from shared_kernel.logger import Logger
+from shared_kernel.config import Config
+from dotenv import find_dotenv
+
+
+def main():
+    logger = Logger(name="my_app")
+    logger.configure_logger()
+
+    # Specify the path to the .env file if it's not in the current directory
+    config_manager = Config(env_path=find_dotenv())
+
+    # Access environment variables
+    api_key = config_manager.get("KEY", "default_api_key")
+
+    # Example usage
+    logger.logger.info("This is an info message.")
+    logger.logger.error("This is an error message.")
+    logger.logger.info(api_key)
+
+
+if __name__ == "__main__":
+    main()
+
+```
+
+
+### Initializing Database Connection
+
+Use the `DB` class to initialize a database connection:
+
+```
+from shared_kernel.DB import DB
+
+db_instance = DB("postgresql://user:password@localhost/dbname") 
+engine, SessionLocal = db_instance.init_db_connection()
+
+```
+
+
+
+
+### Initializing NATS Connection
+
+Use the `NATSClient` class to initialize a messaging connection:
+
+```
+from shared_kernel.messaging import NATSClient
+import asyncio
+
+def run():
+  nats_instance = NATSClient("nats://localhost:4222") 
+    await nc_interface.connect()
+
+    async def message_callback(data):
+        print(f"Received a message: {data}")
+
+    await nc_interface.subscribe("example_subject", message_callback)
+    await nc_interface.publish("example_subject", "Hello NATS!")
+    
+if __name__ == '__main__':
+    asyncio.run(run())
+```

fdc_shared_kernel-0.0.3/README.md

@@ -0,0 +1,130 @@
+# Shared Kernel
+
+Shared Kernel is a lightweight, modular Python library designed to facilitate rapid development of microservices. It provides essential utilities for data manipulation, logging, configuration management, and database connectivity, making it an ideal foundation for building scalable and maintainable microservices.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+- [Usage](#usage)
+  - [Importing Modules](#importing-modules)
+  - [Initializing Database Connection](#initializing-database-connection)
+
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.6+
+- Pip
+
+### Installation
+
+To install Shared Kernel, clone the repository and install it using pip:
+
+   ```sh
+   git clone https://bitbucket.org/Weavers/shared-kernel.git 
+   cd shared-kernel pip install .
+   ```
+
+##### Step 1: Set Up Your Environment
+First, ensure you have Python installed on your system. Then, set up a virtual environment for your project to manage dependencies cleanly. Open your terminal and navigate to your project directory:
+
+```sh
+cd path/to/shared-kernel
+python -m venv venv
+source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
+```
+
+##### Step 2: Install Python build frontend.
+Ensure you python's build frontend. installed in your environment. This is necessary for building the wheel package from **.toml** file. You can install them using pip:
+```sh
+pip install --upgrade build
+```
+
+##### Step 3: Build the Wheel Package
+```sh
+python -m build
+```
+This command will build a wheel distribution and also a source distribution. After running this command, you'll find the .whl and a tar file inside the dist/ directory within your project folder.
+
+
+##### Step 4: Distribute the Wheel
+Now that you have a .whl file, you can distribute it to others. Users can install your library using pip by pointing to the .whl file:
+
+```sh
+pip install dist/shared_kernel-0.1.0-py3-none-any.whl
+```
+
+
+## Usage
+
+### Importing Modules
+
+Import the required modules from Shared Kernel into your project:
+
+```
+from shared_kernel.logger import Logger
+from shared_kernel.config import Config
+from dotenv import find_dotenv
+
+
+def main():
+    logger = Logger(name="my_app")
+    logger.configure_logger()
+
+    # Specify the path to the .env file if it's not in the current directory
+    config_manager = Config(env_path=find_dotenv())
+
+    # Access environment variables
+    api_key = config_manager.get("KEY", "default_api_key")
+
+    # Example usage
+    logger.logger.info("This is an info message.")
+    logger.logger.error("This is an error message.")
+    logger.logger.info(api_key)
+
+
+if __name__ == "__main__":
+    main()
+
+```
+
+
+### Initializing Database Connection
+
+Use the `DB` class to initialize a database connection:
+
+```
+from shared_kernel.DB import DB
+
+db_instance = DB("postgresql://user:password@localhost/dbname") 
+engine, SessionLocal = db_instance.init_db_connection()
+
+```
+
+
+
+
+### Initializing NATS Connection
+
+Use the `NATSClient` class to initialize a messaging connection:
+
+```
+from shared_kernel.messaging import NATSClient
+import asyncio
+
+def run():
+  nats_instance = NATSClient("nats://localhost:4222") 
+    await nc_interface.connect()
+
+    async def message_callback(data):
+        print(f"Received a message: {data}")
+
+    await nc_interface.subscribe("example_subject", message_callback)
+    await nc_interface.publish("example_subject", "Hello NATS!")
+    
+if __name__ == '__main__':
+    asyncio.run(run())
+```

fdc_shared_kernel-0.0.3/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fdc_shared_kernel"
+version = "0.0.3"
+requires-python = ">=3.7"
+readme = "README.md"
+description = "Shared library for microservice"
+authors = [
+  {name="Shikhil S", email="shikhil.s@dbizsolution.com"},
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dynamic = ["dependencies"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[tool.setuptools]
+packages = { find = { where = ["src"] } }

fdc_shared_kernel-0.0.3/requirements.txt

@@ -0,0 +1,18 @@
+alembic==1.13.2
+asynctest==0.13.0
+build==1.2.1
+colorama==0.4.6
+greenlet==3.0.3
+iniconfig==2.0.0
+Mako==1.3.5
+MarkupSafe==2.1.5
+nats-py==2.8.0
+packaging==24.1
+pluggy==1.5.0
+psycopg2-binary==2.9.9
+pytest==8.2.2
+pytest-asyncio==0.23.8
+python-dotenv==1.0.1
+setuptools==71.0.0
+SQLAlchemy==2.0.31
+typing_extensions==4.12.2

fdc_shared_kernel-0.0.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fdc_shared_kernel-0.0.3/src/fdc_shared_kernel.egg-info/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.1
+Name: fdc_shared_kernel
+Version: 0.0.3
+Summary: Shared library for microservice
+Author-email: Shikhil S <shikhil.s@dbizsolution.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: alembic==1.13.2
+Requires-Dist: asynctest==0.13.0
+Requires-Dist: build==1.2.1
+Requires-Dist: colorama==0.4.6
+Requires-Dist: greenlet==3.0.3
+Requires-Dist: iniconfig==2.0.0
+Requires-Dist: Mako==1.3.5
+Requires-Dist: MarkupSafe==2.1.5
+Requires-Dist: nats-py==2.8.0
+Requires-Dist: packaging==24.1
+Requires-Dist: pluggy==1.5.0
+Requires-Dist: psycopg2-binary==2.9.9
+Requires-Dist: pytest==8.2.2
+Requires-Dist: pytest-asyncio==0.23.8
+Requires-Dist: python-dotenv==1.0.1
+Requires-Dist: setuptools==71.0.0
+Requires-Dist: SQLAlchemy==2.0.31
+Requires-Dist: typing_extensions==4.12.2
+
+# Shared Kernel
+
+Shared Kernel is a lightweight, modular Python library designed to facilitate rapid development of microservices. It provides essential utilities for data manipulation, logging, configuration management, and database connectivity, making it an ideal foundation for building scalable and maintainable microservices.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+- [Usage](#usage)
+  - [Importing Modules](#importing-modules)
+  - [Initializing Database Connection](#initializing-database-connection)
+
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.6+
+- Pip
+
+### Installation
+
+To install Shared Kernel, clone the repository and install it using pip:
+
+   ```sh
+   git clone https://bitbucket.org/Weavers/shared-kernel.git 
+   cd shared-kernel pip install .
+   ```
+
+##### Step 1: Set Up Your Environment
+First, ensure you have Python installed on your system. Then, set up a virtual environment for your project to manage dependencies cleanly. Open your terminal and navigate to your project directory:
+
+```sh
+cd path/to/shared-kernel
+python -m venv venv
+source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
+```
+
+##### Step 2: Install Python build frontend.
+Ensure you python's build frontend. installed in your environment. This is necessary for building the wheel package from **.toml** file. You can install them using pip:
+```sh
+pip install --upgrade build
+```
+
+##### Step 3: Build the Wheel Package
+```sh
+python -m build
+```
+This command will build a wheel distribution and also a source distribution. After running this command, you'll find the .whl and a tar file inside the dist/ directory within your project folder.
+
+
+##### Step 4: Distribute the Wheel
+Now that you have a .whl file, you can distribute it to others. Users can install your library using pip by pointing to the .whl file:
+
+```sh
+pip install dist/shared_kernel-0.1.0-py3-none-any.whl
+```
+
+
+## Usage
+
+### Importing Modules
+
+Import the required modules from Shared Kernel into your project:
+
+```
+from shared_kernel.logger import Logger
+from shared_kernel.config import Config
+from dotenv import find_dotenv
+
+
+def main():
+    logger = Logger(name="my_app")
+    logger.configure_logger()
+
+    # Specify the path to the .env file if it's not in the current directory
+    config_manager = Config(env_path=find_dotenv())
+
+    # Access environment variables
+    api_key = config_manager.get("KEY", "default_api_key")
+
+    # Example usage
+    logger.logger.info("This is an info message.")
+    logger.logger.error("This is an error message.")
+    logger.logger.info(api_key)
+
+
+if __name__ == "__main__":
+    main()
+
+```
+
+
+### Initializing Database Connection
+
+Use the `DB` class to initialize a database connection:
+
+```
+from shared_kernel.DB import DB
+
+db_instance = DB("postgresql://user:password@localhost/dbname") 
+engine, SessionLocal = db_instance.init_db_connection()
+
+```
+
+
+
+
+### Initializing NATS Connection
+
+Use the `NATSClient` class to initialize a messaging connection:
+
+```
+from shared_kernel.messaging import NATSClient
+import asyncio
+
+def run():
+  nats_instance = NATSClient("nats://localhost:4222") 
+    await nc_interface.connect()
+
+    async def message_callback(data):
+        print(f"Received a message: {data}")
+
+    await nc_interface.subscribe("example_subject", message_callback)
+    await nc_interface.publish("example_subject", "Hello NATS!")
+    
+if __name__ == '__main__':
+    asyncio.run(run())
+```

fdc_shared_kernel-0.0.3/src/fdc_shared_kernel.egg-info/SOURCES.txt

@@ -0,0 +1,37 @@
+README.md
+pyproject.toml
+requirements.txt
+src/fdc_shared_kernel.egg-info/PKG-INFO
+src/fdc_shared_kernel.egg-info/SOURCES.txt
+src/fdc_shared_kernel.egg-info/dependency_links.txt
+src/fdc_shared_kernel.egg-info/requires.txt
+src/fdc_shared_kernel.egg-info/top_level.txt
+src/shared_kernel/__init__.py
+src/shared_kernel/config/__init__.py
+src/shared_kernel/database/__init__.py
+src/shared_kernel/exceptions/__init__.py
+src/shared_kernel/exceptions/configuration_exceptions.py
+src/shared_kernel/exceptions/custom_exceptions.py
+src/shared_kernel/exceptions/data_validation_exceptions.py
+src/shared_kernel/exceptions/http_exceptions.py
+src/shared_kernel/exceptions/infrastructure_exceptions.py
+src/shared_kernel/exceptions/operational_exceptions.py
+src/shared_kernel/exceptions/security_exceptions.py
+src/shared_kernel/interfaces/__init__.py
+src/shared_kernel/interfaces/databus.py
+src/shared_kernel/logger/__init__.py
+src/shared_kernel/messaging/__init__.py
+src/shared_kernel/messaging/nats_databus.py
+src/shared_kernel/models/__init__.py
+src/shared_kernel/tests/__init__.py
+src/shared_kernel/tests/config/test_config.py
+src/shared_kernel/tests/logger/test_logger.py
+src/shared_kernel/tests/messaging/test_nats_interface.py
+src/shared_kernel/tests/utils/test_data_validators.py
+src/shared_kernel/tests/utils/test_date_format_utils.py
+src/shared_kernel/tests/utils/test_string_utils.py
+src/shared_kernel/tests/utils/utils.py
+src/shared_kernel/utils/__init__.py
+src/shared_kernel/utils/data_validators_utils.py
+src/shared_kernel/utils/date_format_utils.py
+src/shared_kernel/utils/string_utils.py

fdc_shared_kernel-0.0.3/src/fdc_shared_kernel.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fdc_shared_kernel-0.0.3/src/fdc_shared_kernel.egg-info/requires.txt

@@ -0,0 +1,18 @@
+alembic==1.13.2
+asynctest==0.13.0
+build==1.2.1
+colorama==0.4.6
+greenlet==3.0.3
+iniconfig==2.0.0
+Mako==1.3.5
+MarkupSafe==2.1.5
+nats-py==2.8.0
+packaging==24.1
+pluggy==1.5.0
+psycopg2-binary==2.9.9
+pytest==8.2.2
+pytest-asyncio==0.23.8
+python-dotenv==1.0.1
+setuptools==71.0.0
+SQLAlchemy==2.0.31
+typing_extensions==4.12.2

fdc_shared_kernel-0.0.3/src/fdc_shared_kernel.egg-info/top_level.txt

@@ -0,0 +1 @@
+shared_kernel

fdc_shared_kernel-0.0.3/src/shared_kernel/config/__init__.py

@@ -0,0 +1,49 @@
+import os
+from typing import Any
+from dotenv import load_dotenv, find_dotenv
+from shared_kernel.exceptions import MissingConfiguration, InvalidConfiguration
+import logging
+
+logging.basicConfig(level=logging.INFO)
+
+
+class Config:
+
+    _instance = None
+
+    def __new__(cls, env_path=None):
+        if cls._instance is None:
+            cls._instance = super(Config, cls).__new__(cls)
+            cls._instance._initialize(env_path)
+        return cls._instance
+
+    def _initialize(self, env_path=None):
+        """
+        Initializes the Config class with an optional path to the .env file.
+
+        :param env_path: Optional path to the .env file. Defaults to finding the .env file in the current directory.
+        """
+        if env_path is None:
+            dotenv_path = find_dotenv()
+            if not dotenv_path:
+                logging.error(".env file not found")
+                raise InvalidConfiguration(".env file not found")
+        else:
+            dotenv_path = env_path
+
+        logging.info(f"Loading environment variables from {dotenv_path}")
+        load_dotenv(dotenv_path)
+
+    @staticmethod
+    def get(key: str, default: Any = None) -> Any:
+        """
+        Retrieves the value of an environment variable.
+
+        :param key: The name of the environment variable.
+        :param default: Default value to return if the environment variable is not set.
+        :return: The value of the environment variable.
+        """
+        value = os.getenv(key, default)
+        if value is None:
+            raise MissingConfiguration(key)
+        return value

fdc_shared_kernel-0.0.3/src/shared_kernel/database/__init__.py

@@ -0,0 +1,43 @@
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+from shared_kernel.logger import Logger
+from typing import Tuple
+
+
+class DB:
+    def __init__(self, db_url: str):
+        """
+        Initializes the DB class with the provided database configuration.
+
+        :param db_url: The database URL (e.g., postgresql://user:password@localhost/dbname).
+        """
+        self.engine = create_engine(db_url, pool_size=20, max_overflow=100)
+        self.SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=self.engine)
+        self.Base = declarative_base()
+        self.logger = Logger(name="database")
+        self.logger.configure_logger()
+
+    def init_db_connection(self) -> Tuple[create_engine, sessionmaker]:
+        """
+        Initializes the database connection and returns the engine and session maker.
+
+        :return: A tuple containing the SQLAlchemy engine and session maker.
+        """
+        self.logger.info("Database connection initialized successfully.")
+        return self.engine, self.SessionLocal
+
+    def create_tables(self):
+        """
+        Creates all tables stored in declarative Base.
+        """
+        self.logger.info("Creating tables...")
+        self.Base.metadata.create_all(bind=self.engine)
+        self.logger.info("Tables created successfully.")
+
+    def close_session(self):
+        """
+        Closes the database session.
+        """
+        self.SessionLocal.remove()
+        self.logger.info("Session closed successfully.")

fdc_shared_kernel-0.0.3/src/shared_kernel/exceptions/__init__.py

@@ -0,0 +1,7 @@
+from shared_kernel.exceptions.configuration_exceptions import *
+from shared_kernel.exceptions.custom_exceptions import *
+from shared_kernel.exceptions.data_validation_exceptions import *
+from shared_kernel.exceptions.http_exceptions import *
+from shared_kernel.exceptions.infrastructure_exceptions import *
+from shared_kernel.exceptions.operational_exceptions import *
+from shared_kernel.exceptions.security_exceptions import *

fdc_shared_kernel-0.0.3/src/shared_kernel/exceptions/configuration_exceptions.py

@@ -0,0 +1,20 @@
+class ConfigurationException(Exception):
+    """Base class for all configuration exceptions."""
+    def __init__(self, message: str = "", config_key: str = "") -> None:
+        super().__init__(message)
+        self.config_key = config_key
+
+    def __str__(self) -> str:
+        return f"{type(self).__name__}: {self.args[0]} (Config Key: {self.config_key})"
+
+
+class MissingConfiguration(ConfigurationException):
+    """Raised when a required configuration setting is missing."""
+    def __init__(self, message: str = "Required configuration setting is missing", config_key: str = "") -> None:
+        super().__init__(message=message, config_key=config_key)
+
+
+class InvalidConfiguration(ConfigurationException):
+    """Raised when a configuration setting is invalid."""
+    def __init__(self, message: str = "Invalid configuration setting", config_key: str = "", valid_value: str = "") -> None:
+        super().__init__(message=f"{message} (Valid Value: {valid_value})", config_key=config_key)