Std AddonMgr/de: Difference between revisions

From FreeCAD Documentation
(Created page with "===C++ Arbeitsbereiche===")
(Updating to match new version of source page)
(47 intermediate revisions by 4 users not shown)
Line 2: Line 2:


{{Docnav/de
{{Docnav/de
|[[Std_DlgCustomize/de|Std DlgAngepasst]]
|[[Std_DlgCustomize/de|DlgAnpassen]]
|
|
|[[Std_Tools_Menu/de|Std Werkzeugmenü]]
|[[Std_Tools_Menu/de|Std Menü Werkzeug]]
|IconL=Std_DlgCustomize.svg
|IconL=Std_DlgCustomize.svg
|IconR=
|IconR=
Line 12: Line 12:
{{GuiCommand/de
{{GuiCommand/de
|Name=Std AddonMgr
|Name=Std AddonMgr
|Name/de=Std ErweiterungVerw
|Name/de=Std AddonManager
|MenuLocation=Werkzeuge → ErweiterungsVerwalter
|MenuLocation=Werkzeuge → Addon-Manager
|Workbenches=Alle
|Workbenches=Alle
|Version=0.17
|Version=0.17
|SeeAlso=[[External workbenches/de|Externe Arbeitsbereiche]]
|SeeAlso=[[External_workbenches/de|Externe Arbeitsbereiche]], [[Macros/de|Makros]]
, [[Macros/de|Makros]]
}}
}}


<span id="Description"></span>
==Beschreibung==
==Beschreibung==


Der Befehl '''Std Addon-Manager''' öffnet den Addon-Manager. Mit dem Addon-Manager können [[external_workbenches/de|externe Arbeitsbereiche]], [[macros/de|Makros]], und [[Preference_Packs/de|Voreinstellungspakete]], die durch die FreeCAD-Gemeinschaft bereitgestellt werden, installiert und verwaltet werden. Standardmäßig stammen die verfügbaren Erweiterungen aus zwei Quellen, [https://github.com/FreeCAD/FreeCAD-addons/ (GitHub) FreeCAD-Addons] und von der Seite [[Macros_recipes/de|Makrorezepte]]. Wenn GitPython und git auf dem eigenen System installiert sind, werden zusätzliche Makros von [https://github.com/FreeCAD/FreeCAD-macros/ (GitHub) FreeCAD-Makros] geladen. Benutzerdefinierte Quellen können in den Voreinstellungen des [[Preferences_Editor/de#Addon-Manager|Addon-Managers]] hinzugefügt werden.
Der '''Std ErweiterungVerw''' Befehl öffnet den Erweiterungsverwalter.


Aufgrund von Änderungen an der GitHub-Plattform im Jahr 2020 funktioniert der Addon-Manager nicht mehr, wenn man die FreeCAD-Version 0.17 oder älter verwendet. Man muss auf die Version [https://github.com/FreeCAD/FreeCAD/releases/tag/0.18.5 0.18.5] oder neuer aktualisieren. Alternativ könen die Erweiterungen auch manuell installiert werden, siehe [[#Hinweise|Hinweise]] unten.
ist ein Werkzeug zum installieren und verwalten von [[external workbenches/de|externen Arbeitsbereichen]] und [[macros/de|Makros]], die von der FreeCAD Gemeinschaft bereitgestellt werden. Falls das Paket [https://github.com/gitpython-developers/GitPython git-python] auf Deinem Computer installiert ist, wird der Addon Manager es verwenden, um installierte Arbeitsbereiche zu aktualisieren und Downloads zu beschleunigen.

Bitte beachte, dass Erweiterungen, die als {{emphasis|Python 2 Only}} markiert sind, in FreeCAD Version 0.19 oder höher nicht funktionieren.

[[Image:Std_AddonMgr_dialog.png]]
{{Caption|Das Dialogfeld des Erweiterungsverwalters}}


<span id="Usage"></span>
==Anwendung==
==Anwendung==


# Den Menüeintrag {{MenuCommand|Werkzeuge → [[Image:Std_AddonMgr.svg|16px]] Addon-Manager}} auswählen.
<div class="mw-translate-fuzzy">
# Wird der Addon-Manager zum ersten Mal verwendet, wird ein Dialogfeld geöffnet, das darauf hinweist, dass die Erweiterungen im Addon-Manager kein offizieller Bestandteil von FreeCAD sind. Es enthält auch mehrere Optionen, die mit der Verwendung von Daten durch den Addon-Manager zusammenhängen. Hat man diese Optionen den eigenen Vorlieben entsprechend eingestellt, drückt man die Schaltfläche {{Button|OK}}, um zu bestätigen und fortzufahren.
* Öffne das Werkzeugs im Menü {{MenuCommand/de|Werkzeuge → Addon manager}}.
# Das Dialogfeld Addon-Manager öffnet sich. Für weitere Informationen siehe [[#Optionen|Optionen]].
* Zur Installation eines Arbeitsbereichs: Blättere durch die Liste und wähle das Add-on aus; eine kurze Beschreibung sowie die Homepage werden unterhalb der Liste angezeigt. Drücke die Taste {{Button|Install/update}}, um das neue Werkzeug zu installieren. Klicke bei Makros auf die Registerkarte {{MenuCommand/de|Makros}} und wiederhole die Schritte.
# Die Schaltfläche {{Button|[[Image:Button_valid.svg|16px]] Alles aktualisieren}} funktioniert zurzeit nicht.
* Um einen Arbeitsbereich oder ein Makro zu entfernen: Blättere durch die Liste, wähle das Add-on aus und drücke dann die Taste {{Button|Remove}}.
# Die Schaltfläche {{Button|[[Image:Process-stop.svg|16px]] Schließen}} drücken, um das Dialogfeld zu schließen.
* Um einen Arbeitsbereich oder ein Makro zu aktualisieren: Blättere durch die Liste, wähle das Add-on aus und drücke dann die Taste {{Button|Install/update}}.
# Wenn ein Arbeitsbereich installiert oder aktualisiert wurde, wird ein neues Dialogfeld geöffnet, das darauf hinweist, dass FreeCAD neu gestartet werden muss, damit die Änderungen wirksam werden.
* Um nach Updates zu suchen: Drücke die Taste {{Button|[[File:Std Refresh.png|16px]]. Aktualisieren}} Schaltfläche; verfügbare Updates werden unterhalb der Liste angezeigt. Drücke die {{Button|[[File:Std Refresh.png|16px]]. Aktualisieren}} Schaltfläche erneut, um alle Aktualisierungen auf einmal zu installieren. {{Emphasis|Note:}} Das Icon-Symbol kann je nach Betriebssystem unterschiedlich aussehen.
* Um ein Makro auszuführen, installiere zuerst das gewünschte Makro, wähle es dann erneut in der Liste aus und drücke dann die Taste {{Button|Execute}}. Das Makro erscheint automatisch im FreeCAD-Makroeditor, um den Code zu zeigen.
* Drücke {{Button|Close}}, um den Manager zu verlassen.
FreeCAD muß neu gestart werden, bevor die neuen Arbeitsbereiche in der Liste der verfügbaren Arbeitsbereiche erscheinen. Sie werden am Ende angehängt. Wenn sie in alphabetischer Reihenfolge erscheinen sollen, können sie im Dialog [[Std DlgCustomize|Std DlgCustomize]] neu angeordnet werden.
</div>


<span id="Options"></span>
==Optionen==
==Optionen==


[[File:AddonManager_Main.png|600px]]
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.


# Der Addon-Manager stellt zwei Layouts zur Verfügung: "Schmal" and "Erweitert". In der "schmalen" Ansicht füllt eine Erweiterung eine einzelne Zeile und ihre Beschreibung wird gekürzt, um in den vorhandenen Platz zu passen. "Erweitert" stellt zusätzliche Einzelheiten dar, wie weiteren Beschreibungstext und auch Informationen für Bearbeiter, weitere Installationsdetails usw.
===Deinstallieren===
# Drei Arten von Erweiterungen werden unterstützt: [[external_workbenches/de|Arbeitsbereiche]], [[macros/de|Makros]], und [[Preference_Packs/de|Voreinstellungspakete]]. Man kann wählen, ob nur eine Art angezeigt wird oder alle in einer einzigen Liste.
# Die Liste kann so eingegrenzt werden, dass sie nur installierte Pakete, nur Pakete mit erhältlichen Aktualisierungen oder nur Pakete, die noch nicht installiert wurden, enthält.
# Die Liste kann gefiltert werden durch die Suche nach Schlüsselwörtern in Benennung, Beschreibung und Kennzeichen (Beschreibung und Kennzeichnung müssen vom Addon-Entwickler in den Meta-Daten angegeben werden). Der Filter kann sogar ein regulärer Ausdruck sein, für eine präzise Steuerung des genauen Suchbegriffs.
# Die erweiterte Ansicht zeigt enthaltene Versionsinformationen, Beschreibungen, Informationen für Bearbeiter und Informationen zur Version der Installation für Pakete mit einer [[Package_Metadata/de|Paket-Meta-Daten]]-Datei (oder für Makros mit eingebetteten Meta-Daten).
# Die Addon-Daten werden lokal zwischengespeichert, mit einer variablen Häufigkeit der Aktualisierung des Zwischnspeichers, festgelegt in den Benutzereinstellungen.
# Zu jeder Zeit kann die manuelle Aktualisierung des lokalen Zwischenspeichers ausgewählt werden, um die neuesten verfügbaren Aktualisierungen für alle Erweiterungen anzuzeigen.
# Die Suche nach Aktualisierungen kann auf automatisch eingestellt sein oder manuell erfolgen durch einen Klick auf eine Schaltfläche (festgelegt in den Benutzereinstellungen). Wenn GitPython und git auf dem eigenen System installiert sind, werden die Aktualisierungsinformationen unter Verwendung von git abgeholt. Wenn nicht, werden Informationen zu Aktualisierungen aus allen vorhandenen Meta-Daten-Datein ausgelesen.


Klickt man in dieser Ansicht auf eine Erweiterung, wird eine Seite mit Einzelheiten zu dieser Erweiterung geöffnet:
# Select an installed addon on the [[Image:Folder.svg|16px]] '''Workbenches''' tab or the [[Image:Applications-python.svg|16px]] '''Macros''' tab.
# Press the {{Button|[[Image:Delete.svg|16px]] Uninstall selected}} button.


[[File:AddonManager_Details.png|600px]]
===Installieren/Aktualisieren===


Diese Seite mit Einzelheiten zeigt Schaltflächen, die es erlauben Erweiterungen zu installieren, zu deinstallieren, zu aktualisieren und zeitweise zu deaktivieren. Sie listet die aktuell installierten Versionen mit dem Installationsdatum und ob es sich um die neueste verfügbare Version handelt. Darunter befindet sich ein eingebettetes Webbrowser-Fenster, das die README-Seite der Erweiterung anzeigt (für Arbeitsbereiche und Voreinstellungspakete), oder die Wiki-Seite (für Makros).
# Select an addon on the [[Image:Folder.svg|16px]] '''Workbenches''' tab or the [[Image:Applications-python.svg|16px]] '''Macros''' tab.
# Press the {{Button|[[Image:Edit_OK.svg|16px]] Install/update selected}} button.
# 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]].


<span id="Preferences"></span>
===Konfiguration===
==Einstellungen==


Die Einstellungen für den Addon-Manager findet man im [[Preferences_Editor/de#Addon-Manager|Voreinstellungseditor]]. {{Version/de|0.20}}
# 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.


==Sorting by score==

{{Version|0.22}}

The Addon Manager supports sorting by a number of different criteria. Most of these are downloaded directly from FreeCAD's servers (which caches them from GitHub and the FreeCAD Wiki) but one, "Score," is not provided by FreeCAD at all, and only appears as an option if the Score Source URL setting is provided in the Preferences.

The Score Source URL is a path to a remote JSON-formatted document listing addons and a "score" of some kind. Score can be calculated in any way the data provider likes, but should be an integer value, with higher scores being "better" in some sense. Any addon not listed is assigned a score of zero internally. The format of the file is a single JSON dictionary where the key is the addon URL (for workbenches and preference packs) or the name of the macro (for macros). See [https://gist.githubusercontent.com/chennes/e8f60e80f16e6ffbd057dd47ca36ad2a/raw/7b118cca8e84444c3379919bbd744b99e6ef6711/addon_score_for_testing.json this data source] for an example (note the score there is simply the length of the addon's description, and is intended only for testing and demonstration purposes).

<span id="Notes"></span>
==Hinweise==
==Hinweise==


* Die Verwendung von Erweiterungen ist nicht auf die FreeCAD-Version beschränkt, mit der sie installiert wurden. Sie können auch in jeder anderen FreeCAD-Version verwenden, die von der Erweiterung unterstützt wird, die möglicherweise auf dem eigenen System vorhanden ist.
* 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.
* Die im Addon-Manager verfügbaren Erweiterungen sind nicht Teil des offiziellen FreeCAD-Programms und werden vom FreeCAD-Kernentwicklungsteam nicht unterstützt. Man solltet die bereitgestellten Informationen sorgfältig lesen, um sicherzustellen, daß man weiß, was man installiert.
* 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.
* Fehlerberichte und Anfragen für neue Funktionen sollten direkt an den Ersteller der Erweiterung gerichtet werden, durch Besuch der angegebene Webseite. Viele Erweiterungsentwickler sind regelmäßige Nutzer des [https://forum.freecadweb.org FreeCAD-Forums], und können dort auch kontaktiert werden.
* 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.
* Wenn das [https://github.com/gitpython-developers/GitPython GitPython]-Paket auf dem eigenen Computer installiert ist, wird der Addon-Manager davon Gebrauch machen, was das Herunterladen beschleunigt.
* 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]].
* Die Erweiterungen können auch manuell installiert werden. Siehe [[How_to_install_additional_workbenches/de|Wie man zusätzliche Arbeitsbereiche installiert]] und [[How_to_install_macros/de|Wie man Makros installiert]].


<span id="Information_for_addon_developers"></span>
==Informationen für Entwickler==
==Informationen für Addon-Entwickler==


Siehe [[Addon/de#Informationen für Entwickler|Erweiterung]].
<div class="mw-translate-fuzzy">
Wenn Sie einen Arbeitsbereich oder ein Makro entwickelt haben und es im Addon-Manager sehen möchten, lesen Sie auf den Repository-Seiten ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] und [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]), was zu tun ist. Wenn Sie Ihr Makro zu den [[Macros recipes/de|Maco-Rezepten]] hinzufügen, ist nichts weiteres tun, denn es wird automatisch vom Addon-Manager ausgewählt.
</div>


<span id="Scripting"></span>
===Python Arbeitsbereiche===
==Skripten==


{{Version/de|0.21}}
<div class="mw-translate-fuzzy">

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 [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons]-Repository, bleibt Ihr Code in Ihrem eigenen git-Repository, und wir werden ihn einfach als Submodul zum [https://github.com/FreeCAD/FreeCAD-addons/ 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.
Einige Funktionen des Addon-Managers sind so ausgelegt, dass auf sie über FreeCADs Python-API zugegriffen werden kann. Im einzelnen kann ein Addon über die Python-Schnittstelle installiert, aktualisiert und entfernt werden. Die meisten Anwendungen dieser API erfordern, dass ein Objekt mit mindestens drei Attributen angelegt wird: {{Incode|name}}, {{Incode|branch}} und {{Incode|url}}. Zum Beispiel:
</div>

{{Code|code=
class MyAddonClass:
def __init__(self):
self.name = "TestAddon"
self.url = "https://github.com/Me/MyTestAddon"
self.branch = "main"
my_addon = MyAddonClass()
}}

Das Objekt {{Incode|my_addon}} ist jetzt Bereit für den Einsatz mit der Addon-Manager-API.

===Commandline (non-GUI) use===

If your code needs to install or update an addon synchronously (e.g. without a GUI) the code can be very simple:

{{Code|code=
from addonmanager_installer import AddonInstaller
installer = AddonInstaller(my_addon)
installer.run()
}}

Note that this code blocks until complete, so you shouldn't run it on the main GUI thread. To the Addon manager, "install" and "update" are the same call: if this addon is already installed, and git is available, it will be updated via "git pull". If it is not installed, or was installed via a non-git installation method, it is downloaded from scratch (using git if available).

To uninstall, use:

{{Code|code=
from addonmanager_uninstaller import AddonUninstaller
uninstaller = AddonUninstaller(my_addon)
uninstaller.run()
}}

===GUI use===

If you plan on your code running in a GUI, or supporting running in the full version of FreeCAD, it's best to run your installation in a separate non-GUI thread, so the GUI remains responsive. To do this, first check to see if the GUI is running, and if it is, spawn a {{Incode|QThread}} (don't try to spawn a {{Incode|QThread}} if the GUI is not up: they require an active event loop to function).

{{Code|code=
from PySide import QtCore
from addonmanager_installer import AddonInstaller

worker_thread = QtCore.QThread()
installer = AddonInstaller(my_addon)
installer.moveToThread(worker_thread)
installer.success.connect(installation_succeeded)
installer.failure.connect(installation_failed)
installer.finished.connect(worker_thread.quit)
worker_thread.started.connect(installer.run)
worker_thread.start() # Returns immediately
}}


Then define the functions {{Incode|installation_succeeded}} and {{Incode|installation_failed}} to be run in each case. For uninstallation you can use the same technique, though it is usually much faster and will not block the GUI for very long, so in general it's safe to use the uninstaller directly, as shown above.
===C++ Arbeitsbereiche===


<div class="mw-translate-fuzzy">
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 [https://forum.freecadweb.org 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.
</div>


{{Docnav
{{Docnav/de
|[[Std_DlgCustomize|Std DlgCustomize]]
|[[Std_DlgCustomize/de|DlgAnpassen]]
|
|
|[[Std_Tools_Menu|Std Tools Menu]]
|[[Std_Tools_Menu/de|Std Menü Werkzeug]]
|IconL=Std_DlgCustomize.svg
|IconL=Std_DlgCustomize.svg
|IconR=
|IconR=
Line 105: Line 153:
{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 10:21, 2 March 2024

Std AddonManager

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

Beschreibung

Der Befehl Std Addon-Manager öffnet den Addon-Manager. Mit dem Addon-Manager können externe Arbeitsbereiche, Makros, und Voreinstellungspakete, die durch die FreeCAD-Gemeinschaft bereitgestellt werden, installiert und verwaltet werden. Standardmäßig stammen die verfügbaren Erweiterungen aus zwei Quellen, (GitHub) FreeCAD-Addons und von der Seite Makrorezepte. Wenn GitPython und git auf dem eigenen System installiert sind, werden zusätzliche Makros von (GitHub) FreeCAD-Makros geladen. Benutzerdefinierte Quellen können in den Voreinstellungen des Addon-Managers hinzugefügt werden.

Aufgrund von Änderungen an der GitHub-Plattform im Jahr 2020 funktioniert der Addon-Manager nicht mehr, wenn man die FreeCAD-Version 0.17 oder älter verwendet. Man muss auf die Version 0.18.5 oder neuer aktualisieren. Alternativ könen die Erweiterungen auch manuell installiert werden, siehe Hinweise unten.

Anwendung

  1. Den Menüeintrag Werkzeuge → Addon-Manager auswählen.
  2. Wird der Addon-Manager zum ersten Mal verwendet, wird ein Dialogfeld geöffnet, das darauf hinweist, dass die Erweiterungen im Addon-Manager kein offizieller Bestandteil von FreeCAD sind. Es enthält auch mehrere Optionen, die mit der Verwendung von Daten durch den Addon-Manager zusammenhängen. Hat man diese Optionen den eigenen Vorlieben entsprechend eingestellt, drückt man die Schaltfläche OK, um zu bestätigen und fortzufahren.
  3. Das Dialogfeld Addon-Manager öffnet sich. Für weitere Informationen siehe Optionen.
  4. Die Schaltfläche Alles aktualisieren funktioniert zurzeit nicht.
  5. Die Schaltfläche Schließen drücken, um das Dialogfeld zu schließen.
  6. Wenn ein Arbeitsbereich installiert oder aktualisiert wurde, wird ein neues Dialogfeld geöffnet, das darauf hinweist, dass FreeCAD neu gestartet werden muss, damit die Änderungen wirksam werden.

Optionen

  1. Der Addon-Manager stellt zwei Layouts zur Verfügung: "Schmal" and "Erweitert". In der "schmalen" Ansicht füllt eine Erweiterung eine einzelne Zeile und ihre Beschreibung wird gekürzt, um in den vorhandenen Platz zu passen. "Erweitert" stellt zusätzliche Einzelheiten dar, wie weiteren Beschreibungstext und auch Informationen für Bearbeiter, weitere Installationsdetails usw.
  2. Drei Arten von Erweiterungen werden unterstützt: Arbeitsbereiche, Makros, und Voreinstellungspakete. Man kann wählen, ob nur eine Art angezeigt wird oder alle in einer einzigen Liste.
  3. Die Liste kann so eingegrenzt werden, dass sie nur installierte Pakete, nur Pakete mit erhältlichen Aktualisierungen oder nur Pakete, die noch nicht installiert wurden, enthält.
  4. Die Liste kann gefiltert werden durch die Suche nach Schlüsselwörtern in Benennung, Beschreibung und Kennzeichen (Beschreibung und Kennzeichnung müssen vom Addon-Entwickler in den Meta-Daten angegeben werden). Der Filter kann sogar ein regulärer Ausdruck sein, für eine präzise Steuerung des genauen Suchbegriffs.
  5. Die erweiterte Ansicht zeigt enthaltene Versionsinformationen, Beschreibungen, Informationen für Bearbeiter und Informationen zur Version der Installation für Pakete mit einer Paket-Meta-Daten-Datei (oder für Makros mit eingebetteten Meta-Daten).
  6. Die Addon-Daten werden lokal zwischengespeichert, mit einer variablen Häufigkeit der Aktualisierung des Zwischnspeichers, festgelegt in den Benutzereinstellungen.
  7. Zu jeder Zeit kann die manuelle Aktualisierung des lokalen Zwischenspeichers ausgewählt werden, um die neuesten verfügbaren Aktualisierungen für alle Erweiterungen anzuzeigen.
  8. Die Suche nach Aktualisierungen kann auf automatisch eingestellt sein oder manuell erfolgen durch einen Klick auf eine Schaltfläche (festgelegt in den Benutzereinstellungen). Wenn GitPython und git auf dem eigenen System installiert sind, werden die Aktualisierungsinformationen unter Verwendung von git abgeholt. Wenn nicht, werden Informationen zu Aktualisierungen aus allen vorhandenen Meta-Daten-Datein ausgelesen.

Klickt man in dieser Ansicht auf eine Erweiterung, wird eine Seite mit Einzelheiten zu dieser Erweiterung geöffnet:

Diese Seite mit Einzelheiten zeigt Schaltflächen, die es erlauben Erweiterungen zu installieren, zu deinstallieren, zu aktualisieren und zeitweise zu deaktivieren. Sie listet die aktuell installierten Versionen mit dem Installationsdatum und ob es sich um die neueste verfügbare Version handelt. Darunter befindet sich ein eingebettetes Webbrowser-Fenster, das die README-Seite der Erweiterung anzeigt (für Arbeitsbereiche und Voreinstellungspakete), oder die Wiki-Seite (für Makros).

Einstellungen

Die Einstellungen für den Addon-Manager findet man im Voreinstellungseditor. eingeführt mit Version 0.20

Sorting by score

introduced in version 0.22

The Addon Manager supports sorting by a number of different criteria. Most of these are downloaded directly from FreeCAD's servers (which caches them from GitHub and the FreeCAD Wiki) but one, "Score," is not provided by FreeCAD at all, and only appears as an option if the Score Source URL setting is provided in the Preferences.

The Score Source URL is a path to a remote JSON-formatted document listing addons and a "score" of some kind. Score can be calculated in any way the data provider likes, but should be an integer value, with higher scores being "better" in some sense. Any addon not listed is assigned a score of zero internally. The format of the file is a single JSON dictionary where the key is the addon URL (for workbenches and preference packs) or the name of the macro (for macros). See this data source for an example (note the score there is simply the length of the addon's description, and is intended only for testing and demonstration purposes).

Hinweise

  • Die Verwendung von Erweiterungen ist nicht auf die FreeCAD-Version beschränkt, mit der sie installiert wurden. Sie können auch in jeder anderen FreeCAD-Version verwenden, die von der Erweiterung unterstützt wird, die möglicherweise auf dem eigenen System vorhanden ist.
  • Die im Addon-Manager verfügbaren Erweiterungen sind nicht Teil des offiziellen FreeCAD-Programms und werden vom FreeCAD-Kernentwicklungsteam nicht unterstützt. Man solltet die bereitgestellten Informationen sorgfältig lesen, um sicherzustellen, daß man weiß, was man installiert.
  • Fehlerberichte und Anfragen für neue Funktionen sollten direkt an den Ersteller der Erweiterung gerichtet werden, durch Besuch der angegebene Webseite. Viele Erweiterungsentwickler sind regelmäßige Nutzer des FreeCAD-Forums, und können dort auch kontaktiert werden.
  • Wenn das GitPython-Paket auf dem eigenen Computer installiert ist, wird der Addon-Manager davon Gebrauch machen, was das Herunterladen beschleunigt.
  • Die Erweiterungen können auch manuell installiert werden. Siehe Wie man zusätzliche Arbeitsbereiche installiert und Wie man Makros installiert.

Informationen für Addon-Entwickler

Siehe Erweiterung.

Skripten

eingeführt mit Version 0.21

Einige Funktionen des Addon-Managers sind so ausgelegt, dass auf sie über FreeCADs Python-API zugegriffen werden kann. Im einzelnen kann ein Addon über die Python-Schnittstelle installiert, aktualisiert und entfernt werden. Die meisten Anwendungen dieser API erfordern, dass ein Objekt mit mindestens drei Attributen angelegt wird: name, branch und url. Zum Beispiel:

class MyAddonClass:
    def __init__(self):
        self.name = "TestAddon"
        self.url = "https://github.com/Me/MyTestAddon"
        self.branch = "main"
my_addon = MyAddonClass()

Das Objekt my_addon ist jetzt Bereit für den Einsatz mit der Addon-Manager-API.

Commandline (non-GUI) use

If your code needs to install or update an addon synchronously (e.g. without a GUI) the code can be very simple:

from addonmanager_installer import AddonInstaller
installer = AddonInstaller(my_addon)
installer.run()

Note that this code blocks until complete, so you shouldn't run it on the main GUI thread. To the Addon manager, "install" and "update" are the same call: if this addon is already installed, and git is available, it will be updated via "git pull". If it is not installed, or was installed via a non-git installation method, it is downloaded from scratch (using git if available).

To uninstall, use:

from addonmanager_uninstaller import AddonUninstaller
uninstaller = AddonUninstaller(my_addon)
uninstaller.run()

GUI use

If you plan on your code running in a GUI, or supporting running in the full version of FreeCAD, it's best to run your installation in a separate non-GUI thread, so the GUI remains responsive. To do this, first check to see if the GUI is running, and if it is, spawn a QThread (don't try to spawn a QThread if the GUI is not up: they require an active event loop to function).

from PySide import QtCore
from addonmanager_installer import AddonInstaller

worker_thread = QtCore.QThread()
installer = AddonInstaller(my_addon)
installer.moveToThread(worker_thread)
installer.success.connect(installation_succeeded)
installer.failure.connect(installation_failed)
installer.finished.connect(worker_thread.quit)
worker_thread.started.connect(installer.run)
worker_thread.start() # Returns immediately

Then define the functions installation_succeeded and installation_failed to be run in each case. For uninstallation you can use the same technique, though it is usually much faster and will not block the GUI for very long, so in general it's safe to use the uninstaller directly, as shown above.