unity-devkit 0.1.0__py3-none-any.whl

unity_devkit/unity.py

@@ -0,0 +1,173 @@
+import shutil
+import sys
+import tempfile
+from pathlib import Path
+from typing import TypedDict
+
+from bashrun import CalledProcessError, bash, bash_pipe
+
+from .projects import UnityProject, load_unity_projects
+
+
+class PlatformConfig(TypedDict):
+    build_flag: str
+    module: str
+
+
+PLATFORM_CONFIGS: dict[str, PlatformConfig] = {
+    "android-mobile": {"build_flag": "-buildTarget Android", "module": "android"},
+    "magicleap": {"build_flag": "-buildTarget Android", "module": "android"},
+    "linux64": {"build_flag": "-buildTarget StandaloneLinux64", "module": "linux-il2cpp"},
+    "win64": {"build_flag": "-buildTarget Win64", "module": "windows-mono"},
+}
+
+UNITYCI_IMAGE_REVISION = "3"
+LICENSE_MODULE = "linux-il2cpp"
+
+# Unity exits 0 while reporting fatal package-manager errors only in the editor log. Every
+# Unity invocation goes through run_unity_batchmode, which scans the captured log for these
+# signatures and fails regardless of the exit code. Extend the tuple as new silent failures
+# are discovered.
+QUIET_FAILURE_SIGNATURES = ("An error occurred while resolving packages:",)
+QUIET_FAILURE_BLOCK_LINE_LIMIT = 20
+
+
+def find_unity_editor(project_path: Path) -> str:
+    try:
+        editor = find_editor_for_version(read_editor_version(project_path))
+    except ValueError as error:
+        raise SystemExit(str(error)) from error
+    return str(editor)
+
+
+def find_editor_for_version(version: str) -> Path:
+    path_editor = shutil.which("unity-editor")
+    if path_editor:
+        return Path(path_editor)
+
+    if sys.platform == "win32":
+        candidates = [Path(f"C:/Program Files/Unity/Hub/Editor/{version}/Editor/Unity.exe")]
+    else:
+        candidates = [
+            Path(f"/opt/unity/{version}/Editor/Unity"),
+            Path.home() / f"Unity/Hub/Editor/{version}/Editor/Unity",
+        ]
+
+    for candidate in candidates:
+        if candidate.is_file():
+            return candidate
+
+    searched = ", ".join(str(candidate) for candidate in candidates)
+    raise ValueError(f"Cannot find Unity {version} editor. Searched: {searched}")
+
+
+def read_editor_version(project_path: Path) -> str:
+    version_file = project_path / "ProjectSettings" / "ProjectVersion.txt"
+    version = editor_version(project_path)
+    if version is not None:
+        return version
+    if not version_file.exists():
+        raise SystemExit(f"Cannot find {version_file} — is this a Unity project?")
+    raise SystemExit(f"Cannot parse editor version from {version_file}")
+
+
+def editor_version(project_path: Path) -> str | None:
+    version_file = project_path / "ProjectSettings" / "ProjectVersion.txt"
+    if not version_file.exists():
+        return None
+    for line in version_file.read_text().splitlines():
+        if line.startswith("m_EditorVersion:"):
+            return line.split(":", 1)[1].strip()
+    return None
+
+
+def prepare_unity_project(project_path: Path) -> None:
+    stale_lockfile = project_path / "Temp" / "UnityLockfile"
+    if stale_lockfile.exists():
+        stale_lockfile.unlink()
+
+    bash("dotnet tool restore")
+    bash(f"dotnet nugetforunity restore {project_path}")
+
+
+def unity_batchmode_command(project_path: Path, nographics: bool = True, *, auto_quit: bool = True) -> str:
+    editor = find_unity_editor(project_path)
+    # Player builds need a real GfxDevice: Unity 6 compresses Android textures (ASTC/ETC2) on the
+    # GPU, and under -nographics the Null device falls back to a path that produces corrupt textures.
+    # xvfb-run (added below) supplies the display the dropped -nographics would otherwise stand in for.
+    graphics_flag = " -nographics" if nographics else ""
+    quit_flag = " -quit" if auto_quit else ""
+    command = f"{editor} -batchmode{graphics_flag}{quit_flag} -projectPath {project_path.resolve()}"
+    if sys.platform != "win32":
+        if shutil.which("xvfb-run"):
+            command = f"xvfb-run {command}"
+        # Unity runs `adb kill-server` on Android build teardown; strip the
+        # env var so the kill lands on a local daemon, not whatever
+        # ADB_SERVER_SOCKET points at.
+        command = f"env -u ADB_SERVER_SOCKET {command}"
+    return command
+
+
+def run_unity_batchmode(
+    project_path: Path,
+    extra_flags: str = "",
+    *,
+    nographics: bool = True,
+    auto_quit: bool = True,
+    strict_exit: bool = True,
+) -> None:
+    log_path = Path(tempfile.mkdtemp(prefix="unity-devkit-")) / "editor.log"
+    command = (
+        f"{unity_batchmode_command(project_path, nographics=nographics, auto_quit=auto_quit)} {extra_flags}"
+    ).strip()
+    command = f"{command} -logFile /dev/stdout"
+    returncode = 0
+    try:
+        if shutil.which("tee"):
+            bash_pipe(command, f"tee {log_path}")
+        else:
+            bash(command, log_path=log_path)
+    except CalledProcessError as error:
+        returncode = error.returncode
+    failure_block = quiet_failure_block(log_path)
+    if failure_block is not None:
+        raise SystemExit(f"Unity reported a package-manager failure (exit code {returncode}):\n{failure_block}")
+    if returncode != 0 and strict_exit:
+        raise SystemExit(f"Unity exited {returncode}; full editor log at {log_path}")
+    if returncode != 0:
+        print(f"  WARNING: Unity exited {returncode}; no package-manager failure found — full editor log at {log_path}")
+
+
+def quiet_failure_block(log_path: Path) -> str | None:
+    lines = log_path.read_text(encoding="utf-8", errors="replace").splitlines()
+    for index, line in enumerate(lines):
+        if not any(signature in line for signature in QUIET_FAILURE_SIGNATURES):
+            continue
+        block: list[str] = []
+        for candidate in lines[index : index + QUIET_FAILURE_BLOCK_LINE_LIMIT]:
+            if block and not candidate.strip():
+                break
+            block.append(candidate)
+        return "\n".join(block)
+    return None
+
+
+def resolve_unity_build(project: str, build: str) -> tuple[UnityProject, str, str]:
+    projects = load_unity_projects()
+    if project not in projects:
+        raise SystemExit(f"Unknown project '{project}'. Valid: {', '.join(projects)}")
+
+    project_config = projects[project]
+    valid_builds = project_config.builds or []
+    if build not in valid_builds:
+        valid = ", ".join(valid_builds) or "(none defined)"
+        raise SystemExit(f"Unknown build '{build}' for project '{project}'. Valid: {valid}")
+
+    execute_method = (project_config.execute_methods or {}).get(build)
+    if not execute_method:
+        raise SystemExit(f"No execute method for project '{project}' build '{build}'")
+
+    if build not in PLATFORM_CONFIGS:
+        raise SystemExit(f"No platform config for build '{build}'. Valid: {', '.join(PLATFORM_CONFIGS)}")
+
+    return project_config, PLATFORM_CONFIGS[build]["build_flag"], execute_method

