Packaging

Packaging is the final step of getting a solution that has been developed into a format that can be understood and installed by the Add-on Manager.

As a reminder, for our example Add-on, the files that need to be packaged are the following:

.
├── addon.json
├── additional_content
│   └── previewImage.png
├── data-lab-functions
│   ├── API.ipynb
│   └── requirements.txt
├── frontend
│   └── com.seeq.addon.example.frontend.plugin
├── test_tool
│   ├── TestTool.ipynb
│   └── requirements.txt
└── udf
    └── formula_package.json

This can be done manually, but it is better to use tooling to make it automated and repeatable. The approach you take is up to you.

One approach is to copy only the required folders and files into an image folder, then zip the contents of the folder, and name the resulting file following the Add-on naming recommendations (e.g. com.seeq.addon.example-1.0.0.addon). Another option is to read the element folders directly and copy the contents into a zip file.

The preferred approach is to use the utilities in the Add-on Packaging Utility. Specifically, the _dev_tools folder includes utilities where you can run python addon.py package to package your Add-on.