Adding a setup.py and a README to the scripts/o3de folder so it can be linked as a package into the engine python runtime when python is installed via python/get_python.bat

2021-05-18 23:48:35 -05:00
parent ec7f4c3fdc
commit 703c268e40
2 changed files with 83 additions and 0 deletions
@@ -0,0 +1,41 @@
+All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
+its licensors.
+
+For complete copyright and license terms please see the LICENSE at the root of this
+distribution (the "License"). All use of this software is governed by the License,
+or, if provided, by the license below or the license accompanying this file. Do not
+remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
+
+INTRODUCTION
+------------
+
+o3de is a package of scripts containing functionality to register engine, projects, gems,
+templates and download repositories with the o3de manifests
+It also contains functionality for creating new projects, gems and templates as well
+as querying existing gems and templates
+
+
+REQUIREMENTS
+------------
+
+ * Python 3.7.10 (64-bit)
+
+INSTALL
+-----------
+It is recommended to set up these these tools with O3DE's CMake build commands.
+Assuming CMake is already setup on your operating system, below are some sample build commands:
+    cd /path/to/od3e/
+    cmake -B windows_vs2019 -S . -G"Visual Studio 16" -DLY_3RDPARTY_PATH="%LY_3RDPARTY_PATH%"
+
+To manually install the project in development mode using your own installed Python interpreter:
+    cd /path/to/od3e/o3de
+    /path/to/your/python -m pip install -e .
+
+
+UNINSTALLATION
+--------------
+
+The preferred way to uninstall the project is:
+ /path/to/your/python -m pip uninstall o3de
@@ -0,0 +1,42 @@
+"""
+All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
+its licensors.
+
+For complete copyright and license terms please see the LICENSE at the root of this
+distribution (the "License"). All use of this software is governed by the License,
+or, if provided, by the license below or the license accompanying this file. Do not
+remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+"""
+import os
+import platform
+
+from setuptools import setup, find_packages
+from setuptools.command.develop import develop
+from setuptools.command.build_py import build_py
+
+PACKAGE_ROOT = os.path.abspath(os.path.dirname(__file__))
+
+PYTHON_64 = platform.architecture()[0] == '64bit'
+
+
+if __name__ == '__main__':
+    if not PYTHON_64:
+        raise RuntimeError("32-bit Python is not a supported platform.")
+
+    with open(os.path.join(PACKAGE_ROOT, 'README.txt')) as f:
+        long_description = f.read()
+
+    setup(
+        name="o3de",
+        version="1.0.0",
+        description='O3DE editor Python bindings test tools',
+        long_description=long_description,
+        packages=find_packages(where='o3de', exclude=['tests']),
+        install_requires=[
+        ],
+        tests_require=[
+        ],
+        entry_points={
+        },
+    )