Prepare project for pip packaging (#45)

 - use relative imports
 - use pkg_ressource for paths
 - move tests inside package
 - update setup.py
 - bump version

.github/workflows/integration-tests.yml

@@ -39,4 +39,4 @@ jobs:
 
     - name: Test with pytest
       run: |
-        python -m pytest tests/integration/
+        python -m pytest labelCloud/tests/integration/

.github/workflows/unit-tests.yml

@@ -37,4 +37,4 @@ jobs:
 
     - name: Test with pytest
       run: |
-        python -m pytest tests/unit/
+        python -m pytest labelCloud/tests/unit/

.gitignore

@@ -177,3 +177,4 @@ cython_debug/
 !.vscode/*.code-snippets
 
 # End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,python
+.vscode/launch.json

labelCloud.py

@@ -1,8 +1,5 @@
-if __name__ == "__main__":
-
-    import sys
+from labelCloud.__main__ import main
 
-    sys.path.insert(0, "labelCloud")
-    from labelCloud import app
+if __name__ == "__main__":
 
-    app.run()
+    main()

labelCloud/__init__.py

@@ -1 +1 @@
-__version__ = "0.5.0"
+__version__ = "0.6.1"

labelCloud/__main__.py

@@ -1,8 +1,34 @@
 import sys
 
-sys.path.insert(0, "labelCloud")
+from PyQt5.QtWidgets import QApplication, QDesktopWidget
 
-if __name__ == "__main__":
-    import app
 
-    app.run()
+from labelCloud.view.gui import GUI
+from labelCloud.control.controller import Controller
+
+
+def main():
+    app = QApplication(sys.argv)
+
+    # Setup Model-View-Control structure
+    control = Controller()
+    view = GUI(control)
+
+    # Install event filter to catch user interventions
+    app.installEventFilter(view)
+
+    # Start GUI
+    view.show()
+
+    app.setStyle("Fusion")
+    desktop = QDesktopWidget().availableGeometry()
+    width = (desktop.width() - view.width()) / 2
+    height = (desktop.height() - view.height()) / 2
+    view.move(width, height)
+
+    print("Showing GUI...")
+    sys.exit(app.exec_())
+
+
+if __name__ == "__main__":
+    main()

labelCloud/control/alignmode.py

@@ -6,12 +6,12 @@
 from typing import TYPE_CHECKING, Union
 
 import numpy as np
-import utils.oglhelper as ogl
 
+from ..utils import oglhelper as ogl
 from .pcd_manager import PointCloudManger
 
 if TYPE_CHECKING:
-    from view.gui import GUI
+    from ..view.gui import GUI
 
 
 class AlignMode(object):

labelCloud/control/bbox_controller.py

@@ -4,16 +4,16 @@
 Bounding Box Management: adding, selecting updating, deleting bboxes;
 Possible Active Bounding Box Manipulations: rotation, translation, scaling
 """
-from typing import TYPE_CHECKING, List, Optional, Union
+from typing import TYPE_CHECKING, List, Optional
 
 import numpy as np
-from model.bbox import BBox
-from utils import oglhelper
 
+from ..model.bbox import BBox
+from ..utils import oglhelper
 from .config_manager import config
 
 if TYPE_CHECKING:
-    from view.gui import GUI
+    from ..view.gui import GUI
 
 
 # DECORATORS

labelCloud/control/config_manager.py

@@ -3,6 +3,8 @@
 import os
 from typing import List
 
+import pkg_resources
+
 
 class ExtendedConfigParser(configparser.ConfigParser):
     """Extends the ConfigParser with the ability to read and parse lists.
@@ -22,8 +24,10 @@ def getlist(self, section, option, raw=False, vars=None, fallback=None) -> List:
 
 
 class ConfigManager(object):
-    PATH_TO_CONFIG = "config.ini"
-    PATH_TO_DEFAULT_CONFIG = "ressources/default_config.ini"
+    PATH_TO_CONFIG = "config.ini"  # TODO: Handle!
+    PATH_TO_DEFAULT_CONFIG = pkg_resources.resource_filename(
+        "labelCloud.ressources", "default_config.ini"
+    )
 
     def __init__(self) -> None:
         self.config = ExtendedConfigParser(comment_prefixes="/", allow_no_value=True)

labelCloud/control/controller.py

@@ -1,10 +1,10 @@
 from typing import Union
 
 from PyQt5 import QtCore, QtGui
-from utils import oglhelper
-from model.bbox import BBox
-from view.gui import GUI
 
+from ..definitions import BBOX_SIDES
+from ..utils import oglhelper
+from ..view.gui import GUI
 from .alignmode import AlignMode
 from .bbox_controller import BoundingBoxController
 from .drawing_manager import DrawingManager
@@ -117,7 +117,7 @@ def set_selected_side(self) -> None:
             self.view.glWidget.crosshair_col = [1, 0, 0]
             side_vertices = self.bbox_controller.get_active_bbox().get_vertices()
             self.view.glWidget.selected_side_vertices = side_vertices[
-                BBox.BBOX_SIDES[self.selected_side]
+                BBOX_SIDES[self.selected_side]
             ]
         else:
             self.view.glWidget.selected_side_vertices = []

labelCloud/control/drawing_manager.py

@@ -1,11 +1,10 @@
 from typing import TYPE_CHECKING, Union
 
-from labeling_strategies import BaseLabelingStrategy
-
+from ..labeling_strategies import BaseLabelingStrategy
 from .bbox_controller import BoundingBoxController
 
 if TYPE_CHECKING:
-    from view.gui import GUI
+    from ..view.gui import GUI
 
 
 class DrawingManager(object):

labelCloud/control/label_manager.py

@@ -2,9 +2,8 @@
 import os
 from typing import List
 
-from label_formats import BaseLabelFormat, CentroidFormat, KittiFormat, VerticesFormat
-from model.bbox import BBox
-
+from ..label_formats import BaseLabelFormat, CentroidFormat, KittiFormat, VerticesFormat
+from ..model.bbox import BBox
 from .config_manager import config
 
 

labelCloud/control/pcd_manager.py

@@ -10,14 +10,15 @@
 
 import numpy as np
 import open3d as o3d
-from model.bbox import BBox
-from model.point_cloud import PointCloud
 
+from ..model import BBox, PointCloud
 from .config_manager import config
 from .label_manager import LabelManager
 
 if TYPE_CHECKING:
-    from view.gui import GUI
+    from ..view.gui import GUI
+
+import pkg_resources
 
 
 @dataclass
@@ -27,7 +28,9 @@ class Perspective(object):
 
 
 def color_pointcloud(points, z_min, z_max) -> np.ndarray:
-    palette = np.loadtxt("labelCloud/ressources/rocket-palette.txt")
+    palette = np.loadtxt(
+        pkg_resources.resource_filename("labelCloud.ressources", "rocket-palette.txt")
+    )
     palette_len = len(palette) - 1
 
     colors = np.zeros(points.shape)
@@ -81,7 +84,9 @@ def read_pointcloud_folder(self) -> None:
                 "Please set the point cloud folder to a location that contains point cloud files."
             )
             self.pointcloud = self.load_pointcloud(
-                "labelCloud/ressources/labelCloud_icon.pcd"
+                pkg_resources.resource_filename(
+                    "labelCloud.ressources", "labelCloud_icon.pcd"
+                )
             )
             self.update_pcd_infos(pointcloud_label=" – (select folder!)")
 

labelCloud/definitions/__init__.py

@@ -0,0 +1 @@
+from .bbox import BBOX_EDGES, BBOX_SIDES

labelCloud/definitions/bbox.py

@@ -0,0 +1,26 @@
+# order in which the bounding box edges are drawn
+BBOX_EDGES = [
+    (0, 1),
+    (0, 3),
+    (0, 4),
+    (2, 1),
+    (2, 3),
+    (2, 6),
+    (5, 1),
+    (5, 4),
+    (5, 6),
+    (7, 3),
+    (7, 4),
+    (7, 6),
+]
+
+
+# vertices of each side
+BBOX_SIDES = {
+    "top": [4, 5, 6, 7],
+    "bottom": [0, 1, 2, 3],
+    "right": [2, 3, 7, 6],
+    "back": [0, 3, 7, 4],
+    "left": [0, 1, 5, 4],
+    "front": [1, 2, 6, 5],
+}

labelCloud/label_formats/base.py

@@ -4,7 +4,8 @@
 from typing import List, Optional, Union
 
 import numpy as np
-from model import BBox
+
+from ..model import BBox
 
 
 class BaseLabelFormat(ABC):

labelCloud/label_formats/centroid_format.py

@@ -2,8 +2,7 @@
 import os
 from typing import List
 
-from model import BBox
-
+from ..model import BBox
 from . import BaseLabelFormat, abs2rel_rotation, rel2abs_rotation
 
 

labelCloud/label_formats/kitti_format.py

@@ -2,8 +2,7 @@
 import os
 from typing import List
 
-from model import BBox
-
+from ..model import BBox
 from . import BaseLabelFormat, abs2rel_rotation, rel2abs_rotation
 
 

labelCloud/label_formats/vertices_format.py

@@ -3,9 +3,9 @@
 from typing import List
 
 import numpy as np
-from model import BBox
-from utils import math3d
 
+from ..model import BBox
+from ..utils import math3d
 from . import BaseLabelFormat
 
 

labelCloud/labeling_strategies/base.py

@@ -1,10 +1,9 @@
 from abc import ABC, abstractmethod
 from typing import TYPE_CHECKING, List
 
-from model.bbox import BBox
-
 if TYPE_CHECKING:
-    from view.gui import GUI
+    from ..model import BBox
+    from ..view.gui import GUI
 
 
 class BaseLabelingStrategy(ABC):
@@ -30,7 +29,7 @@ def register_scrolling(self, distance: float) -> None:
         pass
 
     @abstractmethod
-    def get_bbox(self) -> BBox:
+    def get_bbox(self) -> "BBox":
         raise NotImplementedError
 
     def draw_preview(self) -> None:

labelCloud/labeling_strategies/picking.py

@@ -1,14 +1,14 @@
 from typing import TYPE_CHECKING, List
 
 import numpy as np
-import utils.oglhelper as ogl
-from control.config_manager import config
-from model import BBox
 
+from ..control.config_manager import config
+from ..model import BBox
+from ..utils import oglhelper as ogl
 from . import BaseLabelingStrategy
 
 if TYPE_CHECKING:
-    from view.gui import GUI
+    from ..view.gui import GUI
 
 
 class PickingStrategy(BaseLabelingStrategy):

labelCloud/labeling_strategies/spanning.py

@@ -1,15 +1,15 @@
 from typing import TYPE_CHECKING, List
 
 import numpy as np
-import utils.math3d as math3d
-import utils.oglhelper as ogl
-from control.config_manager import config
-from model import BBox
 
+from ..control.config_manager import config
+from ..model import BBox
+from ..utils import math3d as math3d
+from ..utils import oglhelper as ogl
 from . import BaseLabelingStrategy
 
 if TYPE_CHECKING:
-    from view.gui import GUI
+    from ..view.gui import GUI
 
 import numpy as np