Std AddonMgr/fr: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Created page with "Veuillez noter que les addons marqués par {{emphasis|Python 2 uniquement}} ne fonctionneront pas dans FreeCAD version 0.19 ou supérieure.")
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

<div class="mw-translate-fuzzy">
{{Docnav/fr
|[[Std_DlgCustomize/fr|Personnalisation]]
|
|[[Std_Tools_Menu/fr|Menu Outils]]
|IconL=Std_DlgCustomize.svg
|IconR=
|IconC=Freecad.svg
}}

{{GuiCommand/fr
{{GuiCommand/fr
|Name=Std AddonMgr
|Name=Std AddonMgr
|Name/fr=Std Gestionnaire d'extensions
|Name/fr=Std Gestionnaire d'Addon
|MenuLocation=Outils → Gestionnaire d'Addon
|Icon=AddonManager.svg
|Workbenches=Tous
|MenuLocation={{StdMenu|[[Std Tools Menu/fr|Outils]]}} → Gestionnaire d'Addon
|Workbenches=''Aucun''
|SeeAlso=[[Macros/fr|Macros]], [[External workbenches/fr|Ateliers externes]]
|Version=0.17
|Version=0.17
|SeeAlso=[[External workbenches/fr|Ateliers externes]], [[Macros/fr|Macros]]
}}
}}
</div>


== Introduction ==
==Description==


Le gestionnaire d'extensions '''Addon manager''' est un outil permettant d'installer et de gérer des [[external workbenches/fr|ateliers complémentaires]] et des [[macros/fr|macros]] fournis par la communauté FreeCAD. Si le paquet [https://github.com/gitpython-developers/GitPython git-python] est installé sur votre ordinateur, le Addon manager l'utilisera pour mettre à jour les ateliers installés, accélérant les téléchargements.
La commande '''Gestionnaire d'Addon''' ouvre le gestionnaire de modules complémentaires. Avec l'Addon Manager, vous pouvez installer et gérer [[external workbenches/fr|ateliers complémentaires]] et des [[macros/fr|macros]] fournis par la communauté FreeCAD. Les ateliers et les macros disponibles proviennent de deux dépôts [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] et [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros] et à partir de la page [[Macros_recipes/fr|Liste des macros]].


Veuillez noter que les addons marqués par {{emphasis|Python 2 uniquement}} ne fonctionneront pas dans FreeCAD version 0.19 ou supérieure.
La liste des ateliers et macros à installer est tirée de deux dépôts, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] et [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros], respectivement, depuis la page [[Macros recipes/fr|recettes macros]].


