using constants

pyaction/consts.py

@@ -0,0 +1,18 @@
+import os
+
+# package info
+PROJECT_NAME = "PyAction"
+PACKAGE_NAME = "pyaction"
+PROJECT_DESC = "Create GitHub Actions Using Python"
+
+
+# Base-url of package
+BASE_URL = os.path.dirname(__file__)
+
+
+# Path to the copier template
+TEMPLATE_PATH = os.path.join(BASE_URL, "template")
+
+
+# GitHub Action's workflow output environment variable
+GITHUB_OUTPUT = os.environ.get("GITHUB_OUTPUT", os.devnull)

pyaction/io.py

@@ -1,13 +1,12 @@
 import os
 from typing import Dict
 
+from pyaction.consts import GITHUB_OUTPUT
 from pyaction.exceptions import WorkflowParameterNotFound
 
-BUFFER_PATH = os.environ.get("GITHUB_OUTPUT", os.devnull)
-
 
 def write(context: Dict[str, str]) -> None:
-    """writes the key(s) (as variables) and value(s) (as values) to the output buffer
+    """writes the key(s) (as variables) and value(s) (as values) to the output env variable
 
     Args:
         context: variables and values
@@ -20,9 +19,9 @@ def write(context: Dict[str, str]) -> None:
         `name` will be the variable name and `John` is the value.
     """
 
-    with open(BUFFER_PATH, "a") as _buffer:
+    with open(GITHUB_OUTPUT, "a") as _env:
         for var, val in context.items():
-            _buffer.write(f"{var}={val}\r\n")
+            _env.write(f"{var}={val}\r\n")
 
 
 def read(param: str) -> str | int | bool | None:
@@ -36,12 +35,13 @@ def read(param: str) -> str | int | bool | None:
     """
 
     prefix = "INPUT_"
+    var_name = prefix + param.upper()
 
     try:
-        value = os.environ[prefix + param.upper()]
+        value = os.environ[var_name]
     except KeyError:
         raise WorkflowParameterNotFound(
-            f"Couldn't read the `{param}` input parameter from your pipeline. "
+            f"Couldn't read the `{var_name}` input parameter from your pipeline. "
             "Make sure it's declared properly."
         )