Skip to content

Democritus functions for working with JSON.

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
COPYING
Notifications You must be signed in to change notification settings

democritus-project/d8s-json

Repository files navigation

Democritus JSON

PyPI CI Lint codecov The Democritus Project uses semver version 2.0.0 The Democritus Project uses black to format code License: LGPL v3

Democritus functions[1] for working with JSON.

[1] Democritus functions are simple, effective, modular, well-tested, and well-documented Python functions.

We use d8s (pronounced "dee-eights") as an abbreviation for democritus (you can read more about this here).

Installation

pip install d8s-json

Usage

You import the library like:

from d8s_json import *

Once imported, you can use any of the functions listed below.

Functions

  • def json_files(directory_path: str) -> List[str]:
        """Find all json files in the given directory_path."""
  • def json_read(json_string: str):
        """."""
  • def json_read_first_arg_string_decorator(func):
        """Load the first argument as JSON (if it is a string)."""
  • def json_write(file_path, json_content, **kwargs):
        """Write the json_content to the file_path."""
  • def json_prettify(json_object):
        """."""
  • def json_pretty_print(json_string):
        """Pretty print the json so it is readable."""
  • def json_search(json_data, value_to_find):
        """Find the value_to_find in the json_data."""
  • def json_structure(json_data):
        """Print out the structure of the given json blob."""
  • 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"])."""
  • 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:

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 and Floyd Hightower's Python project template.

About

Democritus functions for working with JSON.

Topics

Resources

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
COPYING

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published