DataComparerLibrary 0.854__tar.gz → 0.856__tar.gz

{datacomparerlibrary-0.854 → datacomparerlibrary-0.856}/PKG-INFO

@@ -1,9 +1,11 @@
 Metadata-Version: 2.4
 Name: DataComparerLibrary
-Version: 0.854
+Version: 0.856
 Summary: For comparing csv-files, 2d-array with a csv-file or 2d-arrays. For comparing text-files, text variable with a text-file or text variables. Including a sorting module.
 Author-email: René Philip Zuijderduijn <datacomparerlibrary@outlook.com>
 License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ReneFromHolland/DataComparerLibrary
+Project-URL: Keyword docs, https://github.com/ReneFromHolland/DataComparerLibrary
 Keywords: robotframework,Robot Framework,testing,test-automation,datacompare,data compare,compare csv files,compare text files,compare txt files,compare arrays,compare text
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: Microsoft :: Windows :: Windows 10
@@ -14,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Testing
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
@@ -29,6 +32,11 @@ DataComparerLibrary
    :local:
 
 
+Documentation
+===================
+See `keyword documentation`_ for available keywords and more information
+about the library in general.
+
 Preparation
 ===================
 
@@ -36,13 +44,17 @@ Installation
 ------------
 
 If you already have Python with `pip <https://pip.pypa.io>`_ installed,
-you can simply run::
+you can simply run:
+
+.. sourcecode::
 
     pip install DataComparerLibrary
     pip install --upgrade DataComparerLibrary
 
 
-Also the following pip package is needed::
+Also the following pip package is needed:
+
+.. sourcecode::
 
     pip install python-dateutil
 
@@ -50,7 +62,9 @@ Also the following pip package is needed::
 Import statement for the DataComparerLibrary in Python
 ------------------------------------------------------
 
-from DataComparerLibrary.datacomparer import DataComparer
+.. sourcecode::
+
+  from DataComparerLibrary.datacomparer import DataComparer
 
 
 
@@ -66,8 +80,16 @@ The DataComparerLibrary can be used for:
     - comparing a csv-file or text-file with a 2d-matrix
     - comparing 2d-matrices
 
-| In case a difference between actual and expected data is found an exception wil be given. In Robot Framework
-  the result will be set to failed.
+| The DataComparer will present the actual data and the expected data.
+| In case a difference between actual and expected data is found an exception wil be given. Also these differences will be presented. 
+| In Robot Framework the comparison result will be set to failed.
+|
+
+|
+
+Special options
+---------------
+
 | A strait comparison can be made, but the DataComparerLibrary offers also some special comparison options described
   beneath.
 |
@@ -135,8 +157,9 @@ Below there are some examples how to call the methods of the DataComparerLibrary
 Examples of using the DataComparerLibrary keywords for comparing data in Robot Framework
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -222,8 +245,9 @@ Comparing Text
 Examples of using the DataComparerLibrary for comparing text in Python
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Below there are some examples how to call the methods of the DataComparerLibrary in Python::
+Below there are some examples how to call the methods of the DataComparerLibrary in Python:
 
+.. sourcecode::
 
     a = DataComparer
     a.compare_text_files(self, actual_file, expected_file)
@@ -235,8 +259,9 @@ Below there are some examples how to call the methods of the DataComparerLibrary
 Examples of using the DataComparerLibrary keywords for comparing text in Robot Framework
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -296,8 +321,9 @@ Special sorting
 Examples of using the DataComparerLibrary keywords for sorting data in Robot Framework
 ----------------------------------------------------------------------------------------
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -342,8 +368,9 @@ the input file. The result will be written to an output file.
 Examples of using the DataComparerLibrary keywords for preparing data in Robot Framework
 ----------------------------------------------------------------------------------------
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -365,3 +392,6 @@ Below there are some examples how to call the keywords of the DataComparerLibrar
         DataComparerLibrary.Replace Separate Lf  input_file_with_separate_lf.txt  output_file_lf_replaced_by_character_or_string.txt  ${SPACE}
 
 
