# Democritus JSON
[](https://pypi.python.org/pypi/d8s-json)
[](https://github.com/democritus-project/d8s-json/actions)
[](https://github.com/democritus-project/d8s-json/actions)
[](https://codecov.io/gh/democritus-project/d8s-json)
[](https://semver.org/spec/v2.0.0.html)
[](https://github.com/psf/black)
[](https://choosealicense.com/licenses/lgpl-3.0/)
Democritus functions<sup>[1]</sup> for working with JSON.
[1] Democritus functions are <i>simple, effective, modular, well-tested, and well-documented</i> Python functions.
We use `d8s` (pronounced "dee-eights") as an abbreviation for `democritus` (you can read more about this [here](https://github.com/democritus-project/roadmap#what-is-d8s)).
## Installation
```
pip install d8s-json
```
## Usage
You import the library like:
```python
from d8s_json import *
```
Once imported, you can use any of the functions listed below.
## Functions
- ```python
def json_files(directory_path: str) -> List[str]:
"""Find all json files in the given directory_path."""
```
- ```python
def json_read(json_string: str):
"""."""
```
- ```python
def json_read_first_arg_string_decorator(func):
"""Load the first argument as JSON (if it is a string)."""
```
- ```python
def json_write(file_path, json_content, **kwargs):
"""Write the json_content to the file_path."""
```
- ```python
def json_prettify(json_object):
"""."""
```
- ```python
def json_pretty_print(json_string):
"""Pretty print the json so it is readable."""
```
- ```python
def json_search(json_data, value_to_find):
"""Find the value_to_find in the json_data."""
```
- ```python
def json_structure(json_data):
"""Print out the structure of the given json blob."""
```
- ```python
def json_path_dot_notation_to_bracket_notation(json_path_dot_notation: str) -> str:
"""Convert the given json path from dot notation to bracket notation (foo.bar -> ["foo"]["bar"])."""
```
- ```python
def json_path_bracket_notation_to_dot_notation(json_path_dot_notation: str) -> str:
"""Convert the given json path from bracket notation to dot notation (["foo"]["bar"] -> foo.bar)."""
```
## Development
👋 If you want to get involved in this project, we have some short, helpful guides below:
- [contribute to this project 🥇][contributing]
- [test it 🧪][local-dev]
- [lint it 🧹][local-dev]
- [explore it 🔭][local-dev]
If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.
## Credits
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and Floyd Hightower's [Python project template](https://github.com/fhightower-templates/python-project-template).
[contributing]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#contributing-a-pr-
[local-dev]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#local-development-
Raw data
{
"_id": null,
"home_page": "https://github.com/democritus-project/d8s-json",
"name": "d8s-json",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "democritus,utility,python,json,json-utility,json",
"author": "Floyd Hightower",
"author_email": "floyd.hightower27@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ec/95/5d0ab1d228419d792cc52be5d66b6add88ed6e09d4c34c51b4dbe9a283ec/d8s_json-0.3.0.tar.gz",
"platform": "",
"description": "# Democritus JSON\n\n[](https://pypi.python.org/pypi/d8s-json)\n[](https://github.com/democritus-project/d8s-json/actions)\n[](https://github.com/democritus-project/d8s-json/actions)\n[](https://codecov.io/gh/democritus-project/d8s-json)\n[](https://semver.org/spec/v2.0.0.html)\n[](https://github.com/psf/black)\n[](https://choosealicense.com/licenses/lgpl-3.0/)\n\nDemocritus functions<sup>[1]</sup> for working with JSON.\n\n[1] Democritus functions are <i>simple, effective, modular, well-tested, and well-documented</i> Python functions.\n\nWe use `d8s` (pronounced \"dee-eights\") as an abbreviation for `democritus` (you can read more about this [here](https://github.com/democritus-project/roadmap#what-is-d8s)).\n\n## Installation\n\n```\npip install d8s-json\n```\n\n## Usage\n\nYou import the library like:\n\n```python\nfrom d8s_json import *\n```\n\nOnce imported, you can use any of the functions listed below.\n\n## Functions\n\n - ```python\n def json_files(directory_path: str) -> List[str]:\n \"\"\"Find all json files in the given directory_path.\"\"\"\n ```\n - ```python\n def json_read(json_string: str):\n \"\"\".\"\"\"\n ```\n - ```python\n def json_read_first_arg_string_decorator(func):\n \"\"\"Load the first argument as JSON (if it is a string).\"\"\"\n ```\n - ```python\n def json_write(file_path, json_content, **kwargs):\n \"\"\"Write the json_content to the file_path.\"\"\"\n ```\n - ```python\n def json_prettify(json_object):\n \"\"\".\"\"\"\n ```\n - ```python\n def json_pretty_print(json_string):\n \"\"\"Pretty print the json so it is readable.\"\"\"\n ```\n - ```python\n def json_search(json_data, value_to_find):\n \"\"\"Find the value_to_find in the json_data.\"\"\"\n ```\n - ```python\n def json_structure(json_data):\n \"\"\"Print out the structure of the given json blob.\"\"\"\n ```\n - ```python\n def json_path_dot_notation_to_bracket_notation(json_path_dot_notation: str) -> str:\n \"\"\"Convert the given json path from dot notation to bracket notation (foo.bar -> [\"foo\"][\"bar\"]).\"\"\"\n ```\n - ```python\n def json_path_bracket_notation_to_dot_notation(json_path_dot_notation: str) -> str:\n \"\"\"Convert the given json path from bracket notation to dot notation ([\"foo\"][\"bar\"] -> foo.bar).\"\"\"\n ```\n\n## Development\n\n\ud83d\udc4b If you want to get involved in this project, we have some short, helpful guides below:\n\n- [contribute to this project \ud83e\udd47][contributing]\n- [test it \ud83e\uddea][local-dev]\n- [lint it \ud83e\uddf9][local-dev]\n- [explore it \ud83d\udd2d][local-dev]\n\nIf you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.\n\n## Credits\n\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and Floyd Hightower's [Python project template](https://github.com/fhightower-templates/python-project-template).\n\n[contributing]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#contributing-a-pr-\n[local-dev]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#local-development-\n\n\n",
"bugtrack_url": null,
"license": "GNU Lesser General Public License v3",
"summary": "Democritus functions for working with JSON.",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/democritus-project/d8s-json"
},
"split_keywords": [
"democritus",
"utility",
"python",
"json",
"json-utility",
"json"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c0965be3e35f65c988261b9592c221842362277415ed8974e4e5b4fbced4a0ea",
"md5": "92d8f24a61286d2c7b77492dd602e27c",
"sha256": "aa31f14a148f564db2cac344c527de2dc57fe0f49a1e1b8edd9a50fcef9fa8b5"
},
"downloads": -1,
"filename": "d8s_json-0.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "92d8f24a61286d2c7b77492dd602e27c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 22322,
"upload_time": "2021-05-07T10:48:53",
"upload_time_iso_8601": "2021-05-07T10:48:53.410432Z",
"url": "https://files.pythonhosted.org/packages/c0/96/5be3e35f65c988261b9592c221842362277415ed8974e4e5b4fbced4a0ea/d8s_json-0.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec955d0ab1d228419d792cc52be5d66b6add88ed6e09d4c34c51b4dbe9a283ec",
"md5": "cfb495b2a0a025e81ba68d933a7c3bb2",
"sha256": "d27ef5efdc3e081894d6c83560882b5e1d1e1eb932766287bf0cd98e273178ea"
},
"downloads": -1,
"filename": "d8s_json-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "cfb495b2a0a025e81ba68d933a7c3bb2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26543,
"upload_time": "2021-05-07T10:48:55",
"upload_time_iso_8601": "2021-05-07T10:48:55.437965Z",
"url": "https://files.pythonhosted.org/packages/ec/95/5d0ab1d228419d792cc52be5d66b6add88ed6e09d4c34c51b4dbe9a283ec/d8s_json-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-05-07 10:48:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "democritus-project",
"github_project": "d8s-json",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "d8s-json"
}
JSON
