Add Workbench to Addon Manager

Other languages:

Introduction

These are step-by-step instructions on how to add a Python workbench to the Addon Manager.

Requirements:

Enable developer mode

  1. Open the Preferences Editor: select the Edit → Preferences... option from the menu.
  2. Select the Addon Manager option in the left bar.
  3. On the Addon manager options tab check the Addon developer mode checkbox. This will enable the Developer tools... button in the Addon Manager.
  4. Press the OK button to close the Preferences Editor.

Create the package.xml file

  1. Open the Addon Manager: select the Tools → Addon manager option from the menu.
  2. Press the Developer tools... button.
  3. The Addon Developer Tools dialog opens.
  4. Enter the following:
    • Path to Addon: The path to the local git repository.
    • Addon Name: This will appear in the listings of the Addon Manager.
    • Description: Idem.
    • Version: Idem.
    • Repository URL
    • Primary branch
    • README URL: Recommended.
    • Icon: The icon must be part of the repository.
  5. Press the button at the bottom of the dialog.
  6. The Content Item dialog opens.
  7. The Content type should be set to Workbench.
  8. Check the This is the only item in the Addon checkbox.
  9. Enter the Workbench class name. This is the class name specified in the InitGui.py file.
  10. For the Subdirectory enter ./.
  11. Press the OK button to close the dialog.
  12. Press the Save button to close the Addon Developer Tools dialog and save the package.xml file.
  13. Press the Close button to close the Addon Manager.
  14. Push the created file to your remote repository.

Add the workbench to the .gitmodules file

  1. Fork https://github.com/FreeCAD/FreeCAD-addons.
  2. Create a new branch.
  3. Edit the .gitmodules file to include your new Addon, in alphabetical order.
  4. Push the new branch to GitHub.
  5. Submit a Pull Request to the FreeCAD-Addons repository with the new .gitmodules file.

See also