Std AddonMgr: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Undo revision 841981 by Chrisb (talk))
Tag: Undo
(23 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:26-->
{{Docnav
|[[Std_DlgCustomize|DlgCustomize]]
|
|[[Std_Tools_Menu|Std Tools Menu]]
|IconL=Std_DlgCustomize.svg
|IconR=
|IconC=Freecad.svg
}}

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Std AddonMgr
|Name=Std AddonMgr
|MenuLocation=Tools → Addon manager
|Icon=AddonManager.svg
|Workbenches=All
|MenuLocation={{StdMenu|Tools}} → Addon manager
|Workbenches=''None''
|SeeAlso=[[Macros|Macros]], [[External workbenches|External workbenches]]
|Version=0.17
|Version=0.17
|SeeAlso=[[External_workbenches|External workbenches]], [[Macros|Macros]]
}}
}}

==Description== <!--T:25-->


<!--T:2-->
<!--T:2-->
The '''Addon Manager''' is a tool to install and manage [[external workbenches|external workbenches]] and [[macros|macros]] provided by the FreeCAD community. If the [https://github.com/gitpython-developers/GitPython git-python] package is installed on your computer, the Addon Manager will make use of it to update installed workbenches, making downloads faster.
The '''Std AddonMgr''' command opens the Addon manager. With the Addon manager you can install and manage [[external_workbenches|external workbenches]] and [[macros|macros]] provided by the FreeCAD community. The available workbenches and macros are taken from two repositories, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] and [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros], and from the [[Macros_recipes|Macros recipes]] page.


<!--T:10-->
<!--T:41-->
Addons that are marked as {{emphasis|Python 2 Only}} will not work in FreeCAD version 0.19 or higher.
The lists of installable workbenches and macros are taken from two repositories, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] and [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros], respectively, and from the [[Macros recipes|Macros recipes]].