+
+
+.. _Keyword Documentation: https://renefromholland.github.io/DataComparerLibrary/DataComparerLibraryKeywords.html

{datacomparerlibrary-0.854 → datacomparerlibrary-0.856}/README.rst

@@ -6,6 +6,11 @@ DataComparerLibrary
    :local:
 
 
+Documentation
+===================
+See `keyword documentation`_ for available keywords and more information
+about the library in general.
+
 Preparation
 ===================
 
@@ -13,13 +18,17 @@ Installation
 ------------
 
 If you already have Python with `pip <https://pip.pypa.io>`_ installed,
-you can simply run::
+you can simply run:
+
+.. sourcecode::
 
     pip install DataComparerLibrary
     pip install --upgrade DataComparerLibrary
 
 
-Also the following pip package is needed::
+Also the following pip package is needed:
+
+.. sourcecode::
 
     pip install python-dateutil
 
@@ -27,7 +36,9 @@ Also the following pip package is needed::
 Import statement for the DataComparerLibrary in Python
 ------------------------------------------------------
 
-from DataComparerLibrary.datacomparer import DataComparer
+.. sourcecode::
+
+  from DataComparerLibrary.datacomparer import DataComparer
 
 
 
@@ -43,8 +54,16 @@ The DataComparerLibrary can be used for:
     - comparing a csv-file or text-file with a 2d-matrix
     - comparing 2d-matrices
 
-| In case a difference between actual and expected data is found an exception wil be given. In Robot Framework
-  the result will be set to failed.
+| The DataComparer will present the actual data and the expected data.
+| In case a difference between actual and expected data is found an exception wil be given. Also these differences will be presented. 
+| In Robot Framework the comparison result will be set to failed.
+|
+
+|
+
+Special options
+---------------
+
 | A strait comparison can be made, but the DataComparerLibrary offers also some special comparison options described
   beneath.
 |
@@ -112,8 +131,9 @@ Below there are some examples how to call the methods of the DataComparerLibrary
 Examples of using the DataComparerLibrary keywords for comparing data in Robot Framework
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -199,8 +219,9 @@ Comparing Text
 Examples of using the DataComparerLibrary for comparing text in Python
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Below there are some examples how to call the methods of the DataComparerLibrary in Python::
+Below there are some examples how to call the methods of the DataComparerLibrary in Python:
 
+.. sourcecode::
 
     a = DataComparer
     a.compare_text_files(self, actual_file, expected_file)
@@ -212,8 +233,9 @@ Below there are some examples how to call the methods of the DataComparerLibrary
 Examples of using the DataComparerLibrary keywords for comparing text in Robot Framework
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -273,8 +295,9 @@ Special sorting
 Examples of using the DataComparerLibrary keywords for sorting data in Robot Framework
 ----------------------------------------------------------------------------------------
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -319,8 +342,9 @@ the input file. The result will be written to an output file.
 Examples of using the DataComparerLibrary keywords for preparing data in Robot Framework
 ----------------------------------------------------------------------------------------
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -342,3 +366,6 @@ Below there are some examples how to call the keywords of the DataComparerLibrar
         DataComparerLibrary.Replace Separate Lf  input_file_with_separate_lf.txt  output_file_lf_replaced_by_character_or_string.txt  ${SPACE}
 
 
+
+
+.. _Keyword Documentation: https://renefromholland.github.io/DataComparerLibrary/DataComparerLibraryKeywords.html

{datacomparerlibrary-0.854 → datacomparerlibrary-0.856}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "DataComparerLibrary"
 description = "For comparing csv-files, 2d-array with a csv-file or 2d-arrays. For comparing text-files, text variable with a text-file or text variables. Including a sorting module."
-version = "0.854"
+version = "0.856"
 dependencies = ["python-dateutil"]
 authors = [{ name = "René Philip Zuijderduijn", email = "datacomparerlibrary@outlook.com" }]
 readme = "README.rst"
@@ -22,12 +22,16 @@ classifiers=[
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Software Development :: Testing",
 ]
 requires-python = ">=3.8"
 keywords = ["robotframework", "Robot Framework","testing", "test-automation", "datacompare", "data compare", "compare csv files",
             "compare text files", "compare txt files", "compare arrays", "compare text"]
 
