Example of embedding and deploying gp toolbox through a .NET add-in.
Official sdk doc is at : https://github.com/Esri/arcgis-pro-sdk/wiki/ProGuide-content-and-image-resources#embedding-toolboxes
This extension point is familiar to .net add-in developers, and allows them to
- include toolbox in their Add-ins (along with other add-in functionality)
- toolbox are included as system toolboxes
- automatically get listed in the Toolboxes window
- can pre-generate resource (optional)
- xml for all gp toolbox & tool strings & messages, also allows for translation
- include pre-generated python wrapper
- build the add in follow "Build your fist add in" instructions
- open ArcGIS Pro
- show the Geoprocessing Tools view
- expand the Deep Thoughts (alias from xml)
- run the Answer (from xml) tool
Below is the process that was used to create this add-in.
Create and implement your toolbox/tools normally.
run arcpy.gp.createtoolboxsupportfiles(<path to .tbx or .pyt>) to produce resources (optional)*
This step is optional, running the command above generates external xml files for all tool/toolbox resources which allows them to be managed external to the toolbox file. And if translated xml are present and put in the correct location will automatically be picked up by gp framework when the ArcGISPro app is run on language other than default.
Additionally the command above will produce an python module with functions for each gp tool in the toolbox. This module will be added to arcpy automatically using the toolbox.alias as a namespace (eg arcpy.deepthought.Answer) .
For more details see:
- extending-geoprocessing-through-python-modules , ignore the instructions on deploying into python's site-package, instead deploy the files within the add-in as shown below
- geoprocessing_and_python/international-language-support
gotcha: during development of the toolbox/tool it is not possible to use messages.xml as messages xml are only loaded into the global messages list at application startup, and during add-in development your messages.xml will not be found in the default help/gp/messages or in the path relative to toolbox using add-in or site-packages extension point. May want to move strings into messages.xml during the final phase of development to make this easier.
- install arcgis-pro-sdk, link: ProGuide-Installation-and-Upgrade
- create an add-in, link: see Pro Guide Build your first Add-in
- add a folder to your Add-in called Toolboxes at top of directory structure
- add all files (Add Existing Item...) and folders from create a toolbox section above, to the following structure
- for each file in the Toolboxes folder, set their Build Action as AddInContent
