UEPyScripts 1.2.3__tar.gz → 1.2.5__tar.gz

{uepyscripts-1.2.3 → uepyscripts-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UEPyScripts
-Version: 1.2.3
+Version: 1.2.5
 Summary: Collection of Python tools and helpers designed to automate common Unreal Engine project tasks (builds, packaging, editor control, CI tasks, etc.).
 Project-URL: Changelog, https://github.com/TheEmidee/UEPyScripts/releases
 Project-URL: Homepage, https://github.com/TheEmidee/UEPyScripts
@@ -248,6 +248,27 @@ How the script works:
   .\setup-venv.ps1
   ```
 
+- In VS Code, you can create a `launch.json` file like this one. It's important to use the `module` setting so that relative imports don't raise exceptions.
+
+```
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uepyscripts.tools.ue.copy_engine_buildgraph_tasks",
+            "cwd": "ABSOLUTE_PATH_TO_PROJECT",
+            "console": "integratedTerminal",
+            "args": [
+                "--uproject_path=D:\\PATH_TO_UPROJECT.uproject"
+            ]
+        }
+    ]
+}
+```
+
 - Linting & formatting
   - Use `uv run ruff check .` and `uv run ruff format .` Add checks to CI as required.
   - Use `uv run mypy .`
@@ -262,8 +283,11 @@ We welcome contributions — please follow these steps:
 
 1. Fork the repository
 2. Create a feature branch: `git checkout -b feature/your-change`
+3. Add entries in the .changelog folder for towncrier. You can read the [README](.changelog/README.md) file for more information.
 4. Run lint locally
-5. Submit a pull request describing the change
+5. Update documentation
+6. Submit a pull request describing the change
+
 
 ---
 

{uepyscripts-1.2.3 → uepyscripts-1.2.5}/README.md

@@ -168,6 +168,27 @@ How the script works:
   .\setup-venv.ps1
   ```
 
+- In VS Code, you can create a `launch.json` file like this one. It's important to use the `module` setting so that relative imports don't raise exceptions.
+
+```
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uepyscripts.tools.ue.copy_engine_buildgraph_tasks",
+            "cwd": "ABSOLUTE_PATH_TO_PROJECT",
+            "console": "integratedTerminal",
+            "args": [
+                "--uproject_path=D:\\PATH_TO_UPROJECT.uproject"
+            ]
+        }
+    ]
+}
+```
+
 - Linting & formatting
   - Use `uv run ruff check .` and `uv run ruff format .` Add checks to CI as required.
   - Use `uv run mypy .`
@@ -182,8 +203,11 @@ We welcome contributions — please follow these steps:
 
 1. Fork the repository
 2. Create a feature branch: `git checkout -b feature/your-change`
+3. Add entries in the .changelog folder for towncrier. You can read the [README](.changelog/README.md) file for more information.
 4. Run lint locally
-5. Submit a pull request describing the change
+5. Update documentation
+6. Submit a pull request describing the change
+
 
 ---
 

{uepyscripts-1.2.3 → uepyscripts-1.2.5}/src/uepyscripts/internal/engine.py

@@ -47,12 +47,14 @@ class Engine:
         self.project = project
         self.root_path = root_path
         self.path = self.root_path.joinpath("Engine").resolve()
+        self.build_path = self.path.joinpath("Build").resolve()
+        self.batchfiles_path = self.build_path.joinpath("BatchFiles").resolve()
         self.version = self.get_version_number()
-        self.uat_path = self.Runner(self.path.joinpath("Build/BatchFiles/RunUAT.bat"), True)
+        self.uat_path = self.Runner(self.batchfiles_path.joinpath("RunUAT.bat"), True)
         self.ubt_path = self.Runner(
             self.path.joinpath("Binaries/DotNET/UnrealBuildTool/UnrealBuildTool.exe"), True, True, [str(self.project.uproject_path)]
         )