+[project.urls]
+"Homepage" = "https://github.com/ReneFromHolland/DataComparerLibrary"
+"Keyword docs" = "https://github.com/ReneFromHolland/DataComparerLibrary"
 
 [tool.setuptools]
 package-dir = { "" = "src" }

{datacomparerlibrary-0.854 → datacomparerlibrary-0.856}/src/DataComparerLibrary/__init__.py

@@ -7,6 +7,3 @@ from .fileconverter import FileConverter
 
 class DataComparerLibrary(DataComparer, DataSorter, FileConverter):
     ROBOT_LIBRARY_SCOPE = 'GLOBAL'
-
-
-

{datacomparerlibrary-0.854 → datacomparerlibrary-0.856}/src/DataComparerLibrary/datacomparer.py

@@ -14,7 +14,7 @@ class DataComparer:
         #
         expected_data = self.__get_data_from_csv_input_file(expected_file, delimiter_expected_data, quotechar_expected_data)
         #
-        DataComparer.compare_data(actual_data, expected_data, template_literals_dict)
+        DataComparer.__compare_data(actual_data, expected_data, template_literals_dict)
 
 
     def compare_data_file_with_2d_array(self, actual_file, expected_data, delimiter_actual_data=",", quotechar_actual_data='"', template_literals_dict=None):
@@ -23,14 +23,14 @@ class DataComparer:
         #
         actual_data = self.__get_data_from_csv_input_file(actual_file, delimiter_actual_data, quotechar_actual_data)
         #
-        DataComparer.compare_data(actual_data, expected_data, template_literals_dict)
+        DataComparer.__compare_data(actual_data, expected_data, template_literals_dict)
 
 
     def compare_data_2d_arrays(self, actual_data, expected_data, template_literals_dict=None):
         self.__check_if_actual_data_is_present(actual_data)
         self.__check_if_expected_data_is_present(expected_data)
         #
-        DataComparer.compare_data(actual_data, expected_data, template_literals_dict)
+        DataComparer.__compare_data(actual_data, expected_data, template_literals_dict)
 
 
     def compare_data_files(self, actual_file, expected_file, delimiter_actual_data=",", delimiter_expected_data=",", quotechar_actual_data='"', quotechar_expected_data='"', template_literals_dict=None):
@@ -40,7 +40,7 @@ class DataComparer:
         actual_data = self.__get_data_from_csv_input_file(actual_file, delimiter_actual_data, quotechar_actual_data)
         expected_data = self.__get_data_from_csv_input_file(expected_file, delimiter_expected_data, quotechar_expected_data)
         #
-        DataComparer.compare_data(actual_data, expected_data, template_literals_dict)
+        DataComparer.__compare_data(actual_data, expected_data, template_literals_dict)
 
 
 
@@ -51,7 +51,7 @@ class DataComparer:
         actual_data = self.__split_text_into_textline_array(actual_text)
         expected_data = self.__split_textfile_into_textline_array(expected_file)
         #
-        DataComparer.compare_data(actual_data, expected_data, template_literals_dict)
+        DataComparer.__compare_data(actual_data, expected_data, template_literals_dict)
 
 
     def compare_text_file_with_text_variable(self, actual_file, expected_text, template_literals_dict=None):
@@ -61,7 +61,7 @@ class DataComparer:
         actual_data = self.__split_textfile_into_textline_array(actual_file)
         expected_data = self.__split_text_into_textline_array(expected_text)
         #
-        DataComparer.compare_data(actual_data, expected_data, template_literals_dict)
+        DataComparer.__compare_data(actual_data, expected_data, template_literals_dict)
 
 
     def compare_text_variables(self, actual_text, expected_text, template_literals_dict=None):
@@ -71,7 +71,7 @@ class DataComparer:
         actual_data = self.__split_text_into_textline_array(actual_text)
         expected_data = self.__split_text_into_textline_array(expected_text)
         #
