prepare-toolbox 0.1.0__tar.gz

prepare_toolbox-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 prepare-assignment
+
+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.

prepare_toolbox-0.1.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.1
+Name: prepare-toolbox
+Version: 0.1.0
+Summary: Toolbox containing helper functions for prepare-assignment actions
+License: MIT
+Author: Bonajo
+Author-email: m.bonajo@fontys.nl
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: braceexpand (>=0.1.7,<0.2.0)
+Description-Content-Type: text/markdown
+
+# toolbox

prepare_toolbox-0.1.0/README.md

@@ -0,0 +1 @@
+# toolbox

prepare_toolbox-0.1.0/prepare_toolbox/core.py

@@ -0,0 +1,16 @@
+import json
+import os
+from typing import Any
+
+
+def get_input(key: str) -> Any:
+    """
+    Get input passed to the action
+    :param key: The key of the input
+    :return: value of the key if present, None otherwise
+    """
+    sanitized = key.replace(" ", "_").upper()
+    value = os.environ.get(f"PREPARE_{sanitized}")
+    if value is not None:
+        return json.loads(value)
+    return None

prepare_toolbox-0.1.0/prepare_toolbox/file.py

@@ -0,0 +1,51 @@
+import glob
+import os
+import sys
+from pathlib import Path
+from typing import Union, List, Iterable, Set, Iterator
+
+from braceexpand import braceexpand
+
+
+def __expand(path: str) -> Iterator[str]:
+    if sys.platform == "win32":
+        return braceexpand(path, escape=False)
+    return braceexpand(path)
+
+
+def __get_matching_files(globs: Union[str, List[str]], relative_to: Union[str, Path, None] = None,
+                         recursive: bool = True) -> Set[str]:
+    if globs is None:
+        raise ValueError("Cannot find matching files without included glob")
+    if not isinstance(globs, list):
+        globs = [globs]
+    matched: Set[str] = set()
+    if relative_to is not None:
+        relative_to = Path(os.path.join(os.getcwd(), relative_to))
+    else:
+        relative_to = Path(os.getcwd())
+    for g in globs:
+        path = os.path.join(relative_to, g)
+        for expanded in __expand(path):
+            for file in glob.glob(expanded, recursive=recursive):
+                relative = Path(file).relative_to(relative_to)
+                matched.add(str(relative))
+    return matched
+
+
+def get_matching_files(included: Union[str, List[str]], excluded: Union[str, List[str], None] = None,
+                       relative_to: Union[str, Path, None] = None, recursive: bool = True) -> List[str]:
+    """
+    Get files matching the included glob and not matching the excluded glob.
+    :param included: Glob(s) that should be matched
+    :param excluded: Glob(s) that should not be matched
+    :param relative_to: Set relative path, the globs are matched relative to this path, defaults to pwd
+    :param recursive: Whether the glob should recurse directories
+    :return List[str]: List of matched files (as posix strings)
+    :raises ValueError: If any of the matched files is outside the relative_to directory (or its children)
+    """
+    matched_included = __get_matching_files(included, relative_to=relative_to, recursive=recursive)
+    if excluded is not None:
+        matched_excluded = __get_matching_files(excluded, relative_to=relative_to, recursive=recursive)
+        matched_included -= matched_excluded
+    return sorted(list(matched_included))

prepare_toolbox-0.1.0/prepare_toolbox/zip.py

@@ -0,0 +1,23 @@
+import os.path
+from typing import List, Optional
+from zipfile import ZipFile
+
+
+def create_zip(name: str, files: List[str], output: Optional[str] = None) -> None:
+    """
+    Create a zip file with a name and the given files.
+    Optionally give an output path where the file should be written
+    :param name: Name of the archive
+    :param files: Files that should be added to the archive
+    :param output: output directory
+    :return: None
+    """
+    file = name
+    n, extension = os.path.splitext(name)
+    if extension is None or extension != ".zip":
+        file += ".zip"
+    if output:
+        file = os.path.join(output, file)
+    with ZipFile(file, 'w') as handle:
+        for f in files:
+            handle.write(f)

prepare_toolbox-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[tool.poetry]
+name = "prepare-toolbox"
+version = "0.1.0"
+description = "Toolbox containing helper functions for prepare-assignment actions"
+authors = ["Bonajo <m.bonajo@fontys.nl>"]
+license = "MIT"
+readme = "README.md"
+packages = [{include = "prepare_toolbox"}]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+braceexpand = "^0.1.7"
+
+
+[tool.poetry.group.test.dependencies]
+pytest = "^7.4.0"
+mypy = "^1.4.1"
+pytest-cov = "^4.1.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"