[[Image:Addon_Manager_example.png]]
[[Image:Std_AddonMgr_dialog.png]]
{{Caption|L'interface de [[AddonManager/fr|Addon Manager]]}}
{{Caption|Boîte de dialogue du Gestionnaire de modules complémentaires ou Addon Manager}}


== Utilisation ==
==Utilisation==


* Ouvrez l'outil via le menu {{MenuCommand|{{StdMenu/fr|Outils}} → Gestionnaire d'Addon}}.
# Sélectionnez l'option {{MenuCommand|Outils → [[Image:Std_AddonMgr.svg|16px]] Gestionnaire d'Addon }} dans le menu.
# Si vous utilisez le gestionnaire d'extensions pour la première fois, une boîte de dialogue s'ouvrira pour vous avertir que les extensions du gestionnaire d'extensions ne font pas officiellement partie de FreeCAD. Appuyez sur le bouton {{Button|OK}} pour confirmer et continuer.
* Pour installer un atelier : faites défiler la liste et sélectionnez l'atelier complémentaire ; une courte description ainsi que sa page d'accueil sera affichée sous la liste. Appuyez sur le bouton {{Button|Install/update}} pour installer l'atelier. Pour installer une macro, cliquez sur l'onglet {{MenuCommand|Macros}} et répétez les étapes ci-dessus.
# La boîte de dialogue Gestionnaire de modules complémentaires s'ouvre. Pour plus d'informations, voir [[#Options|Options]].
* Pour supprimer un atelier ou une macro : faites défiler la liste, sélectionnez le greffon puis appuyez sur le bouton {{Button|Remove}}.
# Le bouton {{Button|[[Image:Button_valid.svg|16px]] Tout mettre à jour}} ne fonctionne pas pour le moment.
* Pour mettre à jour un atelier ou une macro : faites défiler la liste, sélectionnez le greffon puis appuyez sur le bouton {{Button|Install/update}}.
# Appuyez sur le bouton {{Button|[[Image:Process-stop.svg|16px]] Fermer}} pour fermer la boîte de dialogue.
* Pour vérifier les mises à jour : appuyez sur le bouton {{Button|[[File:Std Refresh.svg|16px]] Refresh}}; les mises à jour disponibles seront signalées sous la liste. Appuyez à nouveau sur le bouton {{Button|[[File:Std Refresh.svg|16px]] Refresh}} pour installer toutes les mises à jour en même temps.
# Si vous avez installé ou mis à jour un plan de travail, une nouvelle boîte de dialogue s'ouvre vous informant que vous devez redémarrer FreeCAD pour que les modifications prennent effet.
{{Emphasis|Remarque}} l'icône pourrait être différente en fonction de votre système d'exploitation.
* Pour exécuter une macro : installez d'abord la macro désirée, puis sélectionnez-la à nouveau dans la liste, et appuyez sur le bouton {{Button|Execute}}. La macro est automatiquement éditée dans l'éditeur de macros de FreeCAD, pour visualise le code.
* Appuyez sur le bouton {{Button|Close}} pour fermer le gestionnaire d'Addon.
Vous devrez redémarrer FreeCAD avant que de nouveaux ateliers apparaissent dans la liste des ateliers disponibles. Ils sont ajoutés à la fin. Si vous souhaitez les avoir dans l’ordre alphabétique, vous pouvez les réorganiser dans la boîte de dialogue [[Image:Std_DlgCustomize.svg|16px]] [[Std DlgCustomize/fr|Std Personnalisation]].


==Options==
=== Installation manuelle ===
Si vous n'utilisez pas l'Addon Manager, vous pouvez installer manuellement de nouveaux outils en plaçant leur code dans le répertoire {{incode|FreeCAD/}} de votre dossier personnel. Voir les liens suivants pour plus de détails:
* [[How to install macros/fr|Comment installer des macros]]
* [[How to install additional workbenches/fr|Comment installer des ateliers supplémentaires]]


La boîte de dialogue Gestionnaire de modules complémentaires comporte deux onglets à gauche, l'un répertoriant les ateliers disponibles et l'autre répertoriant les macros disponibles. Le panneau d'information sur la droite affichera la page d'accueil de l'addon sélectionné.
== Limitations ==


=== Désinstaller ===
* Ces modules complémentaires ne font pas partie du logiciel FreeCAD officiel et ne sont pas pris en charge par l'équipe FreeCAD. Vous devez lire les informations fournies sur chacune des pages complémentaires avant d'en installer une pour vous assurer de savoir ce que vous installez.


# Sélectionnez un module complémentaire installé dans l'onglet [[Image:Folder.svg|16px]] '''Ateliers''' ou dans l'onglet [[Image:Applications-python.svg|16px]] '''Macros'''.
* Les rapports de bogues et les demandes de fonctionnalités doivent être adressés directement au créateur de l'add-on en visitant le site Web indiqué. De nombreux auteurs de modules complémentaires sont des utilisateurs réguliers du [https://forum.freecadweb.org forum FreeCAD] et peuvent être contactés à cet emplacement.
# Appuyez sur le bouton {{Button|[[Image:Delete.svg|16px]] Désinstaller la sélection}}.


