prepare-assignment 0.1.2__tar.gz → 0.2.0__tar.gz

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/PKG-INFO

@@ -1,18 +1,19 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: prepare-assignment
-Version: 0.1.2
+Version: 0.2.0
 Summary: Prepare assignment
 License: MIT
 Author: Bonajo
 Author-email: m.bonajo@fontys.nl
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<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
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: dacite (>=1.9.2,<2.0.0)
 Requires-Dist: gitpython (>=3.1.41,<4.0.0)
 Requires-Dist: importlib-resources (>=6.1.1,<7.0.0)
 Requires-Dist: jsonschema (>=4.21.1,<5.0.0)
@@ -33,7 +34,28 @@ Prepare assignment is a GitHub Actions inspired helper tool to prepare assignmen
 - Git
 - Python >=3.8
 
-## Example
+## Installation
+
+Prepare-assignment is available from [PyPI](https://pypi.org/).
+
+
+```bash
+# To install:
+python3 -m pip install prepare-assignment
+
+# To upgrade
+python3 -m pip install --upgrade prepare-assignment
+```
+
+## Executing prepare-assignment
+
+To execute a `prepare.yml` simply run `prepare run` from the same directory.
+
+### Command line interface
+
+Use `prepare --help` to which commands and flags are available.
+
+## Example `prepare.yml`
 
 First we need to have tasks available that can be executed. Take for example a look at the [remove](https://github.com/prepare-assignment/remove) task.
 
@@ -66,6 +88,19 @@ jobs:
 
 For people familiar with GitHub Actions this should look very familiar. We have jobs that indicate what should happen to prepare an assignment. The tasks are defined in their own repositories, if the `uses` tag doesn't have a username/organization, it will default to `prepare-assignment`. So for example the `remove` task uses the following repository: [prepare-assignment/remove](https://github.com/prepare-assignment/remove)
 
+## Config file
+
+It is possible to specify global options in a config file. The location of the config file can be found by running `prepare` without any commands.
+
+The following settings are available:
+
+```yml
+core:
+  git-mode: "ssh|https"
+  verbose: int
+  debug: int
+```
+
 ## Tasks
 
 There are three different kind of tasks available:

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/README.md

@@ -7,7 +7,28 @@ Prepare assignment is a GitHub Actions inspired helper tool to prepare assignmen
 - Git
 - Python >=3.8
 
-## Example
+## Installation
+
+Prepare-assignment is available from [PyPI](https://pypi.org/).
+
+
+```bash
+# To install:
+python3 -m pip install prepare-assignment
+
+# To upgrade
+python3 -m pip install --upgrade prepare-assignment
+```
+
+## Executing prepare-assignment
+
+To execute a `prepare.yml` simply run `prepare run` from the same directory.
+
+### Command line interface
+
+Use `prepare --help` to which commands and flags are available.
+
+## Example `prepare.yml`
 
 First we need to have tasks available that can be executed. Take for example a look at the [remove](https://github.com/prepare-assignment/remove) task.
 
@@ -40,6 +61,19 @@ jobs:
 
 For people familiar with GitHub Actions this should look very familiar. We have jobs that indicate what should happen to prepare an assignment. The tasks are defined in their own repositories, if the `uses` tag doesn't have a username/organization, it will default to `prepare-assignment`. So for example the `remove` task uses the following repository: [prepare-assignment/remove](https://github.com/prepare-assignment/remove)
 
+## Config file
+
+It is possible to specify global options in a config file. The location of the config file can be found by running `prepare` without any commands.
+
+The following settings are available:
+
+```yml
+core:
+  git-mode: "ssh|https"
+  verbose: int
+  debug: int
+```
+
 ## Tasks
 
 There are three different kind of tasks available:

prepare_assignment-0.2.0/prepare_assignment/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("prepare_assignment")

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/cli/main.py

@@ -1,19 +1,36 @@
+import os.path
+import sys
 from typing import Optional
 
 import typer
 from typing_extensions import Annotated
 
+from prepare_assignment import __version__
 from prepare_assignment.cli.task import app as task_app
 from prepare_assignment.cli.tasks import app as tasks_app
 from prepare_assignment.core.main import prepare
 from prepare_assignment.data.config import GitMode
 from prepare_assignment.data.constants import CONFIG
+from prepare_assignment.utils.paths import get_config_path
+from prepare_assignment.utils.virtual_env import get_virtualenv_name
 
 app = typer.Typer(invoke_without_command=True)
 app.add_typer(task_app, name="task")
 app.add_typer(tasks_app, name="tasks")
 
 
+@app.callback(invoke_without_command=True)
+def main(ctx: typer.Context):
+    if ctx.invoked_subcommand is None:
+        config_path = os.path.join(get_config_path(), 'config.yml')
+        config_exists = os.path.exists(config_path)
+        typer.echo(f"Prepare version: {__version__}")
+        typer.echo(f"Config in use: {config_exists}")
+        typer.echo(f"Config path: {config_path}")
+        typer.echo(f"Python version: {sys.version.split(' ')[0]}")
+        typer.echo(f"Virtual env: {get_virtualenv_name()}")
+
+
 @app.command()
 def run(
     file_name: Annotated[
@@ -23,22 +40,22 @@ def run(
     git: Annotated[
         GitMode,
         typer.Option(case_sensitive=False, help="Clone mode for git, options are 'ssh' (default) or 'https'")
-    ] = GitMode.ssh,
+    ] = CONFIG.core.git_mode,
     debug: Annotated[
         int,
         typer.Option("--debug", "-d", count=True, help="increase debug verbosity for prepare assignment")
-    ] = 0,
+    ] = CONFIG.core.debug,
     verbose: Annotated[
         int,
         typer.Option("--verbose", "-v", count=True, help="increase task output verbosity")
-    ] = 0
+    ] = CONFIG.core.verbose
 ):
     """
     Parse 'prepare_assignment.y(a)ml' and execute all jobs
     """
-    CONFIG.DEBUG = debug  # type: ignore
-    CONFIG.GIT_MODE = git # type: ignore
-    CONFIG.VERBOSITY = verbose  # type: ignore
+    CONFIG.core.debug = debug  # type: ignore
+    CONFIG.core.git_mode = git # type: ignore
+    CONFIG.core.verbose = verbose  # type: ignore
 
     prepare(file_name)
 

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/core/main.py

@@ -8,10 +8,11 @@ from prepare_toolbox.file import get_matching_files
 from prepare_assignment.core.preparer import prepare_tasks
 from prepare_assignment.core.runner import run
 from prepare_assignment.core.validator import validate_prepare
-from prepare_assignment.data.constants import CONFIG, YAML_LOADER
+from prepare_assignment.data.constants import CONFIG
 from prepare_assignment.data.errors import PrepareTaskError, PrepareError
 from prepare_assignment.data.prepare import Prepare
 from prepare_assignment.utils.logger import add_logging_level, set_logger_level
+from prepare_assignment.utils.yml_loader import YAML_LOADER
 
 
 def __get_prepare_file(file: Optional[str]) -> str:
@@ -44,8 +45,8 @@ def prepare(file_name: Optional[str]) -> None:
     add_logging_level("TRACE", logging.DEBUG - 5, "trace")
     logger = logging.getLogger("prepare_assignment")
     tasks_logger = logging.getLogger("tasks")
-    set_logger_level(logger, CONFIG.DEBUG)
-    set_logger_level(tasks_logger, CONFIG.VERBOSITY, prefix="\t[TASK] ", debug_linenumbers=False)
+    set_logger_level(logger, CONFIG.core.debug)
+    set_logger_level(tasks_logger, CONFIG.core.verbose, prefix="\t[TASK] ", debug_linenumbers=False)
 
     try:
         # Get the prepare_assignment.yml file

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/core/preparer.py

@@ -19,7 +19,7 @@ from prepare_assignment.data.errors import DependencyError, ValidationError, Pre
 from prepare_assignment.data.task_definition import TaskDefinition, CompositeTaskDefinition, \
     PythonTaskDefinition, ValidableTask
 from prepare_assignment.data.task_properties import TaskProperties
-from prepare_assignment.utils.cache import get_cache_path, get_tasks_path
+from prepare_assignment.utils.paths import get_cache_path, get_tasks_path
 
 # Set the cache path
 cache_path = get_cache_path()
@@ -40,7 +40,7 @@ def __download_task(props: TaskProperties) -> Path:
     """
     props.repo_path.mkdir(parents=True, exist_ok=True)
     git_url: str
-    if CONFIG.GIT_MODE == "https":
+    if CONFIG.core.git_mode == "https":
         git_url = f"https://github.com/{props.organization}/{props.name}.git"
     else:
         git_url = f"git@github.com:{props.organization}/{props.name}.git"

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/core/runner.py

@@ -1,3 +1,4 @@
+import copy
 import json
 import logging
 import os.path
@@ -107,6 +108,7 @@ def __handle_task(mapping: Dict[str, TaskDefinition],
             sub_env = environment.environment.copy()
             sub_environment = JobEnvironment(sub_env, outputs={}, inputs=task.with_)  # type: ignore
             for subtask in task_definition.tasks:  # type: ignore
+                subtask = copy.deepcopy(subtask)
                 subtask = Task.of(subtask)
                 __handle_task(mapping, subtask, sub_environment)
         else:

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/core/subsituter.py

@@ -73,9 +73,9 @@ def __substitute(value: str, environment: JobEnvironment, is_list: bool = False)
     })
     previous = 0
     result = ""
-    for sub in substitutions:
-        result += value[previous:sub["start"]] + sub["sub"]
-        previous = sub["end"]
+    for sub in substitutions: # type: ignore
+        result += value[previous:sub["start"]] + sub["sub"] # type: ignore
+        previous = sub["end"] # type: ignore
     return result
 
 

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/core/task_handler.py

@@ -2,19 +2,18 @@ import logging
 import os.path
 import shutil
 import sys
-from pathlib import Path
 from typing import Set
 
 import typer
 from treelib import Tree
 
 from prepare_assignment.core.preparer import __prepare_tasks
-from prepare_assignment.data.constants import YAML_LOADER
 from prepare_assignment.data.task_definition import TaskDefinition
 from prepare_assignment.data.task_properties import TaskProperties
-from prepare_assignment.utils.cache import get_tasks_path
 from prepare_assignment.utils.dependency import get_dependencies
+from prepare_assignment.utils.paths import get_tasks_path
 from prepare_assignment.utils.tasks import get_all_tasks
+from prepare_assignment.utils.yml_loader import YAML_LOADER
 
 logger = logging.getLogger("prepare_assignment")
 tasks_path = get_tasks_path()

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/core/validator.py

@@ -9,12 +9,11 @@ from typing import Dict, Any, Type
 from importlib_resources import files
 from jsonschema.exceptions import ValidationError
 from jsonschema.validators import validate
-from ruamel.yaml import YAML
 
-from prepare_assignment.data.constants import YAML_LOADER
-from prepare_assignment.data.task_definition import TaskDefinition
 from prepare_assignment.data.errors import ValidationError as VE
+from prepare_assignment.data.task_definition import TaskDefinition
 from prepare_assignment.utils.default_validator import DefaultValidatingValidator
+from prepare_assignment.utils.yml_loader import YAML_LOADER
 
 logger = logging.getLogger("prepare_assignment")
 

prepare_assignment-0.2.0/prepare_assignment/data/config.py

@@ -0,0 +1,20 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Final, Literal, Optional
+
+
+class GitMode(str, Enum):
+    ssh = "ssh"
+    https = "https"
+
+
+@dataclass
+class Core:
+    git_mode: GitMode = GitMode.ssh
+    verbose: int = 0
+    debug: int = 0
+
+
+@dataclass
+class Config:
+    core: Core

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/data/constants.py

@@ -1,13 +1,9 @@
 import logging
-import os
 import re
-import shutil
-import sys
 from typing import Final, Dict, Type, List
 
-from ruamel.yaml import YAML
-
 from prepare_assignment.data.config import Config
+from prepare_assignment.utils.config import load_config
 from prepare_assignment.utils.executables import get_bash_path
 
 TYPE_MAPPING: Final[Dict[str, Type]] = {
@@ -31,10 +27,6 @@ SUB_REGEX: Final[re.Pattern] = re.compile("|".join(SUBSTITUTIONS))
 
 LOG_LEVEL_TRACE: Final[int] = logging.DEBUG - 5
 
-CONFIG: Config = Config()
+CONFIG: Config = load_config()
 
 BASH_EXECUTABLE: Final[str] = get_bash_path()
-
-YAML_LOADER = YAML(typ='safe')
-YAML_LOADER.brace_single_entry_mapping_in_flow_sequence = False
-YAML_LOADER.default_flow_style = True

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/data/task_properties.py

@@ -5,7 +5,7 @@ from dataclasses import dataclass
 from functools import cached_property
 from pathlib import Path
 
-from prepare_assignment.utils.cache import get_tasks_path
+from prepare_assignment.utils.paths import get_tasks_path
 
 tasks_path = get_tasks_path()
 

prepare_assignment-0.2.0/prepare_assignment/schemas/config.schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "prepare-config",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "core": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "git-mode": {
+          "description": "The mode git should use to checkout tasks",
+          "type": "string",
+          "enum": [
+            "ssh",
+            "https"
+          ],
+          "default": "ssh"
+        },
+        "debug": {
+          "description": "The level of debug messages to show",
+          "type": "integer",
+          "default": 0
+        },
+        "verbose": {
+          "description": "The level of verbosity",
+          "type": "integer",
+          "default": 0
+        }
+      }
+    }
+  }
+}

prepare_assignment-0.2.0/prepare_assignment/utils/config.py

@@ -0,0 +1,56 @@
+import json
+import os.path
+from enum import Enum
+from typing import Dict, Any
+
+import dacite
+from dacite import from_dict
+from importlib_resources import files
+from pathlib import Path
+
+from jsonschema import validate, ValidationError
+
+from prepare_assignment.data.config import Config, Core
+from prepare_assignment.data.errors import ValidationError as VE
+from prepare_assignment.utils.paths import get_config_path
+from prepare_assignment.utils.yml_loader import YAML_LOADER
+
+
+def __convert_keys(obj: Any) -> Any:
+    if isinstance(obj, dict):
+        return {k.replace("-", "_"): __convert_keys(v) for k, v in obj.items()}
+    if isinstance(obj, list):
+        return [__convert_keys(i) for i in obj]
+    return obj
+
+
+def __validate_config(config_path: Path, config: Dict[str, Any]) -> None:
+    schema_path = files().joinpath('../schemas/config.schema.json')
+    schema: Dict[str, Any] = json.loads(schema_path.read_text())
+
+    # Validate config.yml
+    try:
+        validate(config, schema)
+    except ValidationError as ve:
+        message = f"Error in config file: {config_path}, unable to verify '{ve.json_path}'\n\t -> {ve.message}"
+        raise VE(message)
+
+
+def load_config() -> Config:
+    config_path = Path(os.path.join(get_config_path(), "config.yml"))
+    config = Config(Core())
+    if not config_path.is_file():
+        return config
+    yaml = YAML_LOADER.load(config_path)
+    # If the file is empty it is still valid config, but validator will fail with None
+    if not yaml:
+        return config
+
+    __validate_config(config_path, yaml)
+    converted_yaml = __convert_keys(yaml)
+    config = from_dict(
+        data_class=Config,
+        data=converted_yaml,
+        config=dacite.Config(cast=[Enum])
+    )
+    return config

prepare_assignment-0.1.2/prepare_assignment/utils/cache.py → prepare_assignment-0.2.0/prepare_assignment/utils/paths.py

@@ -2,12 +2,37 @@ import os
 import sys
 
 from pathlib import Path
-from typing import Final
+from typing import Final, Optional
 
 TASKS_PATH: Final[str] = "tasks"
 
 __cache_path = None
 __tasks_path = None
+__config_path: Optional[Path] = None
+
+
+def get_config_path() -> Path:
+    """
+    Get the path to the default config location for applications
+    :return: Path to the OS specific application config location
+    :raises: AssertionError: if OS is not one of Linux, macOS or Windows
+    """
+    global __config_path
+    if __config_path:
+        return __config_path
+    if sys.platform == "linux":
+        config = os.environ.get("XDG_CONFIG_HOME")
+        if config is None:
+            config = "~/.config"
+        __config_path = Path(os.path.join(config, "prepare")).expanduser()
+    elif sys.platform == "darwin":
+        __config_path = Path("~/Library/Application Support/prepare").expanduser()
+    elif sys.platform == "win32":
+        ad = f"{os.environ.get('APPDATA')}"
+        __config_path = Path(os.path.join(ad, "prepare")).expanduser()
+    else:
+        raise AssertionError("Unsupported OS")
+    return __config_path
 
 
 def get_cache_path() -> Path:

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/prepare_assignment/utils/tasks.py

@@ -1,10 +1,10 @@
 import os
 from typing import List
 
-from prepare_assignment.data.constants import YAML_LOADER
 from prepare_assignment.data.task_definition import TaskDefinition
 from prepare_assignment.data.task_properties import TaskProperties
-from prepare_assignment.utils.cache import get_tasks_path
+from prepare_assignment.utils.paths import get_tasks_path
+from prepare_assignment.utils.yml_loader import YAML_LOADER
 
 
 def get_all_tasks() -> List[TaskProperties]:

prepare_assignment-0.2.0/prepare_assignment/utils/virtual_env.py

@@ -0,0 +1,15 @@
+import os
+
+
+def is_virtualenv_active() -> bool:
+    """Check if a virtual environment is active (including Poetry environments)."""
+    # Check if the VIRTUAL_ENV environment variable is set, which indicates a virtualenv is active
+    return os.getenv("VIRTUAL_ENV") is not None
+
+
+def get_virtualenv_name() -> str:
+    """Get the name of the active virtual environment (works with Poetry as well)."""
+    virtualenv_path = os.getenv("VIRTUAL_ENV")
+    if virtualenv_path:
+        return os.path.basename(virtualenv_path)  # Get the name from the virtualenv path
+    return "None (not active)"

prepare_assignment-0.2.0/prepare_assignment/utils/yml_loader.py

@@ -0,0 +1,5 @@
+from ruamel.yaml import YAML
+
+YAML_LOADER = YAML(typ='safe')
+YAML_LOADER.brace_single_entry_mapping_in_flow_sequence = False
+YAML_LOADER.default_flow_style = True

{prepare_assignment-0.1.2 → prepare_assignment-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "prepare-assignment"
-version = "0.1.2"
+version = "0.2.0"
 description = "Prepare assignment"
 authors = ["Bonajo <m.bonajo@fontys.nl>"]
 license = "MIT"
@@ -12,7 +12,7 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.9"
 ruamel-yaml = "^0.18.5"
 jsonschema = "^4.21.1"
 importlib-resources = "^6.1.1"
@@ -22,6 +22,7 @@ virtualenv = "^20.25.0"
 typer = {extras = ["all"], version = "^0.9.0"}
 treelib = "^1.7.0"
 multipledispatch = "^1.0.0"
+dacite = "^1.9.2"
 
 [tool.poetry.group.test.dependencies]
 mypy = "^1.1.1"

prepare_assignment-0.1.2/prepare_assignment/data/config.py

@@ -1,15 +0,0 @@
-from dataclasses import dataclass
-from enum import Enum
-from typing import Final, Literal
-
-
-class GitMode(str, Enum):
-    ssh = "ssh"
-    https = "https"
-
-
-@dataclass
-class Config:
-    GIT_MODE: Final[GitMode] = GitMode.ssh
-    VERBOSITY: Final[int] = 0
-    DEBUG: Final[int] = 0

prepare_assignment-0.1.2/prepare_assignment/data/dependency_graph.py

@@ -1,33 +0,0 @@
-from typing import Dict, List
-
-
-class Vertex:
-
-    def __init__(self):
-        self.dependents = []
-        self.dependencies = []
-
-
-class DependencyGraph:
-
-    def __init__(self):
-        self.vertices: Dict[str, Vertex] = {}
-
-    def add_node(self, name: str) -> None:
-        if name in self.vertices:
-            return
-        self.vertices[name] = Vertex()
-
-    def add_dependency(self, dependent: str, dependency: str) -> None:
-        self.add_node(dependent)
-        self.add_node(dependency)
-        self.vertices[dependent].dependencies.append(dependency)
-        self.vertices[dependency].dependents.append(dependent)
-
-    def in_degree(self, name: str) -> int:
-        vertex = self.vertices[name]
-        return 0 if vertex is None else len(vertex.dependents)
-
-    def out_degree(self, name: str) -> int:
-        vertex = self.vertices[name]
-        return 0 if vertex is None else len(vertex.dependencies)