-        self.build_bat_path = self.Runner(self.path.joinpath("Build/BatchFiles/Build.bat"), True)
+        self.build_bat_path = self.Runner(self.batchfiles_path.joinpath("Build.bat"), True)
         self.editor_exe_path = self.Runner(self.path.joinpath("Binaries/Win64/UnrealEditor.exe"), False, False, [str(self.project.uproject_path)])
 
     def uat(self, args: list[str] = []) -> int:
@@ -70,7 +72,7 @@ class Engine:
     def get_version_number(self) -> Version:
         version = ""
 
-        with open(self.path.joinpath("Build/Build.version")) as build_version_file:
+        with open(self.build_path.joinpath("Build.version")) as build_version_file:
             version_json = json.load(build_version_file)
             major = version_json["MajorVersion"]
             minor = version_json["MinorVersion"]
@@ -80,7 +82,7 @@ class Engine:
         if version == "":
             raise Exception("Impossible to find the version number of the engine")
 
-        jenkins_file = Path(self.path.joinpath("Build/JenkinsBuild.version"))
+        jenkins_file = Path(self.build_path.joinpath("JenkinsBuild.version"))
 
         if jenkins_file.exists():
             with open(jenkins_file) as jenkins_version_file:

{uepyscripts-1.2.3 → uepyscripts-1.2.5}/src/uepyscripts/internal/project.py

@@ -68,11 +68,14 @@ def find_parent_with_project_file(starting_path: Path, max_parents: int = 10) ->
     return None
 
 
-def resolve_project() -> Project:
-    dir_path = Path(os.path.dirname(os.path.realpath(__file__)))
-    uproject_path = find_parent_with_project_file(dir_path)
+def resolve_project(uproject_path: Optional[Path] = None) -> Project:
     if not uproject_path:
-        raise Exception(f"Could not find a uproject file from {dir_path}")
+        dir_path = Path(os.path.dirname(os.path.realpath(__file__)))
+        uproject_path = find_parent_with_project_file(dir_path)
+        if not uproject_path:
+            raise Exception(f"Could not find a uproject file from {dir_path}")
+    elif not uproject_path.exists():
+        raise Exception(f"{uproject_path} is not a valid file")
 
     logger.debug(f"Found uproject file at {uproject_path}")
     project = Project(uproject_path)

{uepyscripts-1.2.3 → uepyscripts-1.2.5}/src/uepyscripts/run/buildgraph.py

@@ -30,7 +30,7 @@ def run(target: str, arguments: list[str]) -> int:
 
     uat_arguments.append(f"-Project={project.uproject_path}")
 
-    automation_scripts_directories = config["Project"]["AutomationScriptsDirectories"]
+    automation_scripts_directories = config["Project"].get("AutomationScriptsDirectories")
     if automation_scripts_directories == "" or automation_scripts_directories is None:
         logger.info("No automation scripts directory is set")
     else:
@@ -46,11 +46,15 @@ def run(target: str, arguments: list[str]) -> int:
             logger.info(f"Automation Scripts directory set to {automation_scripts_path}")
             uat_arguments.append(f"-ScriptDir={automation_scripts_path}")
 
-    shared_properties = dict(pair.split("=") for pair in config["Project"]["BuildgraphSharedProperties"].split("+"))
+    shared_properties_str = config["Project"].get("BuildgraphSharedProperties", "")
+    if shared_properties_str == "" or shared_properties_str is None:
+        logger.info("No shared properties to set")
+    else:
+        shared_properties = dict(pair.split("=") for pair in shared_properties_str.split("+")) if shared_properties_str else {}
 
-    if shared_properties is not None:
-        for key, value in shared_properties.items():
-            uat_arguments.append(f"-set:{key}={value}")
+        if shared_properties is not None:
+            for key, value in shared_properties.items():
+                uat_arguments.append(f"-set:{key}={value}")
 
     for arg in arguments:
         uat_arguments.append(arg)