Std Gestionnaire des extensions

From FreeCAD Documentation
Revision as of 19:50, 20 June 2019 by Gnrc (talk | contribs) (Created page with "{{Userdocnavi/fr}}")

Gestionnaire d'extensions

Emplacement du menu
Outils → Addon manager
Ateliers
N/A
Raccourci par défaut
Aucun
Introduit dans la version
0.17
Voir aussi
macros, ateliers externes

Le gestionnaire d'extensions Addon manager est un outil permettant d'installer et de gérer des ateliers complémentaires et des macros fournis par la communauté FreeCAD. Si le paquet 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 liste des ateliers et macros à installer est tirée de deux dépôts, FreeCAD-addons et FreeCAD-macros, respectivement, depuis la page recettes macros.

L'interface de Addon Manager

Utilisation

  • Ouvrez l'outil via le menu Outils → Addon manager.
  • 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 Install / update pour installer l'atelier. Pour installer une macro, cliquez sur l'onglet Macros et répétez les étapes ci-dessus.
  • Pour supprimer un atelier ou une macro : faites défiler la liste, sélectionnez le greffon puis appuyez sur le bouton Remove.
  • Pour mettre à jour un atelier ou une macro : faites défiler la liste, sélectionnez le greffon puis appuyez sur le bouton Install / update.
  • Pour vérifier les mises à jour : appuyez sur le bouton Refresh; les mises à jour disponibles seront signalées sous la liste. Appuyez à nouveau sur le bouton Refresh pour installer toutes les mises à jour en même temps.

N.B. 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 Execute. La macro est automatiquement éditée dans l'éditeur de macros de FraaCAD, pour visualise le code.
  • Appuyez sur le bouton Close pour fermer l'Addon Manager.

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 FreeCAD/ de votre dossier personnel. Voir les liens suivants pour plus de détails:

Limitations

  • 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.
  • 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 forum FreeCAD et peuvent être contactés à cet emplacement.
  • 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
$ROOT/Mod/AddonManager/AddonManager.py

$ROOT est le répertoire d'installation de FreeCAD dans votre système particulier, par exemple,

  • Linux: /usr/lib/freecad/Mod/AddonManager/AddonManager.py
  • Windows: C:\Program Files\FreeCAD version\Mod\AddonManager.py

Nouveaux ateliers et macros

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 aux Recettes macros, il n'y a rien d'autre à faire, elle sera automatiquement sélectionnée par le gestionnaire Addon Manager.

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.

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

Test de AddonManager

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 FreeCAD/src/Mod/AddonManager</ tt> et de simplement réexécuter FreeCAD.

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 en abrégé):

cd ~/FreeCAD/Mod/A2plus/
git reset --hard "v0.4.21"

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

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.