[ + ] Bullet Designer

[Supermagnum]

Addon Submission Checklist - Bullet Designer

Dependencies

This Addon/workbench runs on:

• Most up to date stable release (FreeCAD 0.21+)
• Most up to date development release
• Python 3 compatible (Python 3.8+)
• Qt5 compatible (uses PySide2)
• Qt5 and Qt6 compatible (uses "import PySide" rather than "import PySide2")

Note: Uses PySide2 (Qt5), not PySide (Qt6). PySide2 is included with FreeCAD.

Backward Compatibility

• Is this backward compatible with any previous version of FC?
  • No, requires FreeCAD 0.21 or later. Mentioned in README.md Prerequisites section.

Third Party Dependencies

• Does this use 3rd party dependencies?
  • numpy - No
  • scipy - No
  • Other dependencies: None. Uses only Python standard library (math, bisect, os, sys). PySide2 is included with FreeCAD.

README.md

• Is Markdown friendly
• Has a Prerequisites or Dependencies section (added as "Prerequisites / Dependencies")
• Links to a LICENSE file (links to LICENSE file)
• Has a Screenshot and/or a section for screenshots (has Screenshots section with images)
• Links to a FreeCAD Forum discussion thread (placeholder added with instructions)

Misc.

• Do you keep a changelog?
  • Location: CHANGELOG.md (follows Keep a Changelog format)
• Your Addon has an SVG based Logo?
  • Location: Resources/icons/BDLogo.svg BulletDesigner.svg
• Your Addon has a package.xml file?
  • Location: package.xml (comprehensive metadata with 40+ tags)
• Edit the FreeCAD External Workbenches wiki page
  • Status: Needs to be done manually on FreeCAD wiki at https://www.freecadweb.org/wiki/External_workbenches

Housekeeping

• Fixed typos in the code using codespell
  • Statusyes
• We recommend linting python code with PEP8
  • Status: code is linted with PEP8. Code follows FreeCAD conventions. See: https://github.com/FreeCAD/FreeCAD/blob/master/src/Mod/Fem/coding_conventions.md#python-and-c

Github Related

• Does your repository use Release tags?
  • Status: yes
• Repository has topics which include FreeCAD Workbench Addon
  • Status: Needs to be added manually on GitHub repository settings
  • Recommended topics: FreeCAD, Workbench, Addon, bullet, ballistics, CAD, parametric-design

Summary

Completed

• README.md updated with Prerequisites/Dependencies section
• LICENSE file linked in README.md
• Screenshots section present
• CHANGELOG.md created (Keep a Changelog format)
• SVG logo exists (BulletDesigner.svg)
• package.xml exists with comprehensive metadata
• Markdown friendly formatting
• No third-party dependencies (uses only Python stdlib)

Pending Actions (Manual)

1. Create FreeCAD Forum discussion thread and update README.md link
2. Add GitHub repository topics: FreeCAD, Workbench, Addon, plus relevant keywords
3. Create release tag: git tag -a v1.0.0 -m "Initial release" and push: git push origin v1.0.0
4. Edit FreeCAD External Workbenches wiki page
5. Run codespell for typo checking: codespell -q 3
6. Review code for PEP8 compliance

Repository Information

• URL:https://github.com/Supermagnum/BulletDesigner
• Addon Location: BulletDesigner
• License: MIT License
• FreeCAD Version: 0.21+
• Python Version: 3.8+
• Qt Version: Qt5 (PySide2)

https://github.com/Supermagnum/BulletDesigner

[PhoneDroid]

@Supermagnum Please ping me on my email at
PhoneDroid.FGL@proton.me so we can start the review.

[Supermagnum]

@Supermagnum Please ping me on my email at PhoneDroid.FGL@proton.me so we can start the review.

Done.

[chennes]

@Supermagnum -- I'm not sure where you and PhoneDroid left this, are we still trying to get this addon added to the Index?

[Supermagnum]

Its handed off from my side.

[chennes]

So should this be closed then? I don't know what you mean by "handed off".

[Supermagnum]

Its ready to be added to the index.

[chennes]

Thanks -- I've moved the issue over to the new repo now. A few issues:

• You've left the placeholder email address for the maintainer -- please update that to a real address so we can contact you if needed.
• You've used the older Addon layout, which in your case is highly likely to cause conflicts since your top-level folders are called Commands, Gui, Objects, and Utils. You also use sys.path.insert on a couple of occasions, which will also leak your files into the FreeCAD global namespace.
• You have two tags in your package.xml file that are invalid: freecaddependency should be freecadmin and pythonminversion should just be pythonmin.
• Your package.xml license entry should link to the license file: <license file="LICENSE">MIT</license>
• examples/ is 2.4MB -- make sure you really want to ship that to every single user.
• The latest release of FreeCAD (v 1.1) is compiled against Qt6 in most cases, so this addon is not compatible with it. Instead, use the PySide wrapper provided by FreeCAD to provide backwards- and forwards- compatibility between different versions of PySide.

[Supermagnum]

I will fix that ASAP.

[Supermagnum]

It is now done,- note that its AI assisted code and that I might not be able to do code changes in the future.

[chennes]

That's probably worth a prominent notice at the top of your README -- we don't want users to get the impression that this is going to be maintained for the long-term if you don't plan to do so. Also, you didn't quite get the directory structure right -- see https://freecad.github.io/Addon-Academy/Topics/Structuring/