-        DataComparer.compare_data(actual_data, expected_data, template_literals_dict)
+        DataComparer.__compare_data(actual_data, expected_data, template_literals_dict)
 
 
     def compare_text_files(self, actual_file, expected_file, template_literals_dict=None):
@@ -81,12 +81,14 @@ class DataComparer:
         actual_data = self.__split_textfile_into_textline_array(actual_file)
         expected_data = self.__split_textfile_into_textline_array(expected_file)
         #
-        DataComparer.compare_data(actual_data, expected_data, template_literals_dict)
+        DataComparer.__compare_data(actual_data, expected_data, template_literals_dict)
 
 
 
     @staticmethod
-    def compare_data(actual_data, expected_data, template_literals_dict=None):
+    def __compare_data(actual_data, expected_data, template_literals_dict=None):
+        if template_literals_dict is not None and not isinstance(template_literals_dict, dict):
+            raise Exception(f"The argument passed to parameter 'template_literals_dict' is not a dictionary. Value is: '{template_literals_dict}'.")
         actual_data = DataComparer.__make_data_2d_compliant(actual_data)
         expected_data = DataComparer.__make_data_2d_compliant(expected_data)
         #

{datacomparerlibrary-0.854 → datacomparerlibrary-0.856}/src/DataComparerLibrary/datetimehandler.py

@@ -9,15 +9,15 @@ class DatetimeHandler:
         position_open_brace_today_text  = expected_data_field_including_date_template.find("{NOW()")
         position_close_brace_today_text = expected_data_field_including_date_template.find("}", position_open_brace_today_text)
         #
+        if position_open_brace_today_text == -1:
+            raise Exception("Open brace '{NOW()' not found.")
+        #
         if position_close_brace_today_text == -1:
-            return -1
-        # Close brace of TODAY has been found.
+            raise Exception("Close brace '}' not found.")
         #
         expected_datetime_template_string = expected_data_field_including_date_template[position_open_brace_today_text:position_close_brace_today_text + 1]
         expected_datetime_string = DatetimeHandler.__convert_datetime_template_to_datetime(self, expected_datetime_template_string)
         #
-        if expected_datetime_string == -1:
-            return -1
         # Datetime_template_string has been converted to datetime.
         #
         # Replace expected_datetime_template_string by expected_datetime_string in expected_data_field_including_template.
@@ -48,18 +48,16 @@ class DatetimeHandler:
                     # Adjust date time based on current date time.
                     relative_datetime_template_string = template_datetime_string_splitted[0].replace('{NOW()', '')
                     relative_datetime = DatetimeHandler.__convert_relative_datetime_template_to_relative_datetime(self, relative_datetime_template_string[1:len(relative_datetime_template_string)])
-                    if relative_datetime == -1:
-                        return -1
-                    else:
-                        match relative_datetime_template_string[0]:
-                            case "+":
-                                expected_datetime = datetime.datetime.now() + relative_datetime
-                            case "-":
-                                expected_datetime = datetime.datetime.now() - relative_datetime
-                            case _:
-                                return -1
+                    #
+                    match relative_datetime_template_string[0]:
+                        case "+":
+                            expected_datetime = datetime.datetime.now() + relative_datetime
+                        case "-":
+                            expected_datetime = datetime.datetime.now() - relative_datetime
+                        case _:
+                            raise Exception("'+' or '-' sign not found in '{NOW() relative datetime template string'.")
             case _:
-                return -1
+                raise Exception("Datetime template format in {NOW() datetime string is incorrect. Split sign ':' to separate expectation and format has been found more than once.")
         #
         year = expected_datetime.strftime("%Y")
         year_2_digits = expected_datetime.strftime("%y")
@@ -80,7 +78,7 @@ class DatetimeHandler:
         period = regex.match(relative_datetime_str)
 
         if not period:
-            return -1
+            raise Exception("Relative datetime template format in '{NOW() datetime template string' " + relative_datetime_str + " is incorrect.")
 
         period = period.groupdict()
         kwargs = {}