=== Installer/mettre à jour ===
* Les adresses web des dépôts des extensions et macros sont codées en dur dans l'Addon manager. Comme il est écrit en Python, celles-ci pourraient être modifiés par les utilisateurs connaissant Python en éditant les champs appropriés dans


# Sélectionnez un module complémentaire dans l'onglet [[Image:Folder.svg|16px]] '''Ateliers''' ou dans l'onglet [[Image:Applications-python.svg|16px]] '''Macros'''.
:{{Code|code=
# Appuyez sur le bouton {{Button|[[Image:Edit_OK.svg|16px]] Installer/mettre à jour la sélection}}.
$ROOT/Mod/AddonManager/AddonManager.py
# Si vous souhaitez ajouter une macro à une barre d'outils personnalisée, n'oubliez pas de télécharger manuellement le fichier image d'icône, si disponible, en cliquant sur le lien sur la page d'accueil dans le panneau d'informations. Voir [[Interface_Customization/fr#Barre_d.27outils|Personnalisation de l'interface]].
}}
# Pour modifier la position d'un atelier complémentaire dans la liste des [[Std_Workbench/fr|Ateliers]], voir [[Interface_Customization/fr#Ateliers|Personnalisation de l'interface]].


=== Configuration ===
: où {{incode|$ROOT}} est le répertoire d'installation de FreeCAD dans votre système particulier, par exemple,
:* Linux: {{incode|/usr/lib/freecad/Mod/AddonManager/AddonManager.py}}
:* Windows: {{Incode|C:\Program Files\FreeCAD version\Mod\AddonManager.py}}


# Appuyez sur le bouton {{Button|[[Image:Preferences-general.svg|16px]] Configurer...}}.
== Nouveaux ateliers et macros ==
# La boîte de dialogue des options du gestionnaire d'extensions s'ouvre.
# Cochez éventuellement la case {{CheckBox|TRUE|Rechercher automatiquement les mises à jour au démarrage (nécessite GitPython)}}.
# Ajoutez éventuellement des dépôts à la liste '''Dépôts personnalisés'''. Les modules complémentaires de ces référentiels seront ajoutés sur l'onglet [[Image:Folder.svg|16px]] '''Ateliers''' ou l'onglet [[Image:Applications-python.svg|16px]] '''Macros'''.
# Choisissez éventuellement les paramètres du proxy.
# Appuyez sur le bouton {{Button|OK}} ou sur le {{Button|Annuler}} pour fermer la boîte de dialogue.


==Remarques==
Si vous avez développé un atelier ou une macro et souhaitez l'inclure dans le gestionnaire des extensions, lisez la procédure à suivre dans les pages des dépôts ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] et [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]). Si vous ajoutez votre macro aux [[Macros recipes/fr|Recettes macros]], il n'y a rien d'autre à faire, elle sera automatiquement sélectionnée par le gestionnaire Addon Manager.


