Strumenti: Addon manager

From FreeCAD Documentation
Revision as of 16:29, 23 April 2023 by Marco T (talk | contribs) (Created page with "==Preferenze==")

Addon manager

Posizione nel menu
Strumenti → Addon manager
Ambiente
Tutti
Avvio veloce
Nessuno
Introdotto nella versione
0.17
Vedere anche
Macro, Ambienti complementari

Descrizione

Il comando Addon manager apre il gestore Addon. Con Addon Manager è possibile installare e gestire Ambienti complementari, macro e Pacchetti di Preferenze forniti dalla community di FreeCAD. Per impostazione predefinita, i componenti aggiuntivi disponibili sono presi da due repository, [1] e dalla pagina Raccolta di macro. Se GitPython e git sono installati sul proprio sistema, macro aggiuntive verranno caricate da FreeCAD-macros. I repository personalizzati possono essere aggiunti nelle Preferenze di Addon manager.

A causa delle modifiche alla piattaforma GitHub nell'anno 2020, il gestore Addon non funziona più se si utilizza FreeCAD versione 0.17 o precedente. È necessario eseguire l'aggiornamento alla versione 0.18.5 o successiva. In alternativa è possibile installare i componenti aggiuntivi manualmente, vedi Note di seguito.

Utilizzo

  1. Selezionare l'opzione Strumenti → Addon manager dal menu principale.
  2. La prima volta che si usa il gestore Addon si apre una finestra di dialogo che avverte che i componenti aggiuntivi nel gestore Addon non fanno ufficialmente parte di FreeCAD. Presenta inoltre diverse opzioni relative all'utilizzo dei dati da parte del gestore Addon. Regolare queste opzioni a proprio piacimento e premere il pulsante OK per confermare e continuare.
  3. Viene visualizzata la finestra di dialogo Addon manager. Per ulteriori informazioni, vedere le Opzioni.
  4. Se è stato installato o aggiornato un ambiente di lavoro, si aprirà una nuova finestra di dialogo per informare che si deve riavviare FreeCAD affinché le modifiche abbiano effetto.

Opzioni

  1. Il gestore Addon fornisce due layout di visualizzazione: "Condensato" ed "Espanso". Nella vista "Condensata", ogni componente aggiuntivo occupa una singola riga e la sua descrizione viene troncata per adattarsi allo spazio disponibile. "Espanso" mostra dettagli aggiuntivi, tra cui più testo descrittivo, informazioni sul manutentore, ulteriori dettagli sull'installazione, ecc.
  2. Sono supportati tre diversi tipi di componenti aggiuntivi: Ambienti di lavoro, Macro e Pacchetti Preferenze. E' possibile scegliere di mostrare solo un tipo o tutti in un unico elenco.
  3. L'elenco può essere limitato per mostrare solo i pacchetti installati, solo i pacchetti con aggiornamenti disponibili o solo i pacchetti che non sono ancora installati.
  4. L'elenco può essere filtrato, cercando una parola chiave nel titolo, nella descrizione e nei tag (descrizione e tag devono essere specificati dallo sviluppatore dell'addon nei metadati dell'addon). Il filtro può anche essere un'espressione regolare, per un controllo granulare dell'esatto termine di ricerca.
  5. La vista espansa mostra le informazioni sulla versione disponibili, la descrizione, le informazioni sul manutentore e le informazioni sulla versione dell'installazione, per i pacchetti che forniscono un file Metadati pacchetto (o per macro con metadati incorporati).
  6. I dati del componente aggiuntivo vengono memorizzati nella cache locale, con una frequenza di aggiornamento della cache variabile impostata nelle preferenze dell'utente.
  7. In qualsiasi momento è possibile scegliere di aggiornare manualmente la propria cache locale per vedere gli ultimi aggiornamenti disponibili per ogni componente aggiuntivo.
  8. I controlli degli aggiornamenti possono essere impostati per essere automatici o eseguiti manualmente tramite un clic del pulsante (configurato nelle preferenze dell'utente). Se GitPython e git sono installati sul proprio sistema, le informazioni di aggiornamento vengono recuperate utilizzando git. In caso contrario, le informazioni di aggiornamento vengono ottenute da qualsiasi file di metadati presente.

Facendo clic su un componente aggiuntivo in questa visualizzazione viene visualizzata la pagina dei dettagli del componente aggiuntivo:

La pagina dei dettagli mostra i pulsanti che consentono di installare, disinstallare, aggiornare e disabilitare temporaneamente un componente aggiuntivo. Per i componenti aggiuntivi installati elenca la versione attualmente installata e la data di installazione e se si tratta della versione più recente disponibile. Di seguito è riportata una finestra del browser Web incorporata che mostra la pagina README dell'addon (per Ambiente di lavoro e Pacchetti di preferenze) o la pagina Wiki (per le macro).

Preferenze

The preferences for the Addon manager can be found in the Preferences Editor. introduced in version 0.20

Note

  • I componenti aggiuntivi disponibili in Addon manager non fanno parte del programma ufficiale FreeCAD e non sono supportati dal team di sviluppo principale di FreeCAD. Bisogna leggere attentamente le informazioni fornite per assicurarsi di sapere cosa si sta installando.
  • Segnalazioni di bug e richieste di funzionalità devono essere inviate direttamente al creatore del componente aggiuntivo visitando il sito Web indicato. Molti sviluppatori di componenti aggiuntivi sono utenti regolari del FreeCAD forum, e possono anche essere contattato lì.
  • Se sul computer è installato il pacchetto GitPython, il gestore Addon lo utilizza, rendendo i download più veloci.
  • È inoltre possibile installare i componenti aggiuntivi manualmente. Vedere Come installare gli ambienti aggiuntivi and Come installare le macro.

Informazioni per gli sviluppatori

See Addon.

Scripting

introduced in version 1.0

Some features of the Addon manager are designed for access via FreeCAD's Python API. In particular an addon can be installed, updated, and removed via the Python interface. Most uses of this API require you to create an object with at least three attributes: name, branch and url. For example:

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

Your object my_addon is now ready for use with the 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.