yta-programming-env 0.3.0__tar.gz → 0.3.1__tar.gz

{yta_programming_env-0.3.0 → yta_programming_env-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yta-programming-env
-Version: 0.3.0
+Version: 0.3.1
 Summary: Youtube Autonomous Programming Dependencies Module
 License-File: LICENSE
 Author: danialcala94
@@ -13,9 +13,9 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: python-dotenv (>=1.0.0,<9.0.0)
-Requires-Dist: yta_programming_path (>=0.0.1,<1.0.0)
-Requires-Dist: yta_validation (>=0.0.1,<1.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<9999.0.0)
+Requires-Dist: yta_programming_path (>=0.3.0,<1.0.0)
+Requires-Dist: yta_validation (>=0.2.1,<1.0.0)
 Description-Content-Type: text/markdown
 
 # Youtube Autonomous Programming Environment add-on

{yta_programming_env-0.3.0 → yta_programming_env-0.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "yta-programming-env"
-version = "0.3.0"
+version = "0.3.1"
 description = "Youtube Autonomous Programming Dependencies Module"
 authors = [
     {name = "danialcala94",email = "danielalcalavalera@gmail.com"}
@@ -10,9 +10,9 @@ requires-python = ">=3.8,<3.14"
 
 [tool.poetry.dependencies]
 # Mandatory
-yta_validation = { version = ">=0.0.1,<1.0.0", optional = false }
-yta_programming_path = { version = ">=0.0.1,<1.0.0", optional = false }
-python-dotenv = { version = ">=1.0.0,<9.0.0", optional = false }
+yta_validation = { version = ">=0.2.1,<1.0.0", optional = false }
+yta_programming_path = { version = ">=0.3.0,<1.0.0", optional = false }
+python-dotenv = { version = ">=1.0.1,<9999.0.0", optional = false }
 # Optional
 
 [tool.poetry]

yta_programming_env-0.3.1/src/yta_programming_env/__init__.py

@@ -0,0 +1,74 @@
+from yta_programming_path import DevPathHandler
+from yta_validation.parameter import ParameterValidator
+from dotenv import load_dotenv, dotenv_values
+from typing import Union
+
+import os
+
+
+class Environment:
+    """
+    Class to handle the environment of the project in
+    which you are executing this code perfectly.
+    """
+
+    @staticmethod
+    def load_current_project_dotenv(
+        env_filename: str = '.env',
+        do_override: bool = True
+    ):
+        """
+        Load the `env_filename` (by default '.env')
+        environment configuration file from the current
+        project. The current project is the one in which
+        the code is being executed, not the library in which
+        it is written.
+
+        The `env_filename` will be read and the variables on
+        it will be loaded and ready to be accessed.
+
+        If the `do_override` is `True`, the previously 
+        existing configuration variables will be overriden by
+        the new values.
+        """
+        load_dotenv(
+            dotenv_path = os.path.join(DevPathHandler.get_project_abspath(), env_filename),
+            override = do_override
+        )
+
+    @staticmethod
+    def get_current_project_env_dict(
+        env_filename: str = '.env'
+    ) -> dict:
+        """
+        Get the variables of the `env_filename` environment
+        configuration file as a dict.
+
+        This method doesn't load the variables in memory, it
+        just read the values from the file.
+        """
+        return dotenv_values(
+            dotenv_path = os.path.join(
+                DevPathHandler.get_project_abspath(),
+                env_filename
+            )
+        )
+        
+
+    @staticmethod
+    def get_current_project_env(
+        variable: str,
+        default_value: Union[str, bool, float, int, None] = None,
+        env_filename: str = '.env'
+    ):
+        """
+        Load the `env_filename` environment configuration file
+        and get the value of the `variable`, if existing.
+
+        This method will do a `load_dotenv` call, which will
+        try to load the `env_filename` in memory and then use
+        the `os.getenv` method.
+        """
+        ParameterValidator.validate_mandatory_string('variable', variable, do_accept_empty = False)
+
+        return Environment.get_current_project_env_dict(env_filename).get(variable, default_value)

yta_programming_env-0.3.0/src/yta_programming_env/__init__.py

@@ -1,49 +0,0 @@
-from yta_programming_path import DevPathHandler
-from yta_validation.parameter import ParameterValidator
-from dotenv import load_dotenv
-from typing import Union
-
-import os
-
-
-class Environment:
-    """
-    Class to handle the environment of the project in
-    which you are executing this code perfectly.
-    """
-
-    @staticmethod
-    def load_current_project_dotenv(
-    ):
-        """
-        Load the current project environment '.env' configuration
-        file. The current project is the one in which the code
-        is being executed (the code in which you call this method,
-        not the library in which it is written).
-
-        Any project in which you are importing this library, the
-        '.env' file on its main folder will be loaded.
-        """
-        load_dotenv(os.path.join(DevPathHandler.get_project_abspath(), '.env'))
-
-    @staticmethod
-    def get_current_project_env(
-        variable: str,
-        default_value: Union[str, bool, float, int, None] = None
-    ):
-        """
-        Load the current project environment '.env' configuration
-        file and get the value of the 'variable' if existing.
-
-        This method makes a 'load_dotenv' call within the current
-        project absolute path any time you call it, so it ensures
-        the value is correctly loaded if available.
-
-        You don't need to do 'load_dotenv()' to call this method,
-        it will do for you =).
-        """
-        ParameterValidator.validate_mandatory_string('variable', variable, do_accept_empty = False)
-        
-        Environment.load_current_project_dotenv()
-
-        return os.getenv(variable, default_value)