yta-programming-env 0.0.1__tar.gz

yta_programming_env-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yta_programming_env-0.0.1/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: yta-programming-env
+Version: 0.0.1
+Summary: Youtube Autonomous Programming Dependencies Module
+License-File: LICENSE
+Author: danialcala94
+Author-email: danielalcalavalera@gmail.com
+Requires-Python: ==3.9
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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)
+Description-Content-Type: text/markdown
+
+# Youtube Autonomous Programming Environment add-on
+
+The way to work internally with some of the functionalities we need related to handling environment variables.

yta_programming_env-0.0.1/README.md

@@ -0,0 +1,3 @@
+# Youtube Autonomous Programming Environment add-on
+
+The way to work internally with some of the functionalities we need related to handling environment variables.

yta_programming_env-0.0.1/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "yta-programming-env"
+version = "0.0.1"
+description = "Youtube Autonomous Programming Dependencies Module"
+authors = [
+    {name = "danialcala94",email = "danielalcalavalera@gmail.com"}
+]
+readme = "README.md"
+requires-python = "==3.9"
+dependencies = [
+    "yta_validation (>=0.0.1,<1.0.0)",
+    "yta_programming_path (>=0.0.1,<1.0.0)",
+    "python-dotenv (>=1.0.0,<9.0.0)",
+]
+
+[tool.poetry]
+packages = [{include = "yta_programming_env", from = "src"}]
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.5"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

yta_programming_env-0.0.1/src/yta_programming_env/__init__.py

@@ -0,0 +1,49 @@
+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)