Vincent Liu
a4e1abf6df
1. Add support to use engine python runtime environment. Ideally we should use project executable directory which contains required qt binaries after build. But currently Qt plugins are not put under proper subdirectory which causes huge overhead of loading plugin binaries (see details in this jira https://jira.agscollab.com/browse/LYN-2669 ). The temporary solution is to use AWSCore.Editor target to create a subdirectory for our use case. 2. **Minor Fix** After migrating to engine python environment, see boto3 warning while using debug mode, seems like a existing issue for a long time https://github.com/boto/boto3/issues/454. Register a after call event to close connection 3. **Minor Fix** After migrating to engine python environment, see Qt multithread warning while using debug mode, change direct setter function call to qt signal
3.2 KiB
Welcome to the AWS Core Resource Mapping Tool project!
Setup aws config and credential
Resource mapping tool is using boto3 to interact with aws services:
- Follow boto3 Configuration to setup default aws region.
- Follow boto3 Credentials to setup default profile or credential keys.
Or follow AWS CLI configuration which can be reused by boto3 lib:
In Progress - Override default aws profile in resource mapping tool
Python Environment Setup Options
1. Engine python environment
In order to use engine python environment, it requires to link Qt binaries for this tool. Follow cmake instructions to configure your project, for example:
$ cmake -B <BUILD_FOLDER> -S . -G "Visual Studio 16 2019" -DLY_3RDPARTY_PATH=<PATH_TO_3RDPARTY> -DLY_PROJECTS=<PROJECT_NAME>
Build project with AWSCore.Editor target to generate required Qt binaries. (Or use Editor target)
$ cmake --build <BUILD_FOLDER> --target AWSCore.Editor --config <CONFIG> -j <NUM_JOBS>
Launch resource mapping tool under engine root folder:
Windows
release mode
$ python\python.cmd Gems\AWSCore\Code\Tools\ResourceMappingTool\resource_mapping_tool.py --binaries_path <PATH_TO_BUILD_FOLDER>\bin\profile\AWSCoreEditorPlugins
debug mode
$ python\python.cmd debug Gems\AWSCore\Code\Tools\ResourceMappingTool\resource_mapping_tool.py --binaries_path <PATH_TO_BUILD_FOLDER>\bin\debug\AWSCoreEditorPlugins
2. Python virtual environment
This project is set up like a standard Python project. The initialization
process also creates a virtualenv within this project, stored under the .env
directory. To create the virtualenv it assumes that there is a python3
(or python for Windows) executable in your path with access to the venv
package. If for any reason the automatic creation of the virtualenv fails,
you can create the virtualenv manually.
To manually create a virtualenv on MacOS and Linux:
$ python -m venv .env
Once the virtualenv is created, you can use the following step to activate your virtualenv.
$ source .env/bin/activate
If you are a Windows platform, you would activate the virtualenv like this:
% .env\Scripts\activate.bat
Once the virtualenv is activated, you can install the required dependencies.
$ pip install -r requirements.txt
2.1 Launch Options
2.1.1 Launch Resource Mapping Tool from python directly
At this point you can launch tool like other standard python project.
$ python resource_mapping_tool.py
2.1.2 Launch Resource Mapping Tool from batch script/Editor
Update resource_mapping_tool.cmd with your virtualenv full path.
- VIRTUALENV_PATH: Fill this variable with your virtualenv full path.
Then you can launch the resource mapping tool by running the batch script directly.
$ resource_mapping_tool.cmd
Or you can launch the resource mapping tool from menu action Cloud services/AWS Resource Mapping Tool...