actions-tools 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

actions/core.py

@@ -1,36 +1,46 @@
 import os
+import random
 import re
-from typing import Union
+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 = ""
 
 
-def debug(message: str):
-    print(f"::debug::{message}")
+# Core
 
 
-def info(message: str, **kwargs):
-    print(" " * _indent + message, **kwargs)
+def debug(message: str, *args, **kwargs):
+    print(f"::debug::{message}", *args, **kwargs)
 
 
-def notice(message: str):
-    print(f"::notice::{message}")
+def info(message: str, *args, **kwargs):
+    print(" " * _indent + message, *args, **kwargs)
 
 
-def warn(message: str):
-    print(f"::warning::{message}")
+def notice(message: str, *args, **kwargs):
+    print(f"::notice::{message}", *args, **kwargs)
 
 
-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 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):
@@ -50,24 +60,62 @@ def end_group():
     print("::endgroup::")
 
 
-def start_indent(spaces: int):
-    global _indent
-    _indent = spaces
+@contextmanager
+def with_group(title: str):
+    print(f"::group::{title}")
+    try:
+        yield info
+    finally:
+        print("::endgroup::")
 
 
-def end_indent():
-    global _indent
-    _indent = 0
+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(var: str, value: str):
+def set_env(name: str, value: str):
     with open(os.environ["GITHUB_ENV"], "a") as f:
-        print(f"{var}={value}", file=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):
@@ -77,11 +125,15 @@ def summary(text: str, nlc=1):
     :param nlc:int: New Line Count
     :return:
     """
-    new_lines = "\n" * nlc
+    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
@@ -93,7 +145,7 @@ def get_input(name: str, req=False, low=False, strip=True, boolean=False, split=
     :param split: str: To Split
     :return: Union[str, bool, list]
     """
-    value = os.environ.get(f"INPUT_{name.upper()}", "")
+    value = os.getenv(f"INPUT_{name.upper()}", "")
     if boolean:
         value = value.strip().lower()
         if req and value not in true + false:
@@ -120,3 +172,25 @@ def _get_str_value(value, low=False, strip=True):
     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.dist-info → actions_tools-0.0.2.dist-info}/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,7 @@
+actions/__init__.py,sha256=ZibxMd7km3HsR9w3bSQClEPt2dayYRNUGTOCf3oRHu0,273
+actions/core.py,sha256=5LOSu8VW7yfsY2YHiTyhY3ITbBYLPyWGkbHsexJzN78,4535
+actions_tools-0.0.2.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+actions_tools-0.0.2.dist-info/METADATA,sha256=OT37n-XIFX3x4pns9GCxXMOfDe4ZIo2xb-GumWan33I,7197
+actions_tools-0.0.2.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+actions_tools-0.0.2.dist-info/top_level.txt,sha256=5apM5x80QlJcGbACn1v3fkmIuL1-XQCKcItJre7w7Tw,8
+actions_tools-0.0.2.dist-info/RECORD,,

{actions_tools-0.0.1.dist-info → actions_tools-0.0.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

actions_tools-0.0.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-actions/__init__.py,sha256=ZibxMd7km3HsR9w3bSQClEPt2dayYRNUGTOCf3oRHu0,273
-actions/core.py,sha256=C0ERbAGnIk9gGuCVZI5KHOfQQUp5yGH-DB8d5nNDfXU,2767
-actions_tools-0.0.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-actions_tools-0.0.1.dist-info/METADATA,sha256=81Ngkerc2f55fF0qfr8yCgQPyxYcAYqZPi7o9cuF1Lo,6256
-actions_tools-0.0.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-actions_tools-0.0.1.dist-info/top_level.txt,sha256=5apM5x80QlJcGbACn1v3fkmIuL1-XQCKcItJre7w7Tw,8
-actions_tools-0.0.1.dist-info/RECORD,,