v1.1.0

README.md

@@ -1,4 +1,4 @@
-### *NTV-pandas : A semantic, compact and reversible JSON-pandas converter*
+### *NTV-pandas : A tabular analyzer and a semantic, compact and reversible JSON-pandas converter*
 
 <img src="https://loco-philippe.github.io/ES/ntv_pandas.png" alt="ntv-pandas" align="middle" style="height:80px;">
 
@@ -14,6 +14,8 @@ pandas provide JSON converter but three limitations are present:
 - the JSON-pandas converter is not always reversible (conversion round trip)
 - external data types (e.g. TableSchema types) are not included
 
+pandas does not have a tool for analyzing tabular structures and detecting integrity errors
+
 ## main features
 
 The NTV-pandas converter uses the [semantic NTV format](https://loco-philippe.github.io/ES/JSON%20semantic%20format%20(JSON-NTV).htm)
@@ -25,9 +27,11 @@ The converter integrates:
 - an always reversible conversion,
 - a full compatibility with [Table Schema specification](http://dataprotocols.org/json-table-schema/#field-types-and-formats)
 
+The NTV-pandas analyzer uses the [TAB-analysis](https://github.com/loco-philippe/tab-analysis/blob/main/README.md) tool to analyze and measure the relationships between Fields in DataFrame and the [TAB-dataset](https://github.com/loco-philippe/tab-dataset/blob/main/README.md) to identify integrity errors ([example](https://github.com/loco-philippe/ntv-pandas/tree/main/example#readme)).
+
 NTV-pandas was developped originally in the [json-NTV project](https://github.com/loco-philippe/NTV)
 
-## example
+## converter example
 
 In the example below, a DataFrame with multiple data types is converted to JSON (first to NTV format and then to Table Schema format).
 

docs/README.md

@@ -11,6 +11,7 @@ The documentation presents :
 
 - API
   - [dev](https://loco-philippe.github.io/ntv-pandas/ntv_pandas.html)
+  - [v1.1.0](https://loco-philippe.github.io/ntv-pandas/v1.1.0/ntv_pandas.html)
   - [v1.0.2](https://loco-philippe.github.io/ntv-pandas/v1.0.2/ntv_pandas.html)
   - [v1.0.1](https://loco-philippe.github.io/ntv-pandas/v1.0.1/ntv_pandas.html)
   - [v1.0.0](https://loco-philippe.github.io/ntv-pandas/v1.0.0/ntv_pandas.html)

docs/release.rst

@@ -1,6 +1,13 @@
 Version x.y.z
 =============
 
+1.1.0 (2024-01-04)
+--------------------
+- add `to_analysis` function to use `TAB-analysis`module
+- add `check_relation` function to use `TAB-dataset.check_relation` method
+- add pandas accessor for `to_analysis` and `check_relation`
+
+
 1.0.2 (2023-11-23)
 --------------------
 - move `decode_ntv_tab` method in `ntv_util` module ('json_ntv')

example/README.md

@@ -1,7 +1,8 @@
 # Examples and uses
 
-Three Notebooks are available:
+Four Notebooks are available:
 
+- [integrity](https://nbviewer.org/github/loco-philippe/ntv-pandas/blob/main/example/example_analysis.ipynb) explains how identify integrity errors in a DataFrame
 - [json-pandas](https://nbviewer.org/github/loco-philippe/ntv-pandas/blob/main/example/example_json_pandas.ipynb) presents limitations of existing json-pandas interface
 - [ntv-pandas](https://nbviewer.org/github/loco-philippe/ntv-pandas/blob/main/example/example_ntv_pandas.ipynb) presents the ntv-pandas interface
 - [table-pandas](https://nbviewer.org/github/loco-philippe/ntv-pandas/blob/main/example/example_table_pandas.ipynb) presents the table-schema interface