FreeCAD-macros icon indicating copy to clipboard operation
FreeCAD-macros copied to clipboard

Tracking: Py3/Qt5 + Uniformity

Open luzpaz opened this issue 7 years ago • 4 comments

Reasons:

  • we can run unit tests on them to see if they work
  • they are readable and users can study them
  • inspect/test them for vulnerabilities
  • remove typos
  • have the ability to eventually run them in console mode only (depending on the viability of this)
  • easy to understand attribution to the author(s)
  • clear posting of what the licence is

Macros missing info

Macro Name License Metadata Py3 Qt5
CartoucheFC.py :-1: :-1:
ViewRotation.FCMacro :+1: :+1:
FCRotateViewAbsolute.FCMacro :-1: :-1:
Foto.FCMacro :-1: :-1:
GenevaWheelGUI.py :-1: :-1:
ScrewMaker.FCMacro :-1: :-1:
SolidSweep.FCMacro :-1: :-1:
apothemBasedPrism.py :-1: :-1:
makecamera2dview.py :-1: :-1:
unfoldBox.py :-1: :-1:
unrollRuledSurface.py :-1: :-1:
ForceRecompute.FCMacro :-1: :-1:
HighlightCommon.FCMacro :+1: :+1: :+1: :+1:
HighlightDifference.FCMacro :+1: :+1: :+1: :+1:
MeasureCircle.FCMacro :+1: :+1:
MessageBox.FCMacro :-1: :-1:
SelectVisible.FCMacro :-1: :-1:
Rectellipse.FCMacro :-1: :-1:
Airfoil_Import_and_Scale.FCMacro :-1: :-1:
Draft_Circle_3_Points.FCMacro :-1: :-1:
Draft_Circle_3_Points_improved.FCMacro :-1: :-1:
Ellipse-Center :-1: :-1:
GeodesicDome.FCMacro :-1: :-1:
HalfHull.FCMacro :-1: :-1:
HyperbolaCreater.FCMacro :-1: :-1:
Macro_FCCircularText.FCMacro :-1: :+1:
MakeCircle3Points.FCMacro :-1: :-1:
ParabolaCreater.FCMacro :-1: :-1:
ExportFem.FCMacro :-1: :-1:

luzpaz avatar Jan 05 '18 13:01 luzpaz

Macros already are supposed to have a uniform structure, cf. for example https://github.com/FreeCAD/FreeCAD-macros/blob/9916141e75c5e7463305b0481f0a5939a5cdafbb/ObjectCreation/Macro_FCCircularText.FCMacro#L56-L69. I agree with you that the license information is missing.

Can you please provide an example of how a uniform structure could be used in unit-tests? It sounds interesting.

I don't understand however how a uniform structure could help with typos.

galou avatar Jan 05 '18 14:01 galou

@galou not all of them have all this info. I'll format my idea in regards what else I had in mind

luzpaz avatar Jan 05 '18 18:01 luzpaz

related: #9

luzpaz avatar Jan 23 '18 18:01 luzpaz

Add info from https://forum.freecadweb.org/viewtopic.php?f=22&t=30636

luzpaz avatar Jan 17 '19 21:01 luzpaz