TLDR-473 make BBox class Serializable (#14)

Co-authored-by: Nikita Shevtsov <[email protected]>

CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+v0.3.4 (2023-09-28)
+-------------------
+* Add `Serializable` class
+* Make `BBox` child class of `Serializable`
+
 v0.3.3 (2023-09-28)
 -------------------
 * Update `BBox` class

VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

dedocutils/data_structures/bbox.py

@@ -5,9 +5,11 @@
 
 import numpy as np
 
+from dedocutils.data_structures.serializable import Serializable
+
 
 @dataclass
-class BBox:
+class BBox(Serializable):
     """
     Bounding box around some page object, the coordinate system starts from top left corner.
     """

dedocutils/data_structures/serializable.py

@@ -0,0 +1,16 @@
+from abc import ABC, abstractmethod
+
+
+class Serializable(ABC):
+    """
+    Base class for the serializable objects which we need convert to dict.
+    """
+    @abstractmethod
+    def to_dict(self) -> dict:
+        """
+        Convert class data into dictionary representation.
+        Dictionary key should be string and dictionary value should be json serializable.
+
+        :return: dict with all class data.
+        """
+        pass