Upgrade workbench to 'new style' (Closes #95)

gbroques · Jun 10, 2020 · 2062240 · 2062240
1 parent b51a243
commit 2062240
Show file tree

Hide file tree

Showing 161 changed files with 395 additions and 688 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -16,7 +16,7 @@ install:
       --volume $(pwd):/var/app
       ose-workbench-platform
 script:
-    - docker exec -it ose3dprinter pytest --cov ose3dprinter/app test/
+    - docker exec -it ose3dprinter pytest --cov ose3dprinter test/
 after_success:
     - >
       docker exec

diff --git a/InitGui.py b/InitGui.py
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+recursive-include freecad/ose3dprinter/gui/icons *
diff --git a/README.md b/README.md
@@ -14,17 +14,17 @@ A FreeCAD workbench for designing 3D printers by [Open Source Ecology](https://w
 * [Supported FreeCAD Versions](#supported-freecad-versions)
 
 ## Main Toolbar
-* [<img alt="Add Frame" src="ose3dprinter/gui/icon/Frame.svg" width="32" height="32" /> Add Frame](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_frame.html)
-* [<img alt="Add X Axis" src="ose3dprinter/gui/icon/XAxis.svg" width="32" height="32" /> Add X Axis](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_axis.html)
-* [<img alt="Add Y Axis" src="ose3dprinter/gui/icon/YAxis.svg" width="32" height="32" /> Add Y Axis](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_axis.html)
-* [<img alt="Add Z Axis" src="ose3dprinter/gui/icon/ZAxis.svg" width="32" height="32" /> Add Z Axis](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_axis.html)
-* [<img alt="Add Heated Bed" src="ose3dprinter/gui/icon/HeatedBed.svg" width="32" height="32" /> Add Heated Bed](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_heated_bed.html)
-* [<img alt="Add Extruder" src="ose3dprinter/gui/icon/Extruder.svg" width="32" height="32" /> Add Extruder](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_extruder.html)
+* [<img alt="Add Frame" src="freecad/ose3dprinter/icon/Frame.svg" width="32" height="32" /> Add Frame](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_frame.html)
+* [<img alt="Add X Axis" src="freecad/ose3dprinter/icon/XAxis.svg" width="32" height="32" /> Add X Axis](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_axis.html)
+* [<img alt="Add Y Axis" src="freecad/ose3dprinter/icon/YAxis.svg" width="32" height="32" /> Add Y Axis](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_axis.html)
+* [<img alt="Add Z Axis" src="freecad/ose3dprinter/icon/ZAxis.svg" width="32" height="32" /> Add Z Axis](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_axis.html)
+* [<img alt="Add Heated Bed" src="freecad/ose3dprinter/icon/HeatedBed.svg" width="32" height="32" /> Add Heated Bed](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_heated_bed.html)
+* [<img alt="Add Extruder" src="freecad/ose3dprinter/icon/Extruder.svg" width="32" height="32" /> Add Extruder](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/add_extruder.html)
 
 ## Main Menu
-* [<img alt="Copy Rod Cut List to Clipboard" src="ose3dprinter/gui/icon/edit-copy.svg" width="32" height="32" /> Copy Rod Cut List to Clipboard](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/generate_cut_list.html)
-* [<img alt="Save Rod Cut List as CSV" src="ose3dprinter/gui/icon/document-save-as.svg" width="32" height="32" /> Save Rod Cut List as CSV](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/generate_cut_list.html)
-* [<img alt="Make Angle Frame Connector" src="ose3dprinter/gui/icon/Std_CoordinateSystem.svg" width="32" height="32" /> Make Angle Frame Connector](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/make_angle_frame_connector.html)
+* [<img alt="Copy Rod Cut List to Clipboard" src="freecad/ose3dprinter/icon/edit-copy.svg" width="32" height="32" /> Copy Rod Cut List to Clipboard](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/generate_cut_list.html)
+* [<img alt="Save Rod Cut List as CSV" src="freecad/ose3dprinter/icon/document-save-as.svg" width="32" height="32" /> Save Rod Cut List as CSV](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/generate_cut_list.html)
+* [<img alt="Make Angle Frame Connector" src="freecad/ose3dprinter/icon/Std_CoordinateSystem.svg" width="32" height="32" /> Make Angle Frame Connector](https://ose-3d-printer-workbench.readthedocs.io/en/latest/pages/make_angle_frame_connector.html)
 
 ## Installation
 1. Identify where you need to manually download and install the workbench.

diff --git a/docs/index.rst b/docs/index.rst
@@ -7,7 +7,7 @@
 |Frame Icon| OSE 3D Printer Workbench Documentation
 ===================================================
 
-.. |Frame Icon| image:: /../ose3dprinter/gui/icon/Frame.svg
+.. |Frame Icon| image:: /../freecad/ose3dprinter/icon/Frame.svg
    :height: 32px
    :width: 32px
    :alt: Workbench Icon
@@ -42,7 +42,7 @@ For more information on codebase conventions and patterns, see the `OSE Workbenc
 
 .. toctree::
    :maxdepth: 2
-   :caption: Base Package
+   :caption: OSE 3D Printer Package
 
    ose3dprinter/ose3dprinter
 

diff --git a/docs/ose3dprinter/ose3dprinter.app.attachment.get_axis_frame_attachment_kwargs.rst b/docs/ose3dprinter/ose3dprinter.app.attachment.get_axis_frame_attachment_kwargs.rst
diff --git a/...se3dprinter/ose3dprinter.app.attachment.get_extruder_axis_attachment_kwargs.rst b/...se3dprinter/ose3dprinter.app.attachment.get_extruder_axis_attachment_kwargs.rst
diff --git a/...ter/ose3dprinter.app.attachment.get_heated_bed_frame_axis_attachment_kwargs.rst b/...ter/ose3dprinter.app.attachment.get_heated_bed_frame_axis_attachment_kwargs.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.attachment.rst b/docs/ose3dprinter/ose3dprinter.app.attachment.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.model.axis.rst b/docs/ose3dprinter/ose3dprinter.app.model.axis.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.model.extruder.rst b/docs/ose3dprinter/ose3dprinter.app.model.extruder.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.model.frame.get_faces_for_side.rst b/docs/ose3dprinter/ose3dprinter.app.model.frame.get_faces_for_side.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.model.frame.rst b/docs/ose3dprinter/ose3dprinter.app.model.frame.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.model.heated_bed.rst b/docs/ose3dprinter/ose3dprinter.app.model.heated_bed.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.model.rst b/docs/ose3dprinter/ose3dprinter.app.model.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.part.axis.rst b/docs/ose3dprinter/ose3dprinter.app.part.axis.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.part.heated_bed.rst b/docs/ose3dprinter/ose3dprinter.app.part.heated_bed.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.part.rst b/docs/ose3dprinter/ose3dprinter.app.part.rst
diff --git a/docs/ose3dprinter/ose3dprinter.app.rst b/docs/ose3dprinter/ose3dprinter.app.rst
diff --git a/docs/ose3dprinter/ose3dprinter.attachment.get_axis_frame_attachment_kwargs.rst b/docs/ose3dprinter/ose3dprinter.attachment.get_axis_frame_attachment_kwargs.rst
@@ -0,0 +1,32 @@
+
+ose3dprinter.attachment.get_axis_frame_attachment_kwargs
+========================================================
+.. automodule:: ose3dprinter.attachment.get_axis_frame_attachment_kwargs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+get_axis_frame_attachment_kwargs
+--------------------------------
+.. automodule:: ose3dprinter.attachment.get_axis_frame_attachment_kwargs.get_axis_frame_attachment_kwargs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+get_default_axis_creation_kwargs
+--------------------------------
+.. automodule:: ose3dprinter.attachment.get_axis_frame_attachment_kwargs.get_default_axis_creation_kwargs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+get_placement_strategy
+----------------------
+.. automodule:: ose3dprinter.attachment.get_axis_frame_attachment_kwargs.get_placement_strategy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/ose3dprinter/ose3dprinter.attachment.get_extruder_axis_attachment_kwargs.rst b/docs/ose3dprinter/ose3dprinter.attachment.get_extruder_axis_attachment_kwargs.rst
@@ -0,0 +1,16 @@
+
+ose3dprinter.attachment.get_extruder_axis_attachment_kwargs
+===========================================================
+.. automodule:: ose3dprinter.attachment.get_extruder_axis_attachment_kwargs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+get_extruder_axis_attachment_kwargs
+-----------------------------------
+.. automodule:: ose3dprinter.attachment.get_extruder_axis_attachment_kwargs.get_extruder_axis_attachment_kwargs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+