Add test and doc updates

README.md

@@ -296,10 +296,28 @@ with open("my_pacs_008_from_code.xml", "w") as xml_file:
 
 ```
 
-### Message types?
-Currently supports PACS, PAIN and CAMT messages as well as HEAD (header documents for the messages).
+## Convert a CAMT.053 into an Excel file?
 
+You can convert the entries in a CAMT.053 into a Excel file using the tools.
 
-### Source of truth?
+Currently this will extract the `Ntry` list and take all details and place them into seperate columns. It will also translate the element names intro their more meaningful English versions.
+
+Use it like this:
+
+```python
+import pyiso20022.tools as isotools
+
+isotools.camt053_to_excel("my_camt053_file.xml",
+                          "my_camt053_excel_file.xlsx")
+```
+
+
+
+
+## Message types?
+Currently pyiso20022 supports PACS, PAIN and CAMT messages as well as HEAD (header documents for the messages).
+
+
+## Source of truth?
 
 If you want the original source of truth for all things ISO 20022 schema related then check out [www.iso20022.org](https://www.iso20022.org/)

make_xlsx.py

@@ -2,3 +2,6 @@
 
 isotools.camt053_to_excel("example_files/gs_camt/camt053_001_02.xml",
                           "camt053_excel.xlsx")
+
+hed = isotools.camt053_to_df("example_files/gs_camt/camt053_001_02.xml").head()
+print(hed)

pyiso20022/tools/__init__.py

@@ -1,3 +1,4 @@
-from pyiso20022.tools.camt053_to_excel import camt053_to_excel
+from pyiso20022.tools.camt053_extract import camt053_to_excel
+from pyiso20022.tools.camt053_extract import camt053_to_df
 
-__all__ = [camt053_to_excel]
+__all__ = [camt053_to_excel, camt053_to_df]

tests/tools_camt053_msgs_test.py

@@ -0,0 +1,34 @@
+import pytest
+from pyiso20022.tools.camt053_extract import *
+import tempfile
+import pandas as pd
+
+
+@pytest.mark.parametrize("entry_reference, msg_id", [
+        ("52198301", "20230928LTERMID100000312221631FT01")
+    ])
+def test_pandas_df_camt053_001_02(entry_reference, msg_id):
+
+    df = camt053_to_df("example_files/gs_camt/camt053_001_02.xml") 
+
+    result = df[df['Entry Reference'] == entry_reference]["Message Identification"]
+
+    assert result.values[0] == msg_id
+
+
+@pytest.mark.parametrize("entry_reference, msg_id", [
+        ("52198301", "20230928LTERMID100000312221631FT01")
+    ])
+def test_excel_camt053_001_02(entry_reference, msg_id):
+
+    tmp_file = tempfile.NamedTemporaryFile(suffix=".xlsx")
+    tmp_file_name = tmp_file.name
+
+    camt053_to_excel("example_files/gs_camt/camt053_001_02.xml", tmp_file_name)
+
+    df = pd.read_excel(tmp_file_name, sheet_name='Sheet1')
+
+    tmp_file.close()
+
+    result = df[df['Entry Reference'].astype(str) == str(entry_reference)]["Message Identification"]
+    assert result.values[0] == msg_id