Rename: TransformationProject -> ProjectTransformation

Author: amotl

CHANGES.md

@@ -3,6 +3,7 @@
 ## Unreleased
 - Update documentation
 - Adjust wording. Improve tests. Add API example.
+- Rename: `TransformationProject` -> `ProjectTransformation`
 
 ## 2025/03/14 v0.2.0
 - Core: Added streaming support for JSONL / NDJSON files

src/tikray/core.py

@@ -6,7 +6,7 @@
 from tqdm import tqdm
 
 from tikray.model.collection import CollectionAddress, CollectionTransformation
-from tikray.model.project import TransformationProject
+from tikray.model.project import ProjectTransformation
 from tikray.util.data import lines_in_file, load_json, save_json
 
 logger = logging.getLogger(__name__)
@@ -15,7 +15,7 @@
 def process_project(transformation: Path, input_: Path, output: Path, use_jsonl: bool = False) -> None:
     logger.info(f"Using transformation '{transformation}' on multi-collection input '{input_}'")
 
-    project = TransformationProject.from_yaml(transformation.read_text())
+    project = ProjectTransformation.from_yaml(transformation.read_text())
     for item in input_.iterdir():
         logger.info(f"Processing input: {item}")
         address = CollectionAddress(container=item.parent.name, name=item.stem)
@@ -40,7 +40,7 @@ def process_collection(
     logger.info(f"Using transformation '{transformation}' on single-collection input '{input_}'")
     ct = CollectionTransformation.from_yaml(transformation.read_text())
     if address is not None:
-        pt = TransformationProject.from_yaml(transformation.read_text())
+        pt = ProjectTransformation.from_yaml(transformation.read_text())
         ct = pt.get(CollectionAddress(*address.split(".")))
     logger.info(f"Processing input: {input_}")
     lines = lines_in_file(input_)

src/tikray/model/project.py

@@ -8,7 +8,7 @@
 
 
 @define
-class TransformationProject(Dumpable):
+class ProjectTransformation(Dumpable):
     meta: Metadata = Metadata(version=1, type="tikray-project")
     collections: t.List[CollectionTransformation] = Factory(list)
     _map: t.Dict[CollectionAddress, CollectionTransformation] = Factory(dict)
@@ -18,13 +18,13 @@ def __attrs_post_init__(self):
             for collection in self.collections:
                 self._add(collection)
 
-    def _add(self, collection: CollectionTransformation) -> "TransformationProject":
+    def _add(self, collection: CollectionTransformation) -> "ProjectTransformation":
         if collection is None or collection.address is None:
             raise ValueError("CollectionTransformation or address missing")
         self._map[collection.address] = collection
         return self
 
-    def add(self, collection: CollectionTransformation) -> "TransformationProject":
+    def add(self, collection: CollectionTransformation) -> "ProjectTransformation":
         self.collections.append(collection)
         return self._add(collection)
 

tests/test_project.py

@@ -2,23 +2,23 @@
 
 import pytest
 from tikray.model.collection import CollectionAddress, CollectionTransformation
-from tikray.model.project import TransformationProject
+from tikray.model.project import ProjectTransformation
 
 
 @pytest.mark.skipif(sys.version_info < (3, 9), reason="Does not work on Python 3.8 and earlier")
 def test_project_success():
     address = CollectionAddress(container="foo", name="bar")
     ct = CollectionTransformation(address=address)
-    pt = TransformationProject().add(ct)
+    pt = ProjectTransformation().add(ct)
     pt.to_yaml()
 
-    pt = TransformationProject(collections=[ct])
+    pt = ProjectTransformation(collections=[ct])
     pt.to_yaml()
 
     assert pt.get(address) is ct
 
 
 def test_project_failure():
     with pytest.raises(ValueError) as ex:
-        TransformationProject().add(CollectionTransformation())
+        ProjectTransformation().add(CollectionTransformation())
     assert ex.match("CollectionTransformation or address missing")