[app][rfct] update docs

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "digiflow"
-version = "5.0.0"
+version = "5.1.0"
 description = "Father's Little Digitization Workflow Helper"
 readme = "README.md"
 requires-python = ">=3.8"

src/digiflow/record/common.py

@@ -82,6 +82,7 @@ def local_identifier(self):
 
     @property
     def identifier(self):
+        """Get record identifier"""
         return self.__urn
 
     def __str__(self) -> str:
@@ -94,6 +95,14 @@ def __str__(self) -> str:
             the_str = f"{the_str}\t{self.info}"
         return f"{the_str}\n{self.state}\t{self.state_datetime}"
 
+    @staticmethod
+    def create(input_data):
+        """De-serialize record from different input forms"""
+        record = Record(UNSET_LABEL)
+        if isinstance(input_data, dict):
+            record = row_to_record(input_data)
+        return record
+
 
 def row_to_record(row: typing.Dict):
     """Serialize data row to Record with all

src/digiflow/validate/metadata_ddb.py

@@ -2,14 +2,13 @@
 to DDB (Deutsche Digitale Bibliothek = German Digital Library)
 specific validations as well as XML schemata
 
-Assume DDB
-order it's remarks into 5 categories:
-
-* info      ingested but some information won't be used by DDB
-* warn      error but ingested without modification
-* caution   ingest but suspicous
-* error     ingest after DDB-modification
-* fatal     records can't be ingested => strict mode yields exceptional state
+Assuming DDB orders it's remarks in 5 categories:
+
+1) info      ingested but information won't be used by DDB
+2) warn      ingested without modification, but request for change
+3) caution   ingested but suspicous
+4) error     ingested after DDB did modifications
+5) fatal     records won't be ingested at all
 
 wiki.deutsche-digitale-bibliothek.de/display/DFD/Schematron-Validierungen+der+Fachstelle+Bibliothek
 """

tests/test_digiflow_record_handler.py

@@ -37,13 +37,13 @@
 OAI_BASE_URL_OPENDATA = 'opendata.uni-halle.de/oai/dd'
 
 # pylint: disable=c-extension-no-member, line-too-long
+
+
 @pytest.mark.parametrize(['urn', 'local_identifier'],
-                         [
-    ('oai:digital.bibliothek.uni-halle.de/hd:10595', '10595'),
-    ('oai:digitale.bibliothek.uni-halle.de/vd18:9427342', '9427342'),
-    ('oai:opendata.uni-halle.de:1981185920/34265', '1981185920_34265'),
-    ('oai:dev.opendata.uni-halle.de:123456789/27949', '123456789_27949'),
-])
+                         [('oai:digital.bibliothek.uni-halle.de/hd:10595', '10595'),
+                          ('oai:digitale.bibliothek.uni-halle.de/vd18:9427342', '9427342'),
+                          ('oai:opendata.uni-halle.de:1981185920/34265', '1981185920_34265'),
+                          ('oai:dev.opendata.uni-halle.de:123456789/27949', '123456789_27949')])
 def test_record_local_identifiers(urn, local_identifier):
     """Ensure local identifier for different URN inputs"""
 
@@ -789,13 +789,11 @@ def test_record_handler_with_broken_row(tmp_path):
     with open(tmp_res_path, 'a', encoding='utf-8') as tmp_file:
         tmp_file.write('\n')
 
-    handler = df_r.RecordHandler(tmp_res_path, 
+    handler = df_r.RecordHandler(tmp_res_path,
                                  transform_func=df_r.row_to_record)
 
     # act
     with pytest.raises(df_r.RecordHandlerException) as handl_exc:
-        handler.next_record(state='foo') # dummy state to provoke error
+        handler.next_record(state='foo')  # dummy state to provoke error
 
     assert "line:003 no STATE field " in handl_exc.value.args[0]
-
-