<!--T:42-->
Due to changes to the GitHub platform in the year 2020 the Addon manager no longer works if you use FreeCAD version 0.17 or earlier. You need to upgrade to version [https://github.com/FreeCAD/FreeCAD/releases/tag/0.18.5 0.18.5] or a recent [https://github.com/FreeCAD/FreeCAD/releases/tag/0.19_pre 0.19] version. Alternatively you can install addons manually, see [[#Notes|Notes]] below.

</translate>
[[Image:Std_AddonMgr_dialog.png]]
<translate>
<!--T:4-->
<!--T:4-->
{{Caption|The Addon manager dialog box}}
[[Image:Addon_Manager_example.png]]
{{Caption|Interface of the [[Addon Manager|Addon Manager]]}}


== Usage == <!--T:5-->
==Usage== <!--T:5-->


<!--T:6-->
<!--T:6-->
* Open the tool in the menu {{MenuCommand|{{StdMenu|Tools}} → Addon manager}}.
# Select the {{MenuCommand|Tools → [[Image:Std_AddonMgr.svg|16px]] Addon manager}} option from the menu.
# If you are using the Addon manager for the first time, a dialog box will open warning you that the addons in the Addon manager are not officially part of FreeCAD. Press the {{Button|OK}} button to confirm and continue.
* To install a workbench: scroll through the list and select the add-on; a short description, as well as its home page, will be displayed below the list. Press the {{Button|Install/update}} button to install the new tool. For macros, click on the {{MenuCommand|Macros}} tab and repeat the steps.
# The Addon manager dialog box opens. For more information see [[#Options|Options]].
* To remove a workbench or a macro: scroll through the list, select the add-on, and then press the {{Button|Remove}} button.
# The {{Button|[[Image:Button_valid.svg|16px]] Update all}} button does not work at this time.
* To update a workbench or a macro: scroll through the list, select the add-on, and then press the {{Button|Install/update}} button.
# Press the {{Button|[[Image:Process-stop.svg|16px]] Close}} button to close the dialog box.
* To check for updates: press the {{Button|[[File:Std Refresh.svg|16px]] Refresh}} button; available updates will be reported below the list. Press the {{Button|[[File:Std Refresh.svg|16px]] Refresh}} button again to install all updates at once. {{Emphasis|Note:}} the icon may look different depending on your operating system.
# If you have installed or updated a workbench a new dialog box will open informing you that you have to restart FreeCAD for the changes to take effect.
* To run a macro: first install the desired macro, then select it again on the list, and then press the {{Button|Execute}} button. The macro is automatically edited in the FreeCAD macro editor, to visualize the code.
* Press {{Button|Close}} to exit the manager.
You will have to restart FreeCAD before new workbenches appear in the list of available workbenches. They are appended at the end, if you want to have them in alphabetical order, you can rearrange them in the [[Std DlgCustomize|Std DlgCustomize]] dialog.


=== Manual installation === <!--T:11-->
==Options== <!--T:27-->
If you don't use the Addon Manager, you can install the new tools manually by placing their code in your user's {{incode|FreeCAD/}} directory. See the following links for details:
* [[How to install macros|How to install macros]]
* [[How to install additional workbenches|How to install additional workbenches]]


== Limitations == <!--T:7-->
<!--T:28-->
The Addon manager dialog box has two tabs on the left, one listing the available workbenches and the other listing the available macros. The information panel on the right will display the homepage of the selected addon.


<!--T:8-->
===Uninstall=== <!--T:29-->
* These add-ons are not part of the official FreeCAD program and are not supported by the core FreeCAD development team. You should read the information provided on each add-on's home page to make sure you know what you are installing.


<!--T:9-->
<!--T:30-->
# Select an installed addon on the [[Image:Folder.svg|16px]] '''Workbenches''' tab or the [[Image:Applications-python.svg|16px]] '''Macros''' tab.
* Bug reports and feature requests should be made directly to the creator of the add-on by visiting the indicated website. Many add-on authors are regular users of the [https://forum.freecadweb.org FreeCAD forum], and can be contacted there.
# Press the {{Button|[[Image:Delete.svg|16px]] Uninstall selected}} button.


<!--T:17-->
===Install/update=== <!--T:31-->
* The web addresses of the repositories for add-ons and macros are hard coded into the AddonManager. As this application is written in Python, experienced users can change these locations by editing the appropriate fields in


<!--T:32-->
</translate>
# Select an addon on the [[Image:Folder.svg|16px]] '''Workbenches''' tab or the [[Image:Applications-python.svg|16px]] '''Macros''' tab.
{{Code|code=
# Press the {{Button|[[Image:Edit_OK.svg|16px]] Install/update selected}} button.
$ROOT/Mod/AddonManager/AddonManager.py
# If you want to add a macro to a custom toolbar then don't forget to manually download the icon image file, if available, by clicking on the link on the homepage in the information panel. See [[Interface_Customization#Toolbars|Interface Customization]].
}}
# To change the position of an addon workbench in the [[Std_Workbench|Workbench selector]] list see [[Interface_Customization#Workbenches|Interface Customization]].
<translate>


<!--T:18-->
===Configuration=== <!--T:33-->
where {{incode|$ROOT}} is the installation directory of FreeCAD in your particular system, for example,
* Linux: {{incode|/usr/lib/freecad/Mod/AddonManager/AddonManager.py}}
* Windows: {{Incode|C:\Program Files\FreeCAD version\Mod\AddonManager.py}}


== New workbenches and macros == <!--T:12-->
<!--T:34-->
# Press the {{Button|[[Image:Preferences-general.svg|16px]] Configure...}} button.
# The Addon manager options dialog box opens.
# Optionally check the {{CheckBox|TRUE|Automatically check for updates at start (requires GitPython)}} checkbox.
# Optionally add repositories to the '''Custom repositories''' list. Addons from these repositories will be added on the [[Image:Folder.svg|16px]] '''Workbenches''' tab or the [[Image:Applications-python.svg|16px]] '''Macros''' tab.
# Optionally choose proxy settings.
# Press the {{Button|OK}} button or the {{Button|Cancel}} button to close the dialog box.


<!--T:13-->
==Notes== <!--T:35-->
If you developed a workbench or macro, and want to see it included in the Addon Manager, read how to do that on the repository pages ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] and [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]). If you add your macro to the [[Macros recipes|Macros recipes]], there is nothing else to do, it will automatically be picked by the Addon Manager.