@@ -97,4 +95,4 @@ class DatetimeHandler:
         if kwargs:
             return dateutil.relativedelta.relativedelta(**kwargs)
         else:
-            return -1    
+            raise Exception("Relative datetime template format in '{NOW() datetime template string' " + relative_datetime_str + " is incorrect.")

{datacomparerlibrary-0.854 → datacomparerlibrary-0.856}/src/DataComparerLibrary/field.py

@@ -49,9 +49,12 @@ class Field:
 
     @staticmethod
     def __replace_template_literals_dict(data, template_literals_dict):
-        if template_literals_dict:
-            for i in range(0, len(template_literals_dict)):
-                data = data.replace(list(template_literals_dict.keys())[i], str(list(template_literals_dict.values())[i]))
+        try:
+            if template_literals_dict:
+                for i in range(0, len(template_literals_dict)):
+                    data = data.replace(list(template_literals_dict.keys())[i], str(list(template_literals_dict.values())[i]))
+        except Exception as exception_message:
+            raise Exception(f"Error during replacing literals. The argument passed to parameter 'template_literals_dict': {template_literals_dict}. Error message: {exception_message}.")
         return data
 
 
@@ -137,20 +140,23 @@ class Field:
             if all([x not in other_field_data_including_templates.upper() for x in matches]):
                 equal = False
                 Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, other_field_data_including_templates, "NOW() has been found in expected data field, but format is incorrect.")
-                #continue
+                Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, other_field_data_including_templates, "Colon character ':', sign '+' or '-'' is missing behind NOW().")
+                return False
             #
-            expected_data = DatetimeHandler.replace_date_template_in_expected_data(self, expected_data_including_date_template)
-            #
-            if expected_data == -1:
-                equal = False
-                Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, other_field_data_including_templates, "NOW() has been found in expected data field, but format is incorrect.")
-            else:
+            try:
+                expected_data = DatetimeHandler.replace_date_template_in_expected_data(self, expected_data_including_date_template)
+                #
                 if not fnmatch.fnmatch(self.field_data, expected_data):
                     # No match despite using of wildcard(s).
                     equal = False
                     Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, other_field_data_including_templates, "Date template format displayed. See also next message line.")
                     Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, expected_data, "There is a difference between actual and expected data.")
-            # continue
+                #
+            except Exception as exception_message:
+                equal = False
+                Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, other_field_data_including_templates, "NOW() has been found in expected data field, but format is incorrect.")
+                Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, other_field_data_including_templates, exception_message)
+
             #
         elif "{NOT(" in other_field_data_including_templates.upper():
             try:
@@ -160,11 +166,11 @@ class Field:
                     # Unwanted match.
                     equal = False
                     Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, other_field_data_including_templates, "NOT() template format displayed. See also next message line.")
-                    Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, unwanted_expected_data, "Actual and expected data are equal. However actual data should NOT be equal to the expected data!!!")
+                    Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, "<> "+ str(unwanted_expected_data), "Actual and expected data are equal. However actual data should NOT be equal to the expected data!!!")
             except Exception as exception_message:
-                # print(f"An exception occurred: {exception_message}")
                 equal = False
                 Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, other_field_data_including_templates, "NOT() has been found in expected data field, but format is incorrect.")
+                Report.show_differences_comparation_result(self.row_nr, self.column_nr, self.field_data, other_field_data_including_templates, exception_message)
             #
         else:
             if not skip_exception_rule_used:
@@ -182,11 +188,11 @@ class Field:
         #
         if position_open_brace == -1:
             #print("position_open_brace:", position_open_brace)
-            raise Exception()
+            raise Exception("Open brace '{NOT(' not found.")
         #
         if position_close_brace == -1:
             #print("position_close_brace:", position_close_brace)
-            raise Exception()
+            raise Exception("Close brace '}' not found.")
         #
         unwanted_expected_data = expected_data_field_including_date_template[position_open_brace+5:position_close_brace]
         #

{datacomparerlibrary-0.854 → datacomparerlibrary-0.856}/src/DataComparerLibrary.egg-info/PKG-INFO

