Std AddonManager

From FreeCAD Documentation
Revision as of 23:44, 15 November 2019 by Maker (talk | contribs)

Addon manager

Menüeintrag
Werkzeuge → Addon manager
Arbeitsbereich
Alle
Standardtastenkürzel
Keiner
Eingeführt in Version
0.17
Siehe auch
Makros,Externe Arbeitsbereiche

Der Addon-Manager ist ein Werkzeug zum installieren und verwalten von externen Arbeitsbereichen und Makros, die von der FreeCAD Gemeinschaft bereitgestellt werden. Falls das Paket git-python auf Deinem Computer installiert ist, wird der Addon Manager es verwenden, um installierte Arbeitsbereiche zu aktualisieren und Downloads zu beschleunigen.

Die Listen der installierbaren Arbeitsbereiche und Makros stammen aus zwei Repositories,FreeCAD-addons und [1], sowie aus den Makro Rezepte.

Schnittstelle des Addon-Managers

Anwendung

  • Öffnen Sie das Werkzeug im Menü Werkzeuge → Extras → Addon-Manager.
  • Um eine Workbench zu installieren: Scrollen Sie durch die Liste und wählen Sie das Add-On. Die Beschreibung des Add-Ons wird unter der Liste sowie der Link zur Add-On-Seite angezeigt. Drücken Sie dann die Schaltfläche Install/update, um das neue Werkzeug zu installieren. Bei Makros drücken Sie Makros und wiederholen Sie die Schritte.
  • So entfernen Sie eine Workbench oder ein Makro: Blättern Sie durch die Liste, wählen Sie das Add-on aus und drücken Sie die Schaltfläche Remove.
  • Um eine Workbench oder ein Makro zu aktualisieren: Blättern Sie durch die Liste, wählen Sie das Add-on und drücken Sie die Schaltfläche Install/update.
  • Nach Updates suchen: Drücken Sie die Schaltfläche ; verfügbare Updates werden unterhalb der Liste angezeigt. Durch erneutes Drücken der Update-Taste werden alle Updates gleichzeitig aktualisiert. Note: Das Symbol kann je nach Betriebssystem anders aussehen.
  • Um ein Makro auszuführen: Installieren Sie zuerst das gewünschte Makro, wählen Sie es erneut in der Liste und drücken Sie die Schaltfläche Execute. Das Makro wird automatisch im FreeCAD-Makro-Editor dargestellt, um den Code zu zeigen.
  • Drücken Sie Close, um den Manager zu beenden.

Manuelle Installation

Wenn Sie den Addon-Manager nicht verwenden, können Sie die neuen Werkzeuge manuell installieren, indem Sie deren Code in Ihrem FreeCAD/-Benutzerverzeichnis ablegen. Details finden Sie unter:

Einschränkungen

  • Diese Add-Ons gehören nicht zum offiziellen FreeCAD-Programm und werden vom FreeCAD-Core-Team nicht unterstützt. Sie sollten die Informationen auf jeder der Add-On-Seiten lesen, bevor Sie sie installieren, um sicherzustellen, dass Sie wissen, was Sie installieren.
  • Fehlerberichte und Feature-Anfragen sollten direkt auf jeder Add-On-Seite oder an den Ersteller des Add-ons im FreeCAD Forum erfolgen.
  • Die Web-Adressen der Repositories für Addons und Makros sind im AddonManager hartkodiert. Weil diese Applikation in Python geschrieben ist, können erfahrende Benutzer diese Stellen ändern durch Anpassen der entsprechenden Felder in
$ROOT/Mod/AddonManager/AddonManager.py
$ROOT/Mod/AddonManager/AddonManager.py

wobei $ROOT das FreeCAD-Installationsverzeichnis auf Ihrem jeweiligen System ist, bspw.

  • Linux: /usr/lib/freecad/Mod/AddonManager/AddonManager.py
  • Windows: C:\Program Files\FreeCAD version\Mod\AddonManager.py

Neue Arbeitsbereiche und Makros

Wenn Sie einen Arbeitsbereich oder ein Makro entwickelt haben und es im Addon-Manager sehen möchten, lesen Sie auf den Repository-Seiten (FreeCAD-addons und FreeCAD-macros), was zu tun ist. Wenn Sie Ihr Makro zu den Maco-Rezepten hinzufügen, ist nichts weiteres tun, denn es wird automatisch vom Addon-Manager ausgewählt.

Bei Python-Arbeitsbereichen benötigen Sie keine bestimmte Genehmigung, damit Ihr Arbeitsbereich zum Addon-Manager hinzugefügt wird, und da Sie sich außerhalb des FreeCAD-Quellcodes befinden, können Sie die Lizenz wählen, die Sie möchten. Wenn Sie darum bitten, dass Ihr Arbeitsbereich zur Liste hinzugefügt wird (wir werden keine neuen Arbeitsbereiche ohne die Bitte der Autoren hinzufügen), entweder durch Anfrage im Forum oder durch Eröffnen eines Themas im FreeCAD-addons-Repository, bleibt Ihr Code in Ihrem eigenen git-Repository, und wir werden ihn einfach als Submodul zum FreeCAD-addons-Repository hinzufügen. Vor dem Hinzufügen des Arbeitsbereichs werden wir natürlich einen Blick darauf werfen, um sicherzustellen, dass er nichts potenziell Gefährliches enthält.

Wenn Sie einen Arbeitsbereich in C++ entwickeln, kann er nicht direkt durch Benutzer ausgeführt, sondern muss zuerst kompiliert werden. Sie haben zwei Optionen, entweder stellen Sie vorkompilierte Versionen Ihres Arbeitsbereichs für die verschiedenen Betriebssysteme zur Verfügung oder Sie sollten darum bitten, dass Ihr Code in den FreeCAD-Quellcode integriert wird. Dafür sollten Sie die LGPL-Lizenz (oder vollkompatible wie MIT oder BSD) verwenden, und Sie müssen Ihre Werkzeuge der Community im FreeCAD Forum für ein Review vorstellen. Sobald Ihr Code getestet und freigegeben ist, sollten Sie das FreeCAD-Repository forken (sofern noch nicht geschehen), einen neuen Branch anlegen, den Code dorthin pushen, und einen Pull-Request öffnen, damit Ihr Branch zum Main-Repository hinzugefügt wird.

Testing the Addon Manager

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 FreeCAD/src/Mod/AddonManager and simply re-running FreeCAD.

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 for short):

cd ~/FreeCAD/Mod/A2plus/
git reset --hard "v0.4.21"

CLI output should show HEAD is now at b2c53a4 Merge pull request #281 from kbwbe/devel