Std AddonMgr/de: Difference between revisions

From FreeCAD Documentation
(Created page with "* 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...")
(Updating to match new version of source page)
 
(101 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Docnav/de
|[[Std_DlgCustomize/de|DlgAnpassen]]
|
|[[Std_Tools_Menu/de|Std Menü Werkzeug]]
|IconL=Std_DlgCustomize.svg
|IconR=
|IconC=Freecad.svg
}}

{{GuiCommand/de
{{GuiCommand/de
|Name/de=Addon manager
|Name=Std AddonMgr
|Icon=AddonManager.svg
|Name/de=Std AddonManager
|MenuLocation=Werkzeuge → Addon manager
|MenuLocation=Werkzeuge → Addon-Manager
|Workbenches=Alle
|Workbenches=Alle
|SeeAlso=[[Macros/de|Makros]],[[External workbenches/de|Externe Arbeitsbereiche]]
|Version=0.17
|Version=0.17
|SeeAlso=[[External_workbenches/de|Externe Arbeitsbereiche]], [[Macros/de|Makros]]
}}
}}


<span id="Description"></span>
<div class="mw-translate-fuzzy">
==Beschreibung==
Der Addon-Manager erlaubt es, [[external workbenches/de|externe Arbeitsbereiche]] und [[macros/de|Makros]] zu installieren, zu aktualisieren und zu löschen. Falls das [https://github.com/gitpython-developers/GitPython git-python]-Paket auf Deinem Computer installiert ist, wird es der Addon-Manager benutzen, um installierte Arbeitsbereiche zu aktualisieren und Downloads zu beschleunigen.
</div>


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.
Eine vollständige Liste der Arbeitsbereiche und Makros finden Sie in zwei Repositories, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] und [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros], sowie den [[Macros recipes/de|Macro Rezepten]].


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.
[[Image:Addon_Manager_example.png]]
{{Caption|Schnittstelle des [[AddonManager/de|Addon-Managers]]}}


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


* Öffnen Sie das Werkzeug im Menü {{MenuCommand|Werkzeuge → Extras → Addon-Manager}}.
# Den Menüeintrag {{MenuCommand|Werkzeuge → [[Image:Std_AddonMgr.svg|16px]] Addon-Manager}} auswählen.
# 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.
* 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 Taste {{Button|Install/update}}, um das neue Werkzeug zu installieren. Bei Makros drücken Sie {{MenuCommand|Makros}} und wiederholen Sie die Schritte.
# Das Dialogfeld Addon-Manager öffnet sich. Für weitere Informationen siehe [[#Optionen|Optionen]].
* 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 Taste {{Button|Remove}} Taste.
# Die Schaltfläche {{Button|[[Image:Button_valid.svg|16px]] Alles aktualisieren}} funktioniert zurzeit nicht.
* 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 Taste {{Button|Install/update}}.
# Die Schaltfläche {{Button|[[Image:Process-stop.svg|16px]] Schließen}} drücken, um das Dialogfeld zu schließen.
* Nach Updates suchen: Drücken Sie die Taste {{Button|[[File: Std Refresh.png | 24px]]}}. ( Hinweis: das Symbol kann je nach Betriebssystem anders aussehen. ) Verfügbare Updates werden unterhalb der Liste angezeigt. Durch erneutes Drücken der Update-Taste werden alle Updates gleichzeitig aktualisiert.
# 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 ein Makro auszuführen: Installieren Sie zuerst das gewünschte Makro, wählen Sie es erneut in der Liste und drücken Sie den {{Button|Execute}}-Button.
* Drücken Sie {{Button|Close}}, um den Manager zu beenden.


<span id="Options"></span>
=== Manuelle Installation ===
==Optionen==
Wenn Sie den Addon-Manager nicht verwenden, können Sie die neuen Werkzeuge manuell installieren, indem Sie deren Code in Ihrem {{incode|FreeCAD/}}-Benutzerverzeichnis ablegen. Details finden Sie unter:
* [[How to install macros/de|Makros installieren]]
* [[How to install additional workbenches/de|Zusätzliche Arbeitsbereiche installieren]]


[[File:AddonManager_Main.png|600px]]
==Einschränkungen==


# 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.
* 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.
# 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:
* 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.

[[File:AddonManager_Details.png|600px]]

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).

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

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

==Sorting by score==

{{Version|1.0}}

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==

* 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 [https://forum.freecadweb.org FreeCAD-Forums], und können dort auch kontaktiert werden.
* 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.
* 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 Addon-Entwickler==

Siehe [[Addon/de#Informationen für Entwickler|Erweiterung]].

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

{{Version/de|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: {{Incode|name}}, {{Incode|branch}} und {{Incode|url}}. Zum Beispiel:


* 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
{{Code|code=
{{Code|code=
class MyAddonClass:
$ROOT/Mod/AddonManager/AddonManager.py
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.
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}}


===Commandline (non-GUI) use===
== New workbenches and macros ==


If your code needs to install or update an addon synchronously (e.g. without a GUI) the code can be very simple:
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]], there is nothing else to do, it will automatically be picked by the Addon Manager.


{{Code|code=
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.
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).
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.


To uninstall, use:
{{Userdocnavi}}


{{Code|code=
[[Category:Addons]]
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.


{{Docnav/de
|[[Std_DlgCustomize/de|DlgAnpassen]]
|
|[[Std_Tools_Menu/de|Std Menü Werkzeug]]
|IconL=Std_DlgCustomize.svg
|IconR=
|IconC=Freecad.svg
}}


{{Std Base navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 10:06, 21 April 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 1.0

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.