* Les modules complémentaires disponibles dans le gestionnaire de modules complémentaires ne font pas partie du programme officiel FreeCAD et ne sont pas pris en charge par l'équipe de développement principale de FreeCAD. Vous devez lire attentivement les informations fournies pour vous assurer que vous savez ce que vous installez.
Pour les ateliers Python, vous n'avez besoin d'aucune approbation spécifique pour ajouter votre atelier au Addon manager et, étant en dehors du code source de FreeCAD, vous pouvez choisir la licence de votre choix. Si vous demandez l’ajout de votre atelier dans la liste (nous n’ajouterons aucun nouveau atelier sans une demande de ses auteurs), soit en le demandant sur le forum, soit en créant une requête ("issue" en anglais) sur le site [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons], votre code restera sur votre propre dépôt git, nous l'ajouterons simplement en tant que sous-module au dépôt [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons]. Bien sûr, avant d'ajouter votre atelier, nous allons l'examiner et nous assurer qu'il ne pose aucun problème potentiel.
* Les rapports de bogues et les demandes de fonctionnalités doivent être adressés directement au créateur de l'addon en visitant le site Web indiqué. De nombreux développeurs d'extensions sont des utilisateurs réguliers du [https://forum.freecadweb.org forum de FreeCAD] et peuvent également y être contactés.
* Si le package [https://github.com/gitpython-developers/GitPython GitPython] est installé sur votre ordinateur, le gestionnaire d'extensions s'en servira, ce qui accélérera les téléchargements.
* Vous pouvez également installer des modules complémentaires manuellement. Voir [[How_to_install_additional_workbenches/fr|Comment installer des ateliers supplémentaires]] et [[How_to_install_macros/fr|Comment installer des macros]].


== Informations pour les développeurs ==
Si vous développez un atelier en C++, il ne peut pas être exécuté directement par les utilisateurs et doit d'abord être compilé. Vous avez alors 2 options, soit vous fournissez vous-même les versions pré-compilées de votre atelier pour les différents systèmes d'exploitation, soit vous devez demander à ce que votre code soit fusionné dans le code source de FreeCAD. Pour cela, vous devez utiliser la licence LGPL (ou entièrement compatible, comme MIT ou BSD), et présenter vos nouveaux outils à la communauté dans le [https://forum.freecadweb.org forum de FreeCAD] pour être examiné. Une fois que votre code a été testé et approuvé, vous devez créer une nouvelle branche dans le dépôt FreeCAD, si ce n’est pas encore fait, y insérer votre code et ouvrir une demande de retrait (pull request) afin que votre branche soit fusionnée dans le dépôt principal.


Si vous avez développé un atelier ou une macro et souhaitez l'inclure dans le gestionnaire des extensions, lisez la procédure à suivre dans les pages des dépôts ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] et [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]). Si vous ajoutez votre macro à la [[Macros_recipes/fr|Liste des macros]], il n'y a rien d'autre à faire, elle sera automatiquement sélectionnée par le gestionnaire Addon Manager.
== Test de AddonManager ==
{{VeryImportantMessage|Cette section est destinée aux développeurs}}
Le gestionnaire d’addons étant codé en Python, il est possible de modifier le code source sans le compiler. Plus spécifiquement, le test nécessite de modifier le code dans {{incode|FreeCAD/src/Mod/AddonManager}} et de simplement ré-exécuter FreeCAD.


=== Ateliers Python ===
Pour tester la capacité de téléchargement du gestionnaire d’addons, vous pouvez simuler la nécessité de télécharger, par exemple une version précédente d’un plan de travail via l’interface de ligne de commande. Dans l'exemple suivant, nous allons utiliser Assembly2 + Workbench (ou [[A2plus_Workbench|A2plus]] en abrégé):


Pour les ateliers Python, vous n'avez besoin d'aucune approbation spécifique pour ajouter votre atelier au Addon manager et, étant en dehors du code source de FreeCAD, vous pouvez choisir la licence de votre choix. Si vous demandez l’ajout de votre atelier dans la liste (nous n’ajouterons aucun nouveau atelier sans une demande de ses auteurs), soit en le demandant sur le forum, soit en créant une requête ("issue" en anglais) sur le site [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons], votre code restera sur votre propre dépôt git, nous l'ajouterons simplement en tant que sous-module au dépôt [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons]. Bien sûr, avant d'ajouter votre atelier, nous allons l'examiner et nous assurer qu'il ne pose aucun problème potentiel.
{{Code|code=
cd ~/FreeCAD/Mod/A2plus/
git reset --hard "v0.4.21"
}}


=== Ateliers C++ ===
La sortie de l'interface de ligne de commande doit indiquer '''HEAD est maintenant à b2c53a4 Demande de fusion #281 de kbwbe/devel'''


Si vous développez un atelier en C++, il ne peut pas être exécuté directement par les utilisateurs et doit d'abord être compilé. Vous avez alors deux options, soit vous fournissez vous-même les versions pré-compilées de votre atelier pour les différents systèmes d'exploitation, soit vous devez demander à ce que votre code soit fusionné dans le code source de FreeCAD. Pour cela, vous devez utiliser la licence LGPL (ou une licence entièrement compatible comme celle du MIT ou BSD) et présenter vos nouveaux outils à la communauté dans le [https://forum.freecadweb.org forum de FreeCAD] pour être examiné. Une fois que votre code a été testé et approuvé, vous devez créer une nouvelle branche dans le dépôt FreeCAD, si ce n’est pas encore fait, y insérer votre code et ouvrir une demande de retrait (pull request) afin que votre branche soit fusionnée dans le dépôt principal.
Nous avons essentiellement utilisé une balise de la version précédente pour réinitialiser cette version.
Maintenant, dans le gestionnaire d’addon, actualisez la liste des ateliers et il s'affiche que l’atelier A2plus utilise une version inférieure.


{{Docnav/fr
{{clear}}
|[[Std_DlgCustomize/fr|Personnalisation]]
|
|[[Std_Tools_Menu/fr|Menu Outils]]
|IconL=Std_DlgCustomize.svg
|IconR=
|IconC=Freecad.svg
}}


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

{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

[[Category:Addons{{#translation:}}]]

Revision as of 21:15, 3 August 2020

Std Gestionnaire d'Addon

Emplacement du menu
Outils → Gestionnaire d'Addon
Ateliers
Tous
Raccourci par défaut
Aucun
Introduit dans la version
0.17
Voir aussi
Ateliers externes, Macros

Description

La commande Gestionnaire d'Addon ouvre le gestionnaire de modules complémentaires. Avec l'Addon Manager, vous pouvez installer et gérer ateliers complémentaires et des macros fournis par la communauté FreeCAD. Les ateliers et les macros disponibles proviennent de deux dépôts FreeCAD-addons et FreeCAD-macros et à partir de la page Liste des macros.

Veuillez noter que les addons marqués par Python 2 uniquement ne fonctionneront pas dans FreeCAD version 0.19 ou supérieure.

File:Std AddonMgr dialog.png

Boîte de dialogue du Gestionnaire de modules complémentaires ou Addon Manager

Utilisation

  1. Sélectionnez l'option Outils → Gestionnaire d'Addon dans le menu.
  2. Si vous utilisez le gestionnaire d'extensions pour la première fois, une boîte de dialogue s'ouvrira pour vous avertir que les extensions du gestionnaire d'extensions ne font pas officiellement partie de FreeCAD. Appuyez sur le bouton OK pour confirmer et continuer.
  3. La boîte de dialogue Gestionnaire de modules complémentaires s'ouvre. Pour plus d'informations, voir Options.
  4. Le bouton Tout mettre à jour ne fonctionne pas pour le moment.
  5. Appuyez sur le bouton Fermer pour fermer la boîte de dialogue.
  6. Si vous avez installé ou mis à jour un plan de travail, une nouvelle boîte de dialogue s'ouvre vous informant que vous devez redémarrer FreeCAD pour que les modifications prennent effet.

Options

La boîte de dialogue Gestionnaire de modules complémentaires comporte deux onglets à gauche, l'un répertoriant les ateliers disponibles et l'autre répertoriant les macros disponibles. Le panneau d'information sur la droite affichera la page d'accueil de l'addon sélectionné.

Désinstaller

  1. Sélectionnez un module complémentaire installé dans l'onglet Ateliers ou dans l'onglet Macros.
  2. Appuyez sur le bouton Désinstaller la sélection.

Installer/mettre à jour

  1. Sélectionnez un module complémentaire dans l'onglet Ateliers ou dans l'onglet Macros.
  2. Appuyez sur le bouton Installer/mettre à jour la sélection.
  3. Si vous souhaitez ajouter une macro à une barre d'outils personnalisée, n'oubliez pas de télécharger manuellement le fichier image d'icône, si disponible, en cliquant sur le lien sur la page d'accueil dans le panneau d'informations. Voir Personnalisation de l'interface.
  4. Pour modifier la position d'un atelier complémentaire dans la liste des Ateliers, voir Personnalisation de l'interface.

Configuration

  1. Appuyez sur le bouton Configurer....
  2. La boîte de dialogue des options du gestionnaire d'extensions s'ouvre.
  3. Cochez éventuellement la case Rechercher automatiquement les mises à jour au démarrage (nécessite GitPython).
  4. Ajoutez éventuellement des dépôts à la liste Dépôts personnalisés. Les modules complémentaires de ces référentiels seront ajoutés sur l'onglet Ateliers ou l'onglet Macros.
  5. Choisissez éventuellement les paramètres du proxy.
  6. Appuyez sur le bouton OK ou sur le Annuler pour fermer la boîte de dialogue.

Remarques

  • Les modules complémentaires disponibles dans le gestionnaire de modules complémentaires ne font pas partie du programme officiel FreeCAD et ne sont pas pris en charge par l'équipe de développement principale de FreeCAD. Vous devez lire attentivement les informations fournies pour vous assurer que vous savez ce que vous installez.
  • Les rapports de bogues et les demandes de fonctionnalités doivent être adressés directement au créateur de l'addon en visitant le site Web indiqué. De nombreux développeurs d'extensions sont des utilisateurs réguliers du forum de FreeCAD et peuvent également y être contactés.
  • Si le package GitPython est installé sur votre ordinateur, le gestionnaire d'extensions s'en servira, ce qui accélérera les téléchargements.
  • Vous pouvez également installer des modules complémentaires manuellement. Voir Comment installer des ateliers supplémentaires et Comment installer des macros.

Informations pour les développeurs

Si vous avez développé un atelier ou une macro et souhaitez l'inclure dans le gestionnaire des extensions, lisez la procédure à suivre dans les pages des dépôts (FreeCAD-addons et FreeCAD-macros). Si vous ajoutez votre macro à la Liste des macros, il n'y a rien d'autre à faire, elle sera automatiquement sélectionnée par le gestionnaire Addon Manager.

Ateliers Python

Pour les ateliers Python, vous n'avez besoin d'aucune approbation spécifique pour ajouter votre atelier au Addon manager et, étant en dehors du code source de FreeCAD, vous pouvez choisir la licence de votre choix. Si vous demandez l’ajout de votre atelier dans la liste (nous n’ajouterons aucun nouveau atelier sans une demande de ses auteurs), soit en le demandant sur le forum, soit en créant une requête ("issue" en anglais) sur le site FreeCAD-addons, votre code restera sur votre propre dépôt git, nous l'ajouterons simplement en tant que sous-module au dépôt FreeCAD-addons. Bien sûr, avant d'ajouter votre atelier, nous allons l'examiner et nous assurer qu'il ne pose aucun problème potentiel.

Ateliers C++

Si vous développez un atelier en C++, il ne peut pas être exécuté directement par les utilisateurs et doit d'abord être compilé. Vous avez alors deux options, soit vous fournissez vous-même les versions pré-compilées de votre atelier pour les différents systèmes d'exploitation, soit vous devez demander à ce que votre code soit fusionné dans le code source de FreeCAD. Pour cela, vous devez utiliser la licence LGPL (ou une licence entièrement compatible comme celle du MIT ou BSD) et présenter vos nouveaux outils à la communauté dans le forum de FreeCAD pour être examiné. Une fois que votre code a été testé et approuvé, vous devez créer une nouvelle branche dans le dépôt FreeCAD, si ce n’est pas encore fait, y insérer votre code et ouvrir une demande de retrait (pull request) afin que votre branche soit fusionnée dans le dépôt principal.