actions-tools 0.0.1__tar.gz → 0.0.2__tar.gz

{actions_tools-0.0.1/src/actions_tools.egg-info → actions_tools-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: actions-tools
-Version: 0.0.1
+Version: 0.0.2
 Summary: GitHub Actions Tools for Python
 Author: Shane
 License: GPL-3.0
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
@@ -39,22 +39,35 @@ License-File: LICENSE
 
 - [Install](#Install)
 - [Usage](#Usage)
-- [Development](#Development)
+- [Support](#Support)
 - [Contributing](#Contributing)
 
-GitHub Actions Tools for Python.
-
 > [!WARNING]  
 > This project is in development and is NOT stable!
 
+GitHub Actions Tools for Python.
+
 ## Install
 
+From PyPI: https://pypi.org/p/actions-tools
+
+```shell
+python -m pip install actions-tools
+```
+
+From source:
+
 ```shell
-#python -m pip install actions-tools
 git clone https://github.com/cssnr/actions-tools
 python -m pip install -e actions-tools
 ```
 
+Uninstall:
+
+```shell
+python -m pip uninstall actions-tools
+```
+
 ## Usage
 
 Functionality from @actions/toolkit
@@ -63,25 +76,45 @@ Functionality from @actions/toolkit
 from actions import core
 
 # Input
-name = core.get_input('name')
+myStr = core.get_input('myStr')
+myLowerString = core.get_input('myLowerStr', low=1)
+myRequiredStr = core.get_input('myRequiredStr', req=1)
+myBoolean = core.get_input('myBoolean', boolean=1)
+myList = core.get_input('myList', split="[,|\n]")
 
 # Logging
+core.info("info")  # alias for print
 core.debug("debug")
-core.info("info") # print
+
+# Annotations
+core.notice("notice")
 core.warn("warn")
 core.error("error")
 
 # Blocks
 core.start_group("Test")
-core.info('This folded.')
+core.info('This is folded.')
 core.end_group()
 
+with core.with_group("Test") as info:
+    info('This is folded.')
+    core.info('Also folded.')
+
 # Summary
 core.summary('## Test Action')
 
-# Output
-core.set_env('VAR', 'value')
-core.set_output('name', 'god')
+# Environment
+core.set_env('NAME', 'value')
+
+# State
+stateName = core.set_state('NAME', 'value')
+stateValue = core.get_state('NAME')
+
+# System Path
+core.add_path('/dev/null')
+
+# Outputs
+core.set_output('name', 'cssnr')
 
 # Abort
 core.set_failed("Mayday!")
@@ -92,64 +125,40 @@ Functionality new in actions-tools
 ```python
 from actions import core
 
+# Commands
+core.command('warning', 'Warned!')
+
+# Random
+myRandom = core.get_random(32)
+
 # Indent
 core.start_indent(4)
-core.info('Indented') # only works with core.info
+core.info('Indented')  # only works with core.info
 core.end_indent()
 ```
 
-# Development
+# Support
 
-### Install
+For general help or to request a feature, see:
 
-Install the package from source:
+- Q&A Discussion: https://github.com/cssnr/actions-tools/discussions/categories/q-a
+- Request a Feature: https://github.com/cssnr/actions-tools/discussions/categories/feature-requests
+- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
 
-```shell
-python -m pip install -U pip
-python -m pip install -Ur requirements.txt
-python -m pip install -e .
-```
+If you are experiencing an issue/bug or getting unexpected results, you can:
 
-Prettier is used to format yaml, json and md.
-
-```shell
-npm install -g prettier
-```
-
-To Uninstall:
-
-```shell
-python -m pip uninstall actions-tools
-```
-
-### Test
-
-First [Install](#Install), then run:
-
-```shell
-coverage run -m pytest
-coverage report -m
-```
-
-### Building
-
-Build the project locally:
-
-```shell
-python -m pip install -U pip
-python -m pip install -Ur requirements.txt
-python -m pip build
-```
-
-Install the built package:
-
-```shell
-python -m pip install dist/actions_tools-0.0.1-py3-none-any.whl
-```
+- Report an Issue: https://github.com/cssnr/actions-tools/issues
+- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=actions-tools)
+- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
 
 # Contributing
 
-Currently, the best way to contribute to this project is to star this project on GitHub.
+> [!TIP]
+> See the [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on testing and building.
+
+Currently, the best way to contribute to this project is to star this project on GitHub, open a
+[feature request](https://github.com/cssnr/actions-tools/discussions/categories/feature-requests)
+or report any [issues](https://github.com/cssnr/actions-tools/issues) you find.
 
 Additionally, you can support other GitHub Actions I have published:
 

{actions_tools-0.0.1 → actions_tools-0.0.2}/README.md

@@ -16,22 +16,35 @@
 
 - [Install](#Install)
 - [Usage](#Usage)
-- [Development](#Development)
+- [Support](#Support)
 - [Contributing](#Contributing)
 
-GitHub Actions Tools for Python.
-
 > [!WARNING]  
 > This project is in development and is NOT stable!
 
+GitHub Actions Tools for Python.
+
 ## Install
 
+From PyPI: https://pypi.org/p/actions-tools
+
+```shell
+python -m pip install actions-tools
+```
+
+From source:
+
 ```shell
-#python -m pip install actions-tools
 git clone https://github.com/cssnr/actions-tools
 python -m pip install -e actions-tools
 ```
 
+Uninstall:
+
+```shell
+python -m pip uninstall actions-tools
+```
+
 ## Usage
 
 Functionality from @actions/toolkit
@@ -40,25 +53,45 @@ Functionality from @actions/toolkit
 from actions import core
 
 # Input
-name = core.get_input('name')
+myStr = core.get_input('myStr')
+myLowerString = core.get_input('myLowerStr', low=1)
+myRequiredStr = core.get_input('myRequiredStr', req=1)
+myBoolean = core.get_input('myBoolean', boolean=1)
+myList = core.get_input('myList', split="[,|\n]")
 
 # Logging
+core.info("info")  # alias for print
 core.debug("debug")
-core.info("info") # print
+
+# Annotations
+core.notice("notice")
 core.warn("warn")
 core.error("error")
 
 # Blocks
 core.start_group("Test")
-core.info('This folded.')
+core.info('This is folded.')
 core.end_group()
 
+with core.with_group("Test") as info:
+    info('This is folded.')
+    core.info('Also folded.')
+
 # Summary
 core.summary('## Test Action')
 
-# Output
-core.set_env('VAR', 'value')
-core.set_output('name', 'god')
+# Environment
+core.set_env('NAME', 'value')
+
+# State
+stateName = core.set_state('NAME', 'value')
+stateValue = core.get_state('NAME')
+
+# System Path
+core.add_path('/dev/null')
+
+# Outputs
+core.set_output('name', 'cssnr')
 
 # Abort
 core.set_failed("Mayday!")
@@ -69,64 +102,40 @@ Functionality new in actions-tools
 ```python
 from actions import core
 
+# Commands
+core.command('warning', 'Warned!')
+
+# Random
+myRandom = core.get_random(32)
+
 # Indent
 core.start_indent(4)
-core.info('Indented') # only works with core.info
+core.info('Indented')  # only works with core.info
 core.end_indent()
 ```
 
-# Development
-
-### Install
-
-Install the package from source:
-
-```shell
-python -m pip install -U pip
-python -m pip install -Ur requirements.txt
-python -m pip install -e .
-```
-
-Prettier is used to format yaml, json and md.
-
-```shell
-npm install -g prettier
-```
+# Support
 
-To Uninstall:
+For general help or to request a feature, see:
 
-```shell
-python -m pip uninstall actions-tools
-```
+- Q&A Discussion: https://github.com/cssnr/actions-tools/discussions/categories/q-a
+- Request a Feature: https://github.com/cssnr/actions-tools/discussions/categories/feature-requests
+- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
 
-### Test
+If you are experiencing an issue/bug or getting unexpected results, you can:
 
-First [Install](#Install), then run:
-
-```shell
-coverage run -m pytest
-coverage report -m
-```
-
-### Building
-
-Build the project locally:
-
-```shell
-python -m pip install -U pip
-python -m pip install -Ur requirements.txt
-python -m pip build
-```
-
-Install the built package:
-
-```shell
-python -m pip install dist/actions_tools-0.0.1-py3-none-any.whl
-```
+- Report an Issue: https://github.com/cssnr/actions-tools/issues
+- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=actions-tools)
+- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
 
 # Contributing
 
-Currently, the best way to contribute to this project is to star this project on GitHub.
+> [!TIP]
+> See the [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on testing and building.
+
+Currently, the best way to contribute to this project is to star this project on GitHub, open a
+[feature request](https://github.com/cssnr/actions-tools/discussions/categories/feature-requests)
+or report any [issues](https://github.com/cssnr/actions-tools/issues) you find.
 
 Additionally, you can support other GitHub Actions I have published:
 

{actions_tools-0.0.1 → actions_tools-0.0.2}/pyproject.toml

@@ -13,7 +13,7 @@ classifiers = [
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Operating System :: OS Independent",
     "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
@@ -29,23 +29,27 @@ Issues = "https://github.com/cssnr/actions-tools/issues"
 
 # Setup Tools
 
+[tool.setuptools.dynamic]
+version = { attr = "actions.__version__" }
+
+# Build System
+
 [build-system]
 requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
-[tool.setuptools.dynamic]
-version = { attr = "actions.__version__" }
-
 # Black
 
 [tool.black]
 line-length = 119
+extend-exclude = '(\.github)'
 
 # Ruff
 
 [tool.ruff]
 line-length = 119
 target-version = "py313"
+exclude = [".github"]
 
 [tool.ruff.lint]
 select = ["E4", "E7", "E9", "F", "B", "Q"]
@@ -53,7 +57,7 @@ select = ["E4", "E7", "E9", "F", "B", "Q"]
 # Coverage
 
 [tool.coverage.run]
-omit = ["*/*.egg-info/*"]
+omit = ["*.egg-info/*", ".github/*"]
 source = ["src"]
 
 # Isort
@@ -62,3 +66,4 @@ source = ["src"]
 profile = "black"
 lines_after_imports = 2
 src_paths = ["src", "test"]
+skip = [".github"]

actions_tools-0.0.2/src/actions/core.py

@@ -0,0 +1,196 @@
+import os
+import random
+import re
+import string
+from contextlib import contextmanager
+from typing import Optional, Union
+
+
+# https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions
+
+
+true = ["y", "yes", "true", "on"]
+false = ["n", "no", "false", "off"]
+
+_indent = 0
+_endtoken = ""
+
+
+# Core
+
+
+def debug(message: str, *args, **kwargs):
+    print(f"::debug::{message}", *args, **kwargs)
+
+
+def info(message: str, *args, **kwargs):
+    print(" " * _indent + message, *args, **kwargs)
+
+
+def notice(message: str, *args, **kwargs):
+    print(f"::notice::{message}", *args, **kwargs)
+
+
+def warn(message: str, *args, **kwargs):
+    print(f"::warning::{message}", *args, **kwargs)
+
+
+def error(message: str, *args, **kwargs):
+    print(f"::error::{message}", *args, **kwargs)
+
+
+def is_debug() -> bool:
+    return bool(os.getenv("RUNNER_DEBUG"))
+
+
+def set_failed(message: str):
+    error(message)
+    raise SystemExit
+
+
+def mask(message: str):
+    print(f"::add-mask::{message}")
+
+
+def start_group(title: str):
+    print(f"::group::{title}")
+
+
+def end_group():
+    print("::endgroup::")
+
+
+@contextmanager
+def with_group(title: str):
+    print(f"::group::{title}")
+    try:
+        yield info
+    finally:
+        print("::endgroup::")
+
+
+def stop_commands(endtoken: str = ""):
+    global _endtoken
+    if not endtoken:
+        r = random.choices(string.ascii_uppercase + string.ascii_lowercase + string.digits, k=16)  # NOSONAR
+        endtoken = "".join(r)
+    _endtoken = endtoken
+    print(f"::stop-commands::{_endtoken}")
+
+
+def start_commands(endtoken: str = ""):
+    global _endtoken
+    if not endtoken:
+        endtoken = _endtoken
+    print(f"::{endtoken}::")
+
+
+def set_output(output: str, value: str):
+    with open(os.environ["GITHUB_OUTPUT"], "a") as f:
+        # noinspection PyTypeChecker
+        print(f"{output}={value}", file=f)
+
+
+def set_env(name: str, value: str):
+    with open(os.environ["GITHUB_ENV"], "a") as f:
+        # noinspection PyTypeChecker
+        print(f"{name}={value}", file=f)
+
+
+def add_path(path: str):
+    with open(os.environ["GITHUB_PATH"], "a") as f:
+        # noinspection PyTypeChecker
+        print(path, file=f)
+
+
+def set_state(name: str, value: str) -> str:
+    if name.startswith("STATE_"):
+        name = name[6:]
+    with open(os.environ["GITHUB_STATE"], "a") as f:
+        # noinspection PyTypeChecker
+        print(f"{name}={value}", file=f)
+    return f"STATE_{name}"
+
+
+def get_state(name: str) -> str:
+    if name.startswith("STATE_"):
+        name = name[6:]
+    return os.getenv(f"STATE_{name}", "")
+
+
+def summary(text: str, nlc=1):
+    """
+    TODO: Make this its own module
+    :param text:str: Raw Text
+    :param nlc:int: New Line Count
+    :return:
+    """
+    new_lines = os.linesep * nlc
+    with open(os.environ["GITHUB_STEP_SUMMARY"], "a") as f:
+        # noinspection PyTypeChecker
+        print(f"{text}{new_lines}", file=f)
+
+
+# Inputs
+
+
+def get_input(name: str, req=False, low=False, strip=True, boolean=False, split="") -> Union[str, bool, list]:
+    """
+    Get Input by Name
+    :param name: str: Input Name
+    :param req: bool: If Required
+    :param low: bool: To Lower
+    :param strip: bool: To Strip
+    :param boolean: bool: If Boolean
+    :param split: str: To Split
+    :return: Union[str, bool, list]
+    """
+    value = os.getenv(f"INPUT_{name.upper()}", "")
+    if boolean:
+        value = value.strip().lower()
+        if req and value not in true + false:
+            raise ValueError(f"Error Validating a Required Boolean Input: {name}")
+        if value in ["y", "yes", "true", "on"]:
+            return True
+        return False
+
+    if split:
+        result = []
+        for x in re.split(split, value):
+            result.append(_get_str_value(x, low, strip))
+        return result
+
+    value = _get_str_value(value, low, strip)
+    if req and not value:
+        raise ValueError(f"Error Parsing a Required Input: {name}")
+    return value
+
+
+def _get_str_value(value, low=False, strip=True):
+    if strip:
+        value = value.strip()
+    if low:
+        value = value.lower()
+    return value
+
+
+# Additional
+
+
+def command(name: str, value: Optional[str] = ""):
+    print(f"::{name}::{value}")
+
+
+def get_random(length: int = 16):
+    r = random.choices(string.ascii_uppercase + string.ascii_lowercase + string.digits, k=length)  # NOSONAR
+    return "".join(r)
+
+
+def start_indent(spaces: int = 2):
+    global _indent
+    _indent = spaces
+
+
+def end_indent():
+    global _indent
+    _indent = 0

{actions_tools-0.0.1 → actions_tools-0.0.2/src/actions_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: actions-tools
-Version: 0.0.1
+Version: 0.0.2
 Summary: GitHub Actions Tools for Python
 Author: Shane
 License: GPL-3.0
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
@@ -39,22 +39,35 @@ License-File: LICENSE
 
 - [Install](#Install)
 - [Usage](#Usage)
-- [Development](#Development)
+- [Support](#Support)
 - [Contributing](#Contributing)
 
-GitHub Actions Tools for Python.
-
 > [!WARNING]  
 > This project is in development and is NOT stable!
 
+GitHub Actions Tools for Python.
+
 ## Install
 
+From PyPI: https://pypi.org/p/actions-tools
+
+```shell
+python -m pip install actions-tools
+```
+
+From source:
+
 ```shell
-#python -m pip install actions-tools
 git clone https://github.com/cssnr/actions-tools
 python -m pip install -e actions-tools
 ```
 
+Uninstall:
+
+```shell
+python -m pip uninstall actions-tools
+```
+
 ## Usage
 
 Functionality from @actions/toolkit
@@ -63,25 +76,45 @@ Functionality from @actions/toolkit
 from actions import core
 
 # Input
-name = core.get_input('name')
+myStr = core.get_input('myStr')
+myLowerString = core.get_input('myLowerStr', low=1)
+myRequiredStr = core.get_input('myRequiredStr', req=1)
+myBoolean = core.get_input('myBoolean', boolean=1)
+myList = core.get_input('myList', split="[,|\n]")
 
 # Logging
+core.info("info")  # alias for print
 core.debug("debug")
-core.info("info") # print
+
+# Annotations
+core.notice("notice")
 core.warn("warn")
 core.error("error")
 
 # Blocks
 core.start_group("Test")
-core.info('This folded.')
+core.info('This is folded.')
 core.end_group()
 
+with core.with_group("Test") as info:
+    info('This is folded.')
+    core.info('Also folded.')
+
 # Summary
 core.summary('## Test Action')
 
-# Output
-core.set_env('VAR', 'value')
-core.set_output('name', 'god')
+# Environment
+core.set_env('NAME', 'value')
+
+# State
+stateName = core.set_state('NAME', 'value')
+stateValue = core.get_state('NAME')
+
+# System Path
+core.add_path('/dev/null')
+
+# Outputs
+core.set_output('name', 'cssnr')
 
 # Abort
 core.set_failed("Mayday!")
@@ -92,64 +125,40 @@ Functionality new in actions-tools
 ```python
 from actions import core
 
+# Commands
+core.command('warning', 'Warned!')
+
+# Random
+myRandom = core.get_random(32)
+
 # Indent
 core.start_indent(4)
-core.info('Indented') # only works with core.info
+core.info('Indented')  # only works with core.info
 core.end_indent()
 ```
 
-# Development
+# Support
 
-### Install
+For general help or to request a feature, see:
 
-Install the package from source:
+- Q&A Discussion: https://github.com/cssnr/actions-tools/discussions/categories/q-a
+- Request a Feature: https://github.com/cssnr/actions-tools/discussions/categories/feature-requests
+- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
 
-```shell
-python -m pip install -U pip
-python -m pip install -Ur requirements.txt
-python -m pip install -e .
-```
+If you are experiencing an issue/bug or getting unexpected results, you can:
 
-Prettier is used to format yaml, json and md.
-
-```shell
-npm install -g prettier
-```
-
-To Uninstall:
-
-```shell
-python -m pip uninstall actions-tools
-```
-
-### Test
-
-First [Install](#Install), then run:
-
-```shell
-coverage run -m pytest
-coverage report -m
-```
-
-### Building
-
-Build the project locally:
-
-```shell
-python -m pip install -U pip
-python -m pip install -Ur requirements.txt
-python -m pip build
-```
-
-Install the built package:
-
-```shell
-python -m pip install dist/actions_tools-0.0.1-py3-none-any.whl
-```
+- Report an Issue: https://github.com/cssnr/actions-tools/issues
+- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=actions-tools)
+- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
 
 # Contributing
 
-Currently, the best way to contribute to this project is to star this project on GitHub.
+> [!TIP]
+> See the [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on testing and building.
+
+Currently, the best way to contribute to this project is to star this project on GitHub, open a
+[feature request](https://github.com/cssnr/actions-tools/discussions/categories/feature-requests)
+or report any [issues](https://github.com/cssnr/actions-tools/issues) you find.
 
 Additionally, you can support other GitHub Actions I have published:
 

actions_tools-0.0.2/tests/test_all.py

@@ -0,0 +1,67 @@
+import os
+
+import pytest
+
+from actions import core
+
+
+os.environ["INPUT_TEST"] = " TRUE "
+os.environ["INPUT_FALSE"] = " untrue "
+os.environ["GITHUB_OUTPUT"] = os.environ.get("GITHUB_OUTPUT") or "output.txt"
+os.environ["GITHUB_ENV"] = os.environ.get("GITHUB_ENV") or "output.txt"
+os.environ["GITHUB_PATH"] = os.environ.get("GITHUB_PATH") or "output.txt"
+os.environ["GITHUB_STATE"] = os.environ.get("GITHUB_STATE") or "output.txt"
+os.environ["GITHUB_STEP_SUMMARY"] = os.environ.get("GITHUB_STEP_SUMMARY") or "output.txt"
+
+
+def test_print():
+    core.debug("debug")
+    core.info("info")
+    core.notice("notice")
+    core.warn("warn")
+    with pytest.raises(SystemExit):
+        core.set_failed("test")
+    core.mask("test")
+    core.start_group("test")
+    core.end_group()
+    core.start_indent()
+    core.info("indent")
+    core.end_indent()
+    core.info("dedent")
+    core.stop_commands()
+    core.info("::warning::Just kidding")
+    core.start_commands()
+    with core.with_group("With Group") as p:
+        core.info("with group")
+        p("core.info")
+    core.info("no group")
+    core.command("debug", "test")
+
+
+def test_outputs():
+    core.set_output("test", "value")
+    core.set_env("test", "value")
+    core.summary("test")
+    core.add_path("/dev/null")
+    core.set_state("STATE_test", "value")
+    os.environ["STATE_test"] = "value"
+
+
+def test_inputs():
+    assert core.get_input("test") == os.environ["INPUT_TEST"].strip()
+    assert core.get_input("test", low=True) == os.environ["INPUT_TEST"].strip().lower()
+    assert core.get_input("test", strip=False) == os.environ["INPUT_TEST"]
+    assert core.get_input("test", boolean=True)
+    with pytest.raises(ValueError):
+        core.get_input("asdf", boolean=True, req=True)
+    with pytest.raises(ValueError):
+        core.get_input("asdf", req=True)
+    assert isinstance(core.get_input("test", split="\n"), list)
+    assert len(core.get_input("test", split="\n")) == 1
+    assert not core.get_input("false", boolean=True)
+
+
+def test_getters():
+    assert core.get_state("STATE_test") == "value"
+    assert len(core.get_random(20)) == 20
+    assert not core.is_debug()

actions_tools-0.0.1/src/actions/core.py

@@ -1,122 +0,0 @@
-import os
-import re
-from typing import Union
-
-
-true = ["y", "yes", "true", "on"]
-false = ["n", "no", "false", "off"]
-
-_indent = 0
-
-
-def debug(message: str):
-    print(f"::debug::{message}")
-
-
-def info(message: str, **kwargs):
-    print(" " * _indent + message, **kwargs)
-
-
-def notice(message: str):
-    print(f"::notice::{message}")
-
-
-def warn(message: str):
-    print(f"::warning::{message}")
-
-
-def error(message: str):
-    """
-    TODO: Add error options
-    https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-error-message
-    """
-    print(f"::error::{message}")
-
-
-def set_failed(message: str):
-    error(message)
-    raise SystemExit
-
-
-def mask(message: str):
-    print(f"::add-mask::{message}")
-
-
-def start_group(title: str):
-    print(f"::group::{title}")
-
-
-def end_group():
-    print("::endgroup::")
-
-
-def start_indent(spaces: int):
-    global _indent
-    _indent = spaces
-
-
-def end_indent():
-    global _indent
-    _indent = 0
-
-
-def set_output(output: str, value: str):
-    with open(os.environ["GITHUB_OUTPUT"], "a") as f:
-        print(f"{output}={value}", file=f)
-
-
-def set_env(var: str, value: str):
-    with open(os.environ["GITHUB_ENV"], "a") as f:
-        print(f"{var}={value}", file=f)
-
-
-def summary(text: str, nlc=1):
-    """
-    TODO: Make this its own module
-    :param text:str: Raw Text
-    :param nlc:int: New Line Count
-    :return:
-    """
-    new_lines = "\n" * nlc
-    with open(os.environ["GITHUB_STEP_SUMMARY"], "a") as f:
-        print(f"{text}{new_lines}", file=f)
-
-
-def get_input(name: str, req=False, low=False, strip=True, boolean=False, split="") -> Union[str, bool, list]:
-    """
-    Get Input by Name
-    :param name: str: Input Name
-    :param req: bool: If Required
-    :param low: bool: To Lower
-    :param strip: bool: To Strip
-    :param boolean: bool: If Boolean
-    :param split: str: To Split
-    :return: Union[str, bool, list]
-    """
-    value = os.environ.get(f"INPUT_{name.upper()}", "")
-    if boolean:
-        value = value.strip().lower()
-        if req and value not in true + false:
-            raise ValueError(f"Error Validating a Required Boolean Input: {name}")
-        if value in ["y", "yes", "true", "on"]:
-            return True
-        return False
-
-    if split:
-        result = []
-        for x in re.split(split, value):
-            result.append(_get_str_value(x, low, strip))
-        return result
-
-    value = _get_str_value(value, low, strip)
-    if req and not value:
-        raise ValueError(f"Error Parsing a Required Input: {name}")
-    return value
-
-
-def _get_str_value(value, low=False, strip=True):
-    if strip:
-        value = value.strip()
-    if low:
-        value = value.lower()
-    return value

actions_tools-0.0.1/tests/test_all.py

@@ -1,45 +0,0 @@
-import os
-
-import pytest
-
-from actions import core
-
-
-os.environ["INPUT_TEST"] = " TRUE "
-
-
-def test_print():
-    core.debug("debug")
-    core.info("info")
-    core.notice("notice")
-    core.warn("warn")
-    with pytest.raises(SystemExit):
-        core.set_failed("test")
-    core.mask("test")
-    core.start_group("test")
-    core.end_group()
-    core.start_indent(5)
-    core.info("indent")
-    core.end_indent()
-    core.info("dedent")
-
-
-def test_outputs():
-    if not os.environ.get("GITHUB_OUTPUT"):
-        os.environ["GITHUB_OUTPUT"] = "output.txt"
-    core.set_output("test", "value")
-    if not os.environ.get("GITHUB_ENV"):
-        os.environ["GITHUB_ENV"] = "output.txt"
-    core.set_env("test", "value")
-    if not os.environ.get("GITHUB_STEP_SUMMARY"):
-        os.environ["GITHUB_STEP_SUMMARY"] = "output.txt"
-    core.summary("test")
-
-
-def test_inputs():
-    assert core.get_input("test") == os.environ["INPUT_TEST"].strip()
-    assert core.get_input("test", low=True) == os.environ["INPUT_TEST"].strip().lower()
-    assert core.get_input("test", strip=False) == os.environ["INPUT_TEST"]
-    assert core.get_input("test", boolean=True)
-    assert isinstance(core.get_input("test", split="\n"), list)
-    assert len(core.get_input("test", split="\n")) == 1