@@ -1,9 +1,11 @@
 Metadata-Version: 2.4
 Name: DataComparerLibrary
-Version: 0.854
+Version: 0.856
 Summary: For comparing csv-files, 2d-array with a csv-file or 2d-arrays. For comparing text-files, text variable with a text-file or text variables. Including a sorting module.
 Author-email: René Philip Zuijderduijn <datacomparerlibrary@outlook.com>
 License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ReneFromHolland/DataComparerLibrary
+Project-URL: Keyword docs, https://github.com/ReneFromHolland/DataComparerLibrary
 Keywords: robotframework,Robot Framework,testing,test-automation,datacompare,data compare,compare csv files,compare text files,compare txt files,compare arrays,compare text
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: Microsoft :: Windows :: Windows 10
@@ -14,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Testing
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
@@ -29,6 +32,11 @@ DataComparerLibrary
    :local:
 
 
+Documentation
+===================
+See `keyword documentation`_ for available keywords and more information
+about the library in general.
+
 Preparation
 ===================
 
@@ -36,13 +44,17 @@ Installation
 ------------
 
 If you already have Python with `pip <https://pip.pypa.io>`_ installed,
-you can simply run::
+you can simply run:
+
+.. sourcecode::
 
     pip install DataComparerLibrary
     pip install --upgrade DataComparerLibrary
 
 
-Also the following pip package is needed::
+Also the following pip package is needed:
+
+.. sourcecode::
 
     pip install python-dateutil
 
@@ -50,7 +62,9 @@ Also the following pip package is needed::
 Import statement for the DataComparerLibrary in Python
 ------------------------------------------------------
 
-from DataComparerLibrary.datacomparer import DataComparer
+.. sourcecode::
+
+  from DataComparerLibrary.datacomparer import DataComparer
 
 
 
@@ -66,8 +80,16 @@ The DataComparerLibrary can be used for:
     - comparing a csv-file or text-file with a 2d-matrix
     - comparing 2d-matrices
 
-| In case a difference between actual and expected data is found an exception wil be given. In Robot Framework
-  the result will be set to failed.
+| The DataComparer will present the actual data and the expected data.
+| In case a difference between actual and expected data is found an exception wil be given. Also these differences will be presented. 
+| In Robot Framework the comparison result will be set to failed.
+|
+
+|
+
+Special options
+---------------
+
 | A strait comparison can be made, but the DataComparerLibrary offers also some special comparison options described
   beneath.
 |
@@ -135,8 +157,9 @@ Below there are some examples how to call the methods of the DataComparerLibrary
 Examples of using the DataComparerLibrary keywords for comparing data in Robot Framework
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -222,8 +245,9 @@ Comparing Text
 Examples of using the DataComparerLibrary for comparing text in Python
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Below there are some examples how to call the methods of the DataComparerLibrary in Python::
+Below there are some examples how to call the methods of the DataComparerLibrary in Python:
 
+.. sourcecode::
 
     a = DataComparer
     a.compare_text_files(self, actual_file, expected_file)
@@ -235,8 +259,9 @@ Below there are some examples how to call the methods of the DataComparerLibrary
 Examples of using the DataComparerLibrary keywords for comparing text in Robot Framework
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -296,8 +321,9 @@ Special sorting
 Examples of using the DataComparerLibrary keywords for sorting data in Robot Framework
 ----------------------------------------------------------------------------------------
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -342,8 +368,9 @@ the input file. The result will be written to an output file.
 Examples of using the DataComparerLibrary keywords for preparing data in Robot Framework
 ----------------------------------------------------------------------------------------
 
-Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework:
 
+.. sourcecode::
 
     *** Settings ***
     Library     DataComparerLibrary
@@ -365,3 +392,6 @@ Below there are some examples how to call the keywords of the DataComparerLibrar
         DataComparerLibrary.Replace Separate Lf  input_file_with_separate_lf.txt  output_file_lf_replaced_by_character_or_string.txt  ${SPACE}
 
 
+
+
+.. _Keyword Documentation: https://renefromholland.github.io/DataComparerLibrary/DataComparerLibraryKeywords.html