json-duplicate-keys 2024.11.19__tar.gz → 2024.12.12__tar.gz

json_duplicate_keys-2024.12.12/PKG-INFO

@@ -0,0 +1,450 @@
+Metadata-Version: 2.1
+Name: json-duplicate-keys
+Version: 2024.12.12
+Summary: Flatten/ Unflatten and Load(s)/ Dump(s) JSON File/ Object with Duplicate Keys
+Home-page: https://github.com/truocphan/json-duplicate-keys
+Author: TP Cyber Security
+Author-email: tpcybersec2023@gmail.com
+License: MIT
+Keywords: TPCyberSec,json,duplicate keys,json duplicate keys,flatten,unflatten
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: Implementation :: Jython
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# JSON Duplicate Keys - PyPI
+Flatten/ Unflatten and Load(s)/ Dump(s) JSON File/ Object with Duplicate Keys
+
+<p align="center">
+	<a href="https://github.com/truocphan/json-duplicate-keys/releases/"><img src="https://img.shields.io/github/release/truocphan/json-duplicate-keys" height=30></a>
+	<a href="#"><img src="https://img.shields.io/github/downloads/truocphan/json-duplicate-keys/total" height=30></a>
+	<a href="#"><img src="https://img.shields.io/github/stars/truocphan/json-duplicate-keys" height=30></a>
+	<a href="#"><img src="https://img.shields.io/github/forks/truocphan/json-duplicate-keys" height=30></a>
+	<a href="https://github.com/truocphan/json-duplicate-keys/issues?q=is%3Aopen+is%3Aissue"><img src="https://img.shields.io/github/issues/truocphan/json-duplicate-keys" height=30></a>
+	<a href="https://github.com/truocphan/json-duplicate-keys/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed/truocphan/json-duplicate-keys" height=30></a>
+	<br>
+	<a href="#"><img src="https://img.shields.io/pypi/v/json-duplicate-keys" height=30></a>
+	<a href="#"><img src="https://img.shields.io/pypi/dm/json-duplicate-keys" height=30></a>
+</p>
+
+## Installation
+#### From PyPI:
+```console
+pip install json-duplicate-keys
+```
+#### From Source:
+```console
+git clone https://github.com/truocphan/json-duplicate-keys.git --branch <Branch/Tag>
+cd json-duplicate-keys
+python setup.py build
+python setup.py install
+```
+
+## Basic Usage
+### normalize_key(`name`, `dupSign_start`="{{{", `dupSign_end`="}}}", `_isDebug_`=False)
+_Normalize Key name_
+- `name`: key name
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+print(jdks.normalize_key("version{{{_2_}}}"))
+# OUTPUT: version
+```
+---
+
+### loads(`Jstr`, `dupSign_start`="{{{", `dupSign_end`="}}}", `ordered_dict`=False, `_isDebug_`=False)
+_Deserialize a JSON format string to a class `JSON_DUPLICATE_KEYS`_
+- `Jstr`: a JSON format string
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `ordered_dict`: preserves the order in which the Keys are inserted
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject)
+# OUTPUT: <json_duplicate_keys.JSON_DUPLICATE_KEYS object at 0x00000270AE987940>
+```
+---
+
+### load(`Jfilepath`, `dupSign_start`="{{{", `dupSign_end`="}}}", `ordered_dict`=False, `_isDebug_`=False)
+_Deserialize a JSON format string from a file to a class `JSON_DUPLICATE_KEYS`_
+- `Jfilepath`: The path to the file containing the JSON format string
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `ordered_dict`: preserves the order in which the Keys are inserted
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+# /path/to/file.json: {"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}
+
+import json_duplicate_keys as jdks
+
+Jfilepath = "/path/to/file.json"
+
+JDKSObject = jdks.load(Jfilepath)
+
+print(JDKSObject)
+# OUTPUT: <json_duplicate_keys.JSON_DUPLICATE_KEYS object at 0x00000270AE986D40>
+```
+---
+
+### JSON_DUPLICATE_KEYS.getObject()
+_Get the JSON object_
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
+```
+---
+
+### JSON_DUPLICATE_KEYS.get(`name`, `case_insensitive`=False, `separator`="||", `parse_index`="$", `_isDebug_`=False)
+_Get value in the JSON object by `name`_
+- `name`: the key name of the JSON object. Supported flatten key name format
+- `case_insensitive`: the key name case (in)sensitive
+- `separator`: 
+- `parse_index`:
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.get("version{{{_2_}}}"))
+# OUTPUT: {'name': 'version{{{_2_}}}', 'value': 'latest'}
+
+print(JDKSObject.get("release||$0$"))
+# OUTPUT: {'name': 'release||$0$', 'value': {'version': 'latest'}}
+
+print(JDKSObject.get("snapshot||author"))
+# OUTPUT: {'name': 'snapshot||author', 'value': 'truocphan'}
+```
+---
+
+### JSON_DUPLICATE_KEYS.set(`name`, `value`, `case_insensitive`=False, `separator`="||", `parse_index`="$", `dupSign_start`="{{{", `dupSign_end`="}}}", `ordered_dict`=False, `_isDebug_`=False)
+_Set a new `name` and `value` for the JSON object_
+- `name`: new key name for the JSON object. Supported flat key name format
+- `value`: value for key `name`
+- `case_insensitive`: the key name case (in)sensitive
+- `separator`: 
+- `parse_index`: 
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `ordered_dict`: preserves the order in which the Keys are inserted
+- `_isDebug_`: Show/Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{}'
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {}
+
+JDKSObject.set("author", "truocphan")
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan'}
+
+JDKSObject.set("version", "22.3.3")
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3'}
+
+JDKSObject.set("version", "latest")
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest'}
+
+JDKSObject.set("release", [{"version": "latest"}])
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}]}
+
+JDKSObject.set("snapshot", {})
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {}}
+
+JDKSObject.set("snapshot||author", "truocphan")
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan'}}
+
+
+Jstr = '[]'
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: []
+
+JDKSObject.set("author", "truocphan")
+print(JDKSObject.getObject())
+# OUTPUT: [{'author': 'truocphan'}]
+
+JDKSObject.set("release", [])
+print(JDKSObject.getObject())
+# OUTPUT: [{'author': 'truocphan'}, {'release': []}]
+
+JDKSObject.set("$1$||release||", {"version": "latest"})
+print(JDKSObject.getObject())
+# OUTPUT: [{'author': 'truocphan'}, {'release': [{'version': 'latest'}]}]
+```
+---
+
+### JSON_DUPLICATE_KEYS.insert(`name`, `value`, `position`=None, `case_insensitive`=False, `separator`="||", `parse_index`="$", `dupSign_start`="{{{", `dupSign_end`="}}}", `_isDebug_`=False)
+_Insert `value` at `position` in value list of `name`_
+- `name`: the key name of the JSON object. Supported flatten key name format
+- `value`: new value for key `name`
+- `position`: position of the `value` to insert (default insert at the last position of the list)
+- `case_insensitive`: the key name case (in)sensitive
+- `separator`: 
+- `parse_index`: 
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
+
+JDKSObject.insert("release", {'version': '2025.1.1'})
+JDKSObject.insert("snapshot||release", {'version': '2025.1.1'}, 0)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}, {'version': '2025.1.1'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': '2025.1.1'}, {'version': 'latest'}]}}
+```
+---
+
+### JSON_DUPLICATE_KEYS.update(`name`, `value`, `case_insensitive`=False, `allow_new_key`=False, `separator`="||", `parse_index`="$", `dupSign_start`="{{{", `dupSign_end`="}}}", `ordered_dict`=False, `_isDebug_`=False)
+_Update new `value` for existing `name` or Set a new `name` in the JSON object_
+- `name`: the key name of the JSON object. Supported flatten key name format
+- `value`: new value for key `name`
+- `case_insensitive`: the key name case (in)sensitive
+- `allow_new_key`: allows to create a new key name if the key name does not exist
+- `separator`: 
+- `parse_index`: 
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `ordered_dict`: preserves the order in which the Keys are inserted
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
+
+JDKSObject.update("version{{{_2_}}}", ["22.3.3", "latest"])
+JDKSObject.update("snapshot||version", "latest")
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': ['22.3.3', 'latest'], 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': 'latest', 'release': [{'version': 'latest'}]}}
+```
+---
+
+### JSON_DUPLICATE_KEYS.delete(`name`, `case_insensitive`=False, `separator`="||", `parse_index`="$", `_isDebug_`=False)
+_Delete a key-value pair in a JSON object by key `name`_
+- `name`: the key name of the JSON object. Supported flatten key name format
+- `case_insensitive`: the key name case (in)sensitive
+- `separator`: 
+- `parse_index`: 
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
+
+JDKSObject.delete("version")
+JDKSObject.delete("release||$0$")
+JDKSObject.delete("snapshot")
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version{{{_2_}}}': 'latest', 'release': []}
+```
+---
+
+### JSON_DUPLICATE_KEYS.filter_keys(`name`, `separator`="||", `parse_index`="$", `ordered_dict`=False)
+
+- `name`:
+- `separator`:
+- `parse_index`:
+- `ordered_dict`: preserves the order in which the Keys are inserted
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.filter_keys("version").dumps())
+# OUTPUT: {"version": "22.3.3", "version": "latest", "release||$0$||version": "latest", "snapshot||version": "22.3.3", "snapshot||release||$0$||version": "latest"}
+
+print(JDKSObject.dumps())
+# OUTPUT: {"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}
+```
+---
+
+### JSON_DUPLICATE_KEYS.filter_values(`value`, `separator`="||", `parse_index`="$", `ordered_dict`=False)
+
+- `value`:
+- `separator`:
+- `parse_index`:
+- `ordered_dict`: preserves the order in which the Keys are inserted
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.filter_values("latest").dumps())
+# OUTPUT: {"version": "latest", "release||$0$||version": "latest", "snapshot||release||$0$||version": "latest"}
+
+print(JDKSObject.dumps())
+# OUTPUT: {"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}
+```
+---
+
+### JSON_DUPLICATE_KEYS.dumps(`dupSign_start`="{{{", `dupSign_end`="}}}", `_isDebug_`=False, `skipkeys`=False, `ensure_ascii`=True, `check_circular`=True, `allow_nan`=True, `cls`=None, `indent`=None, `separators`=None, `default`=None, `sort_keys`=False)
+_Serialize a JSON object to a JSON format string_
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `_isDebug_`: Show/ Hide debug error messages
+- For remaining arguments, please refer to [json.dump()](https://docs.python.org/3/library/json.html#json.dump)
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
+
+JDKSObject.delete("version")
+JDKSObject.delete("release||$0$")
+JDKSObject.delete("snapshot")
+
+print(JDKSObject.dumps())
+# OUTPUT: {"author": "truocphan", "version": "latest", "release": []}
+```
+---
+
+### JSON_DUPLICATE_KEYS.dump(`Jfilepath`, `dupSign_start`="{{{", `dupSign_end`="}}}", `_isDebug_`=False, `skipkeys`=False, `ensure_ascii`=True, `check_circular`=True, `allow_nan`=True, `cls`=None, `indent`=None, `separators`=None, `default`=None, `sort_keys`=False)
+_Serialize a JSON object to a JSON format string and write to a file_
+- `Jfilepath`: the path to the file to save the JSON format string
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `_isDebug_`: Show/ Hide debug error messages
+- For remaining arguments, please refer to [json.dump()](https://docs.python.org/3/library/json.html#json.dump)
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
+
+JDKSObject.delete("version")
+JDKSObject.delete("release||$0$")
+JDKSObject.delete("snapshot")
+
+Jfilepath = "/path/to/file.json"
+JDKSObject.dump(Jfilepath)
+
+JDKSObject_load = jdks.load(Jfilepath)
+print(JDKSObject_load.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': 'latest', 'release': []}
+```
+---
+
+### JSON_DUPLICATE_KEYS.flatten(`separator`="||", `parse_index`="$", `ordered_dict`=False, `_isDebug_`=False)
+_Flatten a JSON object to a single key-value pairs_
+- `separator`: 
+- `parse_index`: 
+- `ordered_dict`: preserves the order in which the Keys are inserted
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
+
+JDKSObject.flatten()
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release||$0$||version': 'latest', 'snapshot||author': 'truocphan', 'snapshot||version': '22.3.3', 'snapshot||release||$0$||version': 'latest'}
+```
+---
+
+### JSON_DUPLICATE_KEYS.unflatten(`separator`="||", `parse_index`="$", `ordered_dict`=False, `_isDebug_`=False)
+_Unflatten a flattened JSON object back to a JSON object_
+- `separator`: 
+- `parse_index`: 
+- `ordered_dict`: preserves the order in which the Keys are inserted
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release||$0$||version": "latest", "snapshot||author": "truocphan", "snapshot||version": "22.3.3", "snapshot||release||$0$||version": "latest"}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release||$0$||version': 'latest', 'snapshot||author': 'truocphan', 'snapshot||version': '22.3.3', 'snapshot||release||$0$||version': 'latest'}
+
+JDKSObject.unflatten()
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
+```
+---
+
+## CHANGELOG
+#### [json-duplicate-keys v2024.12.12](https://github.com/truocphan/json-duplicate-keys/tree/2024.12.12)
+- **New**: _insert_ function
+
+#### [json-duplicate-keys v2024.11.28](https://github.com/truocphan/json-duplicate-keys/tree/2024.11.28)
+- **Fixed**: Add subkey name to empty dict of existing key name
+
+#### [json-duplicate-keys v2024.11.19](https://github.com/truocphan/json-duplicate-keys/tree/2024.11.19)
+- **Updated**: Allows getting (`JSON_DUPLICATE_KEYS.get`), setting (`JSON_DUPLICATE_KEYS.set`), updating (`JSON_DUPLICATE_KEYS.update`), deleting (`JSON_DUPLICATE_KEYS.delete`) JSON_DUPLICATE_KEYS objects with case-insensitive key names
+
+#### [json-duplicate-keys v2024.7.17](https://github.com/truocphan/json-duplicate-keys/tree/2024.7.17)
+- **Fixed**: issue [#3](https://github.com/truocphan/json-duplicate-keys/issues/3) break the set function when the key's value is empty. Thanks [ptth222](https://github.com/ptth222) for reporting this issue.
+
+#### [json-duplicate-keys v2024.4.20](https://github.com/truocphan/json-duplicate-keys/tree/2024.4.20)
+- **New**: _filter_values_
+- **Updated**: _filter_keys_
+
+#### [json-duplicate-keys v2024.3.24](https://github.com/truocphan/json-duplicate-keys/tree/2024.3.24)
+- **Updated**: _normalize_key_, _loads_, _get_, _set_, _update_, _delete_
+---

{json-duplicate-keys-2024.11.19 → json_duplicate_keys-2024.12.12}/README.md

@@ -2,12 +2,15 @@
 Flatten/ Unflatten and Load(s)/ Dump(s) JSON File/ Object with Duplicate Keys
 
 <p align="center">
-    <a href="https://github.com/truocphan/json-duplicate-keys/releases/"><img src="https://img.shields.io/github/release/truocphan/json-duplicate-keys" height=30></a>
+	<a href="https://github.com/truocphan/json-duplicate-keys/releases/"><img src="https://img.shields.io/github/release/truocphan/json-duplicate-keys" height=30></a>
 	<a href="#"><img src="https://img.shields.io/github/downloads/truocphan/json-duplicate-keys/total" height=30></a>
 	<a href="#"><img src="https://img.shields.io/github/stars/truocphan/json-duplicate-keys" height=30></a>
 	<a href="#"><img src="https://img.shields.io/github/forks/truocphan/json-duplicate-keys" height=30></a>
 	<a href="https://github.com/truocphan/json-duplicate-keys/issues?q=is%3Aopen+is%3Aissue"><img src="https://img.shields.io/github/issues/truocphan/json-duplicate-keys" height=30></a>
 	<a href="https://github.com/truocphan/json-duplicate-keys/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed/truocphan/json-duplicate-keys" height=30></a>
+	<br>
+	<a href="#"><img src="https://img.shields.io/pypi/v/json-duplicate-keys" height=30></a>
+	<a href="#"><img src="https://img.shields.io/pypi/dm/json-duplicate-keys" height=30></a>
 </p>
 
 ## Installation
@@ -107,13 +110,13 @@ Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "relea
 JDKSObject = jdks.loads(Jstr)
 
 print(JDKSObject.get("version{{{_2_}}}"))
-# OUTPUT: latest
+# OUTPUT: {'name': 'version{{{_2_}}}', 'value': 'latest'}
 
 print(JDKSObject.get("release||$0$"))
-# OUTPUT: {'version': 'latest'}
+# OUTPUT: {'name': 'release||$0$', 'value': {'version': 'latest'}}
 
 print(JDKSObject.get("snapshot||author"))
-# OUTPUT: truocphan
+# OUTPUT: {'name': 'snapshot||author', 'value': 'truocphan'}
 ```
 ---
 
@@ -182,13 +185,46 @@ print(JDKSObject.getObject())
 ```
 ---
 
-### JSON_DUPLICATE_KEYS.update(`name`, `value`, `case_insensitive`=False, `separator`="||", `parse_index`="$", `_isDebug_`=False)
-_Update new `value` for existing `name` in the JSON object_
+### JSON_DUPLICATE_KEYS.insert(`name`, `value`, `position`=None, `case_insensitive`=False, `separator`="||", `parse_index`="$", `dupSign_start`="{{{", `dupSign_end`="}}}", `_isDebug_`=False)
+_Insert `value` at `position` in value list of `name`_
 - `name`: the key name of the JSON object. Supported flatten key name format
 - `value`: new value for key `name`
+- `position`: position of the `value` to insert (default insert at the last position of the list)
 - `case_insensitive`: the key name case (in)sensitive
 - `separator`: 
 - `parse_index`: 
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `_isDebug_`: Show/ Hide debug error messages
+```python
+import json_duplicate_keys as jdks
+
+Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
+
+JDKSObject = jdks.loads(Jstr)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
+
+JDKSObject.insert("release", {'version': '2025.1.1'})
+JDKSObject.insert("snapshot||release", {'version': '2025.1.1'}, 0)
+
+print(JDKSObject.getObject())
+# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}, {'version': '2025.1.1'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': '2025.1.1'}, {'version': 'latest'}]}}
+```
+---
+
+### JSON_DUPLICATE_KEYS.update(`name`, `value`, `case_insensitive`=False, `allow_new_key`=False, `separator`="||", `parse_index`="$", `dupSign_start`="{{{", `dupSign_end`="}}}", `ordered_dict`=False, `_isDebug_`=False)
+_Update new `value` for existing `name` or Set a new `name` in the JSON object_
+- `name`: the key name of the JSON object. Supported flatten key name format
+- `value`: new value for key `name`
+- `case_insensitive`: the key name case (in)sensitive
+- `allow_new_key`: allows to create a new key name if the key name does not exist
+- `separator`: 
+- `parse_index`: 
+- `dupSign_start`: 
+- `dupSign_end`: 
+- `ordered_dict`: preserves the order in which the Keys are inserted
 - `_isDebug_`: Show/ Hide debug error messages
 ```python
 import json_duplicate_keys as jdks
@@ -239,7 +275,7 @@ print(JDKSObject.getObject())
 - `name`:
 - `separator`:
 - `parse_index`:
-- `ordered_dict`:
+- `ordered_dict`: preserves the order in which the Keys are inserted
 ```python
 import json_duplicate_keys as jdks
 
@@ -260,7 +296,7 @@ print(JDKSObject.dumps())
 - `value`:
 - `separator`:
 - `parse_index`:
-- `ordered_dict`:
+- `ordered_dict`: preserves the order in which the Keys are inserted
 ```python
 import json_duplicate_keys as jdks
 
@@ -378,6 +414,12 @@ print(JDKSObject.getObject())
 ---
 
 ## CHANGELOG
+#### [json-duplicate-keys v2024.12.12](https://github.com/truocphan/json-duplicate-keys/tree/2024.12.12)
+- **New**: _insert_ function
+
+#### [json-duplicate-keys v2024.11.28](https://github.com/truocphan/json-duplicate-keys/tree/2024.11.28)
+- **Fixed**: Add subkey name to empty dict of existing key name
+
 #### [json-duplicate-keys v2024.11.19](https://github.com/truocphan/json-duplicate-keys/tree/2024.11.19)
 - **Updated**: Allows getting (`JSON_DUPLICATE_KEYS.get`), setting (`JSON_DUPLICATE_KEYS.set`), updating (`JSON_DUPLICATE_KEYS.update`), deleting (`JSON_DUPLICATE_KEYS.delete`) JSON_DUPLICATE_KEYS objects with case-insensitive key names