unity_devkit-0.1.0.dist-info/METADATA

@@ -0,0 +1,11 @@
+Metadata-Version: 2.5
+Name: unity-devkit
+Version: 0.1.0
+Summary: Unity project discovery, build, license, and CI tooling
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.13
+Requires-Dist: bashrun>=0.1.0
+Requires-Dist: pydantic-settings>=2.9.1
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: typer>=0.17.4

unity_devkit-0.1.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+unity_devkit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+unity_devkit/build_unity.py,sha256=sO2NeLEv2MN08WVI-jWgp59j_Jv7GHhBB_8RRh3rH_4,4040
+unity_devkit/cache.py,sha256=VbO_bVnO_-D4yb6XKv5NbO0qrSwmj9kpX5hxw1LRYwQ,3046
+unity_devkit/ci_step.py,sha256=BuiX3vYRddaVf0RR6Q81lA0xdfYjurHXPj4dVaA-Neg,1402
+unity_devkit/compile_unity.py,sha256=ktcZIdjUIODyJbXG4iHbRNmiIkY4bwF4jujnT-oIUBs,1789
+unity_devkit/git_tags.py,sha256=1KW4bu4LJSMEG5CRiiJEMvKt3U5xKFWhVbrvZmh0Sr8,648
+unity_devkit/install.py,sha256=1pgtRo3AMOJf-Zpe--AocXr_QkONrf4iSd6WgWXkE0A,6988
+unity_devkit/license.py,sha256=OTJdah5ark5ynNlriT5dqULfjnYNVtDN4UIIzJSNxSI,1517
+unity_devkit/license_restore.py,sha256=owpuHMg1hU7SqzRolY7Zu-Nbs91tt-lNznoYLBAW5VM,1068
+unity_devkit/lock_unity.py,sha256=9UNMTj5ekFqqyXpRZ4fSru6SeyTda23jqtJ48rb0HOs,1009
+unity_devkit/matrix.py,sha256=wb8hkEx6f8wnoEjSZszM9lpPofh5a5LspCTtsKqKKQ0,1158
+unity_devkit/projects.py,sha256=pWk6klQJ5_cdT8gcwQTkB1dK7y7UuNTk5NHYUCLvBuI,1941
+unity_devkit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+unity_devkit/setup.py,sha256=TlNKBI6Fz9EM9ko4WP7PjfjORqzXV2kRbmVVqAYn5FM,4439
+unity_devkit/setup_oras.py,sha256=kRfEu_WrtSjJa8LhdC8XEU87C_P3rjBmHVUEIWqEkvM,1750
+unity_devkit/test_unity.py,sha256=Zdr-e2Qx_OgC1huAT_ZgL_YgKnu4FjCRJEhTW7pXMyQ,1068
+unity_devkit/unity.py,sha256=ST5c224jhGdLZJNXI1A7kPj3cxbcfY2j_5b96rpzyJs,6775
+unity_devkit/third-party/README.md,sha256=QxGCzUFfsaELehjorvzXvkCdHwXEsnmwpjXoITrx5xw,459
+unity_devkit/third-party/dotnet-install.sh,sha256=ECpoSTA3E_FUYrso6xBZO_h0u-7BcSLgUi8Qo7V85EI,63488
+unity_devkit-0.1.0.dist-info/METADATA,sha256=bumfMyJNOOi3nTChwoqHaatY6Z9qCqVPqTQVs25vys8,319
+unity_devkit-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+unity_devkit-0.1.0.dist-info/entry_points.txt,sha256=RKjFLiz02NSodLcgVDp8pnYX6zEa7VhrH_1GXnnt9d8,381
+unity_devkit-0.1.0.dist-info/licenses/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
+unity_devkit-0.1.0.dist-info/licenses/NOTICE,sha256=jvglZza3GCdN7v4_TLuXUqX9C_uABlwAKUkcIeKwk_8,26
+unity_devkit-0.1.0.dist-info/RECORD,,

unity_devkit-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

unity_devkit-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,9 @@
+[console_scripts]
+activate-unity-license = unity_devkit.license:activate_app
+build-unity = unity_devkit.build_unity:app
+compile-unity = unity_devkit.compile_unity:app
+install = unity_devkit.install:app
+lock-unity = unity_devkit.lock_unity:app
+test-unity = unity_devkit.test_unity:app
+unity-license-tag = unity_devkit.license_restore:tag_app
+unity-matrix = unity_devkit.matrix:main

unity_devkit-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

unity_devkit-0.1.0.dist-info/licenses/NOTICE

@@ -0,0 +1 @@
+Copyright 2026 Tyler Hatch