<!--T:14-->
<!--T:36-->
* The use of addons is not restricted to the FreeCAD version they were installed from. You will also be able to use them in any other FreeCAD version, supported by the addon, that you may have on your system.
For python workbenches, you don't need any specific approval to have your workbench added to the Addon Manager and, being outside the FreeCAD source code, you can choose the license you want. If you request for your workbench to be added to the list (we will not add any new workbench without a request from its authors), either by asking so on the forum or by opening an issue on the [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] repository, your code will stay on your own git repository, we will just add it as a submodule to the [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] repository. Of course, before adding your workbench, we will take a look at it and make sure there is nothing potentially problematic with it.
* The addons available in the Addon manager are not part of the official FreeCAD program and are not supported by the core FreeCAD development team. You should read the provided information carefully to make sure you know what you are installing.
* Bug reports and feature requests should be made directly to the creator of the addon by visiting the indicated website. Many addon developers are regular users of the [https://forum.freecadweb.org FreeCAD forum], and can also be contacted there.
* If the [https://github.com/gitpython-developers/GitPython GitPython] package is installed on your computer the Addon manager will make use of it, making downloads faster.
* You can also install addons manually. See [[How_to_install_additional_workbenches|How to install additional workbenches]] and [[How_to_install_macros|How to install macros]].


<!--T:15-->
==Information for developers== <!--T:37-->
If you develop a workbench in C++, it cannot be run directly by users and must be compiled first. You then have 2 options, either you provide precompiled versions of your workbench yourself, for the different operating systems, or you should request to have your code merged into the FreeCAD source code. For that, you should use the LGPL license (or fully compatible like MIT or BSD), and you must present your new tools to the community in the [https://forum.freecadweb.org FreeCAD forum] for review. Once your code has been tested and approved, you should fork the FreeCAD repository, if not done yet, create a new branch, push your code to it, and open a pull request so that your branch is merged into the main repository.


== Testing the Addon Manager == <!--T:20-->
<!--T:13-->
If you have developed a workbench or macro, and want to see it included in the Addon manager, read how to do so on the repository pages: ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] and [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]). If you add your macro to the [[Macros_recipes|Macros recipes]] page, there is nothing else to do, it will automatically be picked up by the Addon manager.
{{VeryImportantMessage|This section is for developers}}
The Addon Manager is coded in Python so it's possible to change the source code without compiling it. More specifically, testing requires modifying the code in {{incode|FreeCAD/src/Mod/AddonManager}} and simply re-running FreeCAD.


<!--T:21-->
===Python workbenches=== <!--T:38-->
To test downloading capability of the Addon Manager you can simulate a need to download say, a previous version of a workbench via the CLI. In the following example we'll use the Assembly2+ workbench (or [[A2plus_Workbench|A2plus]] for short):


<!--T:14-->
</translate>
For python workbenches, you don't need any specific approval to have your workbench added to the Addon manager and, being outside the FreeCAD source code, you can choose the license you want. If you request for your workbench to be added to the list (we will not add any new workbench without a request from its authors), either by asking so on the forum or by opening an issue on the [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] repository, your code will stay on your own git repository, we will just add it as a submodule to the [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] repository. Of course, before adding your workbench, we will take a look at it and make sure there is nothing potentially problematic with it.
{{Code|code=
cd ~/FreeCAD/Mod/A2plus/
git reset --hard "v0.4.21"
}}
<translate>


<!--T:22-->
===C++ workbenches=== <!--T:39-->
CLI output should show '''HEAD is now at b2c53a4 Merge pull request #281 from kbwbe/devel'''


<!--T:16-->
<!--T:15-->
If you develop a workbench in C++, it cannot be run directly by users and must be compiled first. You then have two options, either you provide precompiled versions of your workbench yourself, for the different operating systems, or you should request to have your code merged into the FreeCAD source code. For that, you should use the LGPL license (or a fully compatible license like MIT or BSD), and you must present your new tools to the community in the [https://forum.freecadweb.org FreeCAD forum] for review. Once your code has been tested and approved, you should fork the FreeCAD repository, if not done yet, create a new branch, push your code to it, and open a pull request so that your branch is merged into the main repository.
What we essentially did was use a previous release tag to reset the version.
Now, in the Addon Manager refresh the list of workbenches and it should show that the A2plus workbench is using an inferior version.


<!--T:23-->
{{Std Base navi}}


<!--T:24-->
<!--T:40-->
{{Docnav
{{Userdocnavi}}
|[[Std_DlgCustomize|DlgCustomize]]

|
<!--T:19-->
|[[Std_Tools_Menu|Std Tools Menu]]
[[Category:Addons]]
|IconL=Std_DlgCustomize.svg
|IconR=
|IconC=Freecad.svg
}}


</translate>
</translate>
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}

Revision as of 22:56, 21 January 2021

Std AddonMgr

Menu location
Tools → Addon manager
Workbenches
All
Default shortcut
None
Introduced in version
0.17
See also
External workbenches, Macros

Description

The Std AddonMgr command opens the Addon manager. With the Addon manager you can install and manage external workbenches and macros provided by the FreeCAD community. The available workbenches and macros are taken from two repositories, FreeCAD-addons and FreeCAD-macros, and from the Macros recipes page.

Addons that are marked as Python 2 Only will not work in FreeCAD version 0.19 or higher.

Due to changes to the GitHub platform in the year 2020 the Addon manager no longer works if you use FreeCAD version 0.17 or earlier. You need to upgrade to version 0.18.5 or a recent 0.19 version. Alternatively you can install addons manually, see Notes below.

File:Std AddonMgr dialog.png

The Addon manager dialog box

Usage

  1. Select the Tools → Addon manager option from the menu.
  2. If you are using the Addon manager for the first time, a dialog box will open warning you that the addons in the Addon manager are not officially part of FreeCAD. Press the OK button to confirm and continue.
  3. The Addon manager dialog box opens. For more information see Options.
  4. The Update all button does not work at this time.
  5. Press the Close button to close the dialog box.
  6. If you have installed or updated a workbench a new dialog box will open informing you that you have to restart FreeCAD for the changes to take effect.

Options

The Addon manager dialog box has two tabs on the left, one listing the available workbenches and the other listing the available macros. The information panel on the right will display the homepage of the selected addon.

Uninstall

  1. Select an installed addon on the Workbenches tab or the Macros tab.
  2. Press the Uninstall selected button.

Install/update

  1. Select an addon on the Workbenches tab or the Macros tab.
  2. Press the Install/update selected button.
  3. If you want to add a macro to a custom toolbar then don't forget to manually download the icon image file, if available, by clicking on the link on the homepage in the information panel. See Interface Customization.
  4. To change the position of an addon workbench in the Workbench selector list see Interface Customization.

Configuration

  1. Press the Configure... button.
  2. The Addon manager options dialog box opens.
  3. Optionally check the Automatically check for updates at start (requires GitPython) checkbox.
  4. Optionally add repositories to the Custom repositories list. Addons from these repositories will be added on the Workbenches tab or the Macros tab.
  5. Optionally choose proxy settings.
  6. Press the OK button or the Cancel button to close the dialog box.

Notes

  • The use of addons is not restricted to the FreeCAD version they were installed from. You will also be able to use them in any other FreeCAD version, supported by the addon, that you may have on your system.
  • The addons available in the Addon manager are not part of the official FreeCAD program and are not supported by the core FreeCAD development team. You should read the provided information carefully to make sure you know what you are installing.
  • Bug reports and feature requests should be made directly to the creator of the addon by visiting the indicated website. Many addon developers are regular users of the FreeCAD forum, and can also be contacted there.
  • If the GitPython package is installed on your computer the Addon manager will make use of it, making downloads faster.
  • You can also install addons manually. See How to install additional workbenches and How to install macros.

Information for developers

If you have developed a workbench or macro, and want to see it included in the Addon manager, read how to do so on the repository pages: (FreeCAD-addons and FreeCAD-macros). If you add your macro to the Macros recipes page, there is nothing else to do, it will automatically be picked up by the Addon manager.

Python workbenches

For python workbenches, you don't need any specific approval to have your workbench added to the Addon manager and, being outside the FreeCAD source code, you can choose the license you want. If you request for your workbench to be added to the list (we will not add any new workbench without a request from its authors), either by asking so on the forum or by opening an issue on the FreeCAD-addons repository, your code will stay on your own git repository, we will just add it as a submodule to the FreeCAD-addons repository. Of course, before adding your workbench, we will take a look at it and make sure there is nothing potentially problematic with it.

C++ workbenches

If you develop a workbench in C++, it cannot be run directly by users and must be compiled first. You then have two options, either you provide precompiled versions of your workbench yourself, for the different operating systems, or you should request to have your code merged into the FreeCAD source code. For that, you should use the LGPL license (or a fully compatible license like MIT or BSD), and you must present your new tools to the community in the FreeCAD forum for review. Once your code has been tested and approved, you should fork the FreeCAD repository, if not done yet, create a new branch, push your code to it, and open a pull request so that your branch is merged into the main repository.