Std AddonMgr/it: Difference between revisions

From FreeCAD Documentation
(Created page with "Per testare la capacità di download di Addon Manager è possibile simulare la necessità di scaricare per esempio una versione precedente di un workbench tramite l'interfacci...")
No edit summary
 
(78 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Docnav/it
|[[Std_DlgCustomize/it|Personalizzare gli strumenti]]
|
|[[Std_Tools_Menu/it|Menu strumenti]]
|IconL=Std_DlgCustomize.svg
|IconR=
|IconC=Freecad.svg
}}

{{GuiCommand/it
{{GuiCommand/it
|Name=Std AddonMgr
|Name=Std_AddonMgr
|Name/it=Addon manager
|Name/it=Addon manager
|Icon=AddonManager.svg
|MenuLocation=Strumenti → Addon manager
|MenuLocation=Strumenti → Addon manager
|Workbenches=Tutti
|Workbenches=Tutti
|SeeAlso=[[Macros/it|Macro]], [[External workbenches/it|Ambienti complementari]]
|Version=0.17
|Version=0.17
|SeeAlso=[[Macros/it|Macro]], [[External workbenches/it|Ambienti complementari]]
}}
}}


<span id="Description"></span>
'''Addon Manager''' è uno strumento per installare e gestire gli [[external workbenches/it|ambienti aggiuntivi]] e le [[macros/it|macro]] forniti dalla comunità di FreeCAD. Se nel computer è installato il pacchetto [https://github.com/gitpython-developers/GitPython git-python], Addon Manager lo usa per aggiornare gli ambienti installati, rendendo i download più veloci.
==Descrizione==


Gli elenchi degli ambienti e delle macro installabili sono presi da due repository, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] e [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros], rispettivamente, e dagli [[Macros recipes/it|Esempi di macro]].
Il comando '''Addon manager''' apre il gestore Addon. Con Addon Manager è possibile installare e gestire [[external_workbenches/it|Ambienti complementari]], [[macros/it|macro]] e [[Preference_Packs/it|Pacchetti di Preferenze]] forniti dalla community di FreeCAD. Per impostazione predefinita, i componenti aggiuntivi disponibili sono presi da due repository, [https://github.com/FreeCAD/FreeCAD-addons/FreeCAD-addons] e dalla pagina [[Macros_recipes/it|Raccolta di macro]]. Se GitPython e git sono installati sul proprio sistema, macro aggiuntive verranno caricate da [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]. I repository personalizzati possono essere aggiunti nelle [[Preferences_Editor#Addon_Manager/it|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 [https://github.com/FreeCAD/FreeCAD/releases/tag/0.18.5 0.18.5] o successiva. In alternativa è possibile installare i componenti aggiuntivi manualmente, vedi [[#Note|Note]] di seguito.
[[Image:Addon_Manager_example.png]]
{{Caption|Interfaccia di [[Addon Manager/it|Addon Manager]]}}


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


* Aprire il menu {{MenuCommand|Strumenti → Addon manager}}.
# Selezionare l'opzione {{MenuCommand|Strumenti → [[Image:Std_AddonMgr.svg|16px]] Addon manager}} dal menu principale.
# 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 {{Button|OK}} per confermare e continuare.
* Per installare un workbench: scorrere l'elenco e selezionare il componente aggiuntivo. La descrizione del componente aggiuntivo viene visualizzata sotto l'elenco, assieme al collegamento alla pagina del componente aggiuntivo. Quindi premere il pulsante {{Button|Install/update}} per installare il nuovo ambiente.
# Viene visualizzata la finestra di dialogo Addon manager. Per ulteriori informazioni, vedere le [[Std_AddonMgr/it#Opzioni|Opzioni]].
Per le macro, fare clic sulla scheda {{MenuCommand|Macro}} e fare gli stessi passaggi.
# 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.
* Per rimuovere un workbench o una macro: scorrere l'elenco, selezionare il componente aggiuntivo quindi premere il pulsante {{Button|Remove}}.
* Per aggiornare un workbench o una macro: scorrere l'elenco, selezionare il componente aggiuntivo quindi premere il pulsante {{Button|Install/update}}.
* Per verificare gli aggiornamenti: premere il pulsante {{Button|[[File:Std Refresh.png|24px]]}}. (''Nota: l'icona può apparire diversa a seconda del sistema operativo.'') Gli aggiornamenti disponibili verranno riportati sotto l'elenco. Premendo di nuovo il pulsante di aggiornamento si aggiorneranno tutti gli aggiornamenti contemporaneamente.
* Per eseguire una macro: prima installare la macro desiderata, quindi selezionarla nuovamente nell'elenco, quindi premere il tasto {{Button|Esegui}}. La macro viene editata automaticamente nell'editor macro di FreeCAD, per visualizzare il codice.
* Premere {{Button|Chiudi}} per uscire dal manager.
Per far comparire nell'elenco e rendere disponili i nuovi ambienti bisogna riavviare FreeCAD . Gli ambienti vengono aggiunti alla fine, se si desidera averli in ordine alfabetico, è possibile riorganizzarli nella finestra di dialogo [[Std DlgCustomize/it|Personalizza]].


<span id="Options"></span>
=== Installazione manuale ===
==Opzioni==
Se non si utilizza Addon Manager, è possibile installare manualmente i nuovi strumenti inserendo il loro codice nella directory {{incode|FreeCAD/}} dell'utente. Vedere i seguenti collegamenti per i dettagli:
* [[How to install macros/it|Come installare le macro]]
* [[How to install additional workbenches/it|Come installare gli ambienti aggiuntivi]]


[[File:AddonManager_Main.png|600px]]
==Limitazioni==


# 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.
* I componenti aggiuntivi non fanno parte del pacchetto FreeCAD ufficiale e non sono supportati dal team ddi sviluppatori di FreeCAD. È necessario leggere le informazioni fornite su ciascuna delle pagine della home del componente aggiuntivo prima di installare qualsiasi di essi, per essere sicuri di sapere cosa si sta installando.
# Sono supportati tre diversi tipi di componenti aggiuntivi: [[external_workbenches/it|Ambienti di lavoro]], [[macros/it|Macro]] e [[Preference_Packs/it|Pacchetti Preferenze]]. E' possibile scegliere di mostrare solo un tipo o tutti in un unico elenco.
# 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.
# 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.
# 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/it|Metadati pacchetto]] (o per macro con metadati incorporati).
# I dati del componente aggiuntivo vengono memorizzati nella cache locale, con una frequenza di aggiornamento della cache variabile impostata nelle preferenze dell'utente.
# In qualsiasi momento è possibile scegliere di aggiornare manualmente la propria cache locale per vedere gli ultimi aggiornamenti disponibili per ogni componente aggiuntivo.
# 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:
* Le segnalazioni di bug e le richieste di funzionalità dovrebbero essere fatte direttamente al creatore del componente aggiuntivo visitando il sito Web indicato. Molti autori aggiuntivi sono utenti regolari del [https://forum.freecadweb.org forum di FreeCAD] e possono essere contattati lì.


[[File:AddonManager_Details.png|600px]]
* Gli indirizzi Web dei repository per i componenti aggiuntivi e per le macro sono codificati in AddonManager. Poiché questa applicazione è scritta in Python, gli utenti esperti possono cambiare queste posizioni modificando i campi appropriati in

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

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

Le preferenze per Addon Manager si trovano nell'[[Preferences_Editor/it#Addon_Manager|Editor delle Preferenze]]. {{Version/it|0.20}}

<span id="Sorting_by_score"></span>
==Ordinamento per punteggio==

{{Version/it|0.22}}

L'Addon Manager supporta l'ordinamento in base a una serie di criteri diversi. La maggior parte di questi vengono scaricati direttamente dai server di FreeCAD (che li memorizza nella cache da GitHub e FreeCAD Wiki) ma uno, "Punteggio", non è fornito da FreeCAD e appare come opzione solo se l'impostazione URL Sorgente del Punteggio è fornita nelle Preferenze.

L'URL Sorgente del Punteggio è un percorso verso un documento remoto in formato JSON che elenca componenti aggiuntivi e un "punteggio" di qualche tipo. Il punteggio può essere calcolato in qualsiasi modo piaccia al fornitore di dati, ma dovrebbe essere un valore intero, dove i punteggi più alti sono "migliori" in un certo senso. A qualsiasi componente aggiuntivo non elencato viene assegnato internamente un punteggio pari a zero. Il formato del file è un singolo dizionario JSON in cui la chiave è l'URL del componente aggiuntivo (per ambienti di lavoro e pacchetti di preferenze) o il nome della macro (per le macro). Vedere [https://gist.githubusercontent.com/chennes/e8f60e80f16e6ffbd057dd47ca36ad2a/raw/7b118cca8e84444c3379919bbd744b99e6ef6711/addon_score_for_testing.jsu questa fonte dati] per un esempio (notare che il punteggio è semplicemente la lunghezza della descrizione del componente aggiuntivo, ed è destinato esclusivamente ai test e scopi dimostrativi).

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

* L'uso dei componenti aggiuntivi non è limitato alla versione di FreeCAD da cui sono stati installati. Si potrà anche usarli in qualsiasi altra versione di FreeCAD, supportata dall'addon, presente sul proprio sistema.
* 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 [https://forum.freecadweb.org FreeCAD forum], e possono anche essere contattato lì.
* Se sul computer è installato il pacchetto [https://github.com/gitpython-developers/GitPython GitPython], il gestore Addon lo utilizza, rendendo i download più veloci.
* È inoltre possibile installare i componenti aggiuntivi manualmente. Vedere [[How_to_install_additional_workbenches/it|Come installare gli ambienti aggiuntivi]] and [[How_to_install_macros/it|Come installare le macro]].

<span id="Information_for_addon_developers"></span>
==Informazioni per gli sviluppatori di addon==

Vedere [[Addon/it#Informazioni_per_sviluppatori|Addon]].

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

{{Version/it|0.21}}

Alcune funzionalità del gestore Addon sono progettate per l'accesso tramite l'API Python di FreeCAD. In particolare un componente aggiuntivo può essere installato, aggiornato e rimosso tramite l'interfaccia Python. La maggior parte degli usi di questa API richiede la creazione di un oggetto con almeno tre attributi: {{Incode|name}}, {{Incode|branch}} e {{Incode|url}}. Per esempio:


{{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()
}}
}}


Il proprio oggetto {{Incode|my_addon}} è ora pronto per essere utilizzato con l'API Addon Manager.
dove {{incode|$ROOT}} è la directory di installazione di FreeCAD nel proprio sistema, per esempio,
* Linux: {{incode|/usr/lib/freecad/Mod/AddonManager/AddonManager.py}}
* Windows: {{Incode|C:\Program Files\FreeCAD version\Mod\AddonManager.py}}


<span id="Commandline_(non-GUI)_use"></span>
== Nuovi ambienti di lavoro e macro ==
===Utilizzo da riga di comando (non-GUI)===


Se il proprio codice deve installare o aggiornare un componente aggiuntivo in modo sincrono (ad esempio senza una GUI), il codice può essere molto semplice:
Se avete sviluppato un workbench o una macro e volete vederlo incluso in Addon Manager, leggete come farlo nelle pagine del repository ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] e [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]). Se aggiungete la vostra macro a [[Macros recipes]], non dovete fare nient'altro, essa verrà automaticamente selezionata da Addon Manager.


{{Code|code=
Per i workbench Python, non è necessaria alcuna approvazione specifica per aggiungerlo a Addon manager e, essendo al di fuori del codice sorgente di FreeCAD, è possibile scegliere la licenza desiderata. Se si richiede che il proprio workbench sia aggiunto alla lista (senza la richiesta dei suoi autori non viene aggiunto nessun nuovo workbench), sia chiedendolo sul forum o aprendo una istanza nel repository [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons], il codice continua a rimanere sul repository git dell'autore, e viene semplicemente aggiunto come sottomodulo al repository [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons]. Ovviamente, prima di aggiungere un nuovo workbench, viene data un'occhiata al codice per verificare che non contenga nulla di potenzialmente problematico.
from addonmanager_installer import AddonInstaller
installer = AddonInstaller(my_addon)
installer.run()
}}


Notare che questo codice si blocca fino al completamento, quindi non lo si dovrebbe eseguire sul thread della GUI principale. Per il gestore Addon, "install" e "update" sono la stessa chiamata: se questo addon è già installato e git è disponibile, verrà aggiornato tramite "git pull". Se non è installato o è stato installato tramite un metodo di installazione diverso da git, viene scaricato da zero (utilizzando git se disponibile).
Se si sviluppa un workbench in C++, esso non può essere eseguito direttamente dagli utenti e deve prima essere compilato. Quindi si hanno due opzioni, o fornire le versioni precompilate del proprio workbench per i diversi sistemi operativi, oppure si deve chiedere di unire il proprio codice al codice sorgente di FreeCAD. Per questo, si deve usare la licenza LGPL (o completamente compatibile come MIT o BSD), e si deve presentare i nuovi strumenti alla comunità nel [https://forum.freecadweb.org forum di FreeCAD] per la revisione. Quando il codice è stato testato e approvato, è necessario creare una biforcazione nel repository di FreeCAD, se non ancora fatto, e creare un nuovo ramo, inserirvi il codice e aprire una richiesta di pull in modo che il ramo venga unito al repository principale.


Per disinstallare, utilizzare:
== Test di Addon Manager ==
{{VeryImportantMessage|Questa sezione è per gli sviluppatori}}
Addon Manager è codificato in Python, quindi è possibile modificare il codice sorgente senza compilarlo. Più specificamente, il test richiede la modifica del codice in <tt>FreeCAD/src/Mod/AddonManager</tt> e semplicemente rieseguire FreeCAD.

Per testare la capacità di download di Addon Manager è possibile simulare la necessità di scaricare per esempio una versione precedente di un workbench tramite l'interfaccia della riga di comando. Nell'esempio seguente useremo l'ambiente Assembly2+, o [[A2plus_Workbench/it|A2plus]]:


{{Code|code=
{{Code|code=
from addonmanager_uninstaller import AddonUninstaller
cd ~/FreeCAD/Mod/A2plus/
uninstaller = AddonUninstaller(my_addon)
git reset --hard "v0.4.21"
uninstaller.run()
}}
}}


<span id="GUI_use"></span>
CLI output should show '''HEAD is now at b2c53a4 Merge pull request #281 from kbwbe/devel'''
===Utilizzo con GUI===


Se si prevede di eseguire il codice in una GUI o di supportare l'esecuzione nella versione completa di FreeCAD, è meglio eseguire l'installazione in un thread non GUI separato, in modo che la GUI rimanga reattiva. Per fare ciò, controllare prima se la GUI è in esecuzione e, in tal caso, generare un {{Incode|QThread}} (non provare a generare un {{Incode|QThread}} se la GUI non è attiva: richiedono un ciclo di eventi attivo per funzionare).
<div class="mw-translate-fuzzy">
{{Userdocnavi/it}}
</div>


{{Code|code=
{{Userdocnavi/it}}
from PySide import QtCore
from addonmanager_installer import AddonInstaller


worker_thread = QtCore.QThread()
[[Category:Addons/it]]
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
}}

Quindi definire le funzioni {{Incode|installation_succeeded}} e {{Incode|installation_failed}} da eseguire in ciascun caso. Per la disinstallazione è possibile usare la stessa tecnica, anche se di solito è molto più veloce e non bloccherà la GUI per molto tempo, quindi in generale è sicuro usare direttamente il programma di disinstallazione, come mostrato sopra.


{{Docnav/it
|[[Std_DlgCustomize/it|Personalizzare gli strumenti]]
|
|[[Std_Tools_Menu/it|Menu strumenti]]
|IconL=Std_DlgCustomize.svg
|IconR=
|IconC=Freecad.svg
}}


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

Latest revision as of 20:40, 2 March 2024

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

Le preferenze per Addon Manager si trovano nell'Editor delle Preferenze. disponibile dalla versione 0.20

Ordinamento per punteggio

disponibile dalla versione 0.22

L'Addon Manager supporta l'ordinamento in base a una serie di criteri diversi. La maggior parte di questi vengono scaricati direttamente dai server di FreeCAD (che li memorizza nella cache da GitHub e FreeCAD Wiki) ma uno, "Punteggio", non è fornito da FreeCAD e appare come opzione solo se l'impostazione URL Sorgente del Punteggio è fornita nelle Preferenze.

L'URL Sorgente del Punteggio è un percorso verso un documento remoto in formato JSON che elenca componenti aggiuntivi e un "punteggio" di qualche tipo. Il punteggio può essere calcolato in qualsiasi modo piaccia al fornitore di dati, ma dovrebbe essere un valore intero, dove i punteggi più alti sono "migliori" in un certo senso. A qualsiasi componente aggiuntivo non elencato viene assegnato internamente un punteggio pari a zero. Il formato del file è un singolo dizionario JSON in cui la chiave è l'URL del componente aggiuntivo (per ambienti di lavoro e pacchetti di preferenze) o il nome della macro (per le macro). Vedere questa fonte dati per un esempio (notare che il punteggio è semplicemente la lunghezza della descrizione del componente aggiuntivo, ed è destinato esclusivamente ai test e scopi dimostrativi).

Note

  • L'uso dei componenti aggiuntivi non è limitato alla versione di FreeCAD da cui sono stati installati. Si potrà anche usarli in qualsiasi altra versione di FreeCAD, supportata dall'addon, presente sul proprio sistema.
  • 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 di addon

Vedere Addon.

Script

disponibile dalla versione 0.21

Alcune funzionalità del gestore Addon sono progettate per l'accesso tramite l'API Python di FreeCAD. In particolare un componente aggiuntivo può essere installato, aggiornato e rimosso tramite l'interfaccia Python. La maggior parte degli usi di questa API richiede la creazione di un oggetto con almeno tre attributi: name, branch e url. Per esempio:

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

Il proprio oggetto my_addon è ora pronto per essere utilizzato con l'API Addon Manager.

Utilizzo da riga di comando (non-GUI)

Se il proprio codice deve installare o aggiornare un componente aggiuntivo in modo sincrono (ad esempio senza una GUI), il codice può essere molto semplice:

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

Notare che questo codice si blocca fino al completamento, quindi non lo si dovrebbe eseguire sul thread della GUI principale. Per il gestore Addon, "install" e "update" sono la stessa chiamata: se questo addon è già installato e git è disponibile, verrà aggiornato tramite "git pull". Se non è installato o è stato installato tramite un metodo di installazione diverso da git, viene scaricato da zero (utilizzando git se disponibile).

Per disinstallare, utilizzare:

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

Utilizzo con GUI

Se si prevede di eseguire il codice in una GUI o di supportare l'esecuzione nella versione completa di FreeCAD, è meglio eseguire l'installazione in un thread non GUI separato, in modo che la GUI rimanga reattiva. Per fare ciò, controllare prima se la GUI è in esecuzione e, in tal caso, generare un QThread (non provare a generare un QThread se la GUI non è attiva: richiedono un ciclo di eventi attivo per funzionare).

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

Quindi definire le funzioni installation_succeeded e installation_failed da eseguire in ciascun caso. Per la disinstallazione è possibile usare la stessa tecnica, anche se di solito è molto più veloce e non bloccherà la GUI per molto tempo, quindi in generale è sicuro usare direttamente il programma di disinstallazione, come mostrato sopra.