json-duplicate-keys 2023.11.26__tar.gz → 2024.2.3__tar.gz

json-duplicate-keys-2024.2.3/PKG-INFO

@@ -0,0 +1,352 @@
+Metadata-Version: 2.1
+Name: json-duplicate-keys
+Version: 2024.2.3
+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
+Description: # JSON Duplicate Keys
+        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>
+        	<a href="https://pypi.org/project/json-duplicate-keys/" target="_blank"><img src="https://img.shields.io/badge/pypi-3775A9?style=for-the-badge&logo=pypi&logoColor=white" height=30></a>
+        	<a href="https://www.facebook.com/61550595106970" target="_blank"><img src="https://img.shields.io/badge/Facebook-1877F2?style=for-the-badge&logo=facebook&logoColor=white" height=30></a>
+        	<a href="https://twitter.com/TPCyberSec" target="_blank"><img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" height=30></a>
+        	<a href="https://github.com/truocphan" target="_blank"><img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white" height=30></a>
+        	<a href="mailto:tpcybersec2023@gmail.com" target="_blank"><img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white" height=30></a>
+        	<a href="https://www.buymeacoffee.com/truocphan" target="_blank"><img src="https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black" 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`, `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
+        - `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: latest
+        
+        print(JDKSObject.get("release||$0$"))
+        # OUTPUT: {'version': 'latest'}
+        
+        print(JDKSObject.get("snapshot||author"))
+        # OUTPUT: truocphan
+        ```
+        ---
+        
+        ### JSON_DUPLICATE_KEYS.set(`name`, `value`, `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`
+        - `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.update(`name`, `value`, `separator`="||", `parse_index`="$", `_isDebug_`=False)
+        _Update new `value` for existing `name` in the JSON object_
+        - `name`: the key name of the JSON object. Supported flatten key name format
+        - `value`: new value for key `name`
+        - `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.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`, `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
+        - `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.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'}]}}
+        ```
+        ---
+Keywords: json,duplicate keys,json duplicate keys,flatten,unflatten
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: Implementation :: Jython
+Description-Content-Type: text/markdown

{json-duplicate-keys-2023.11.26 → json-duplicate-keys-2024.2.3}/setup.py

@@ -1,12 +1,11 @@
 import setuptools
-import datetime
 
 setuptools.setup(
 	name="json-duplicate-keys",
-	version=datetime.datetime.now().strftime("%Y.%m.%d"),
-	author="Truoc Phan",
+	version="2024.2.3",
+	author="TP Cyber Security",
 	license="MIT",
-	author_email="truocphan112017@gmail.com",
+	author_email="tpcybersec2023@gmail.com",
 	description="Flatten/ Unflatten and Load(s)/ Dump(s) JSON File/ Object with Duplicate Keys",
 	long_description=open("README.md").read(),
 	long_description_content_type="text/markdown",

json-duplicate-keys-2023.11.26/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Truoc Phan
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

json-duplicate-keys-2023.11.26/MANIFEST.in

@@ -1 +0,0 @@
-include requirements.txt