JSON File Helper

A Python class that makes working with JSON files simpler. It provides an easy way to read, write, add to, and check JSON files, along with some extra helpful methods and features.

Features

• Read JSON files with automatic file validation.
• Write JSON data as dictionaries or lists of dictionaries.
• Append data to existing JSON files.
• Clear JSON files.
• Validate JSON schema using the jsonschema library.
• Access properties like data (alias for read), keys, values, length, is_empty, size, and exists.
• Pretty print data.

Installation

Automatic installation via PyPi

pip install json_file_helper

Or manual installation

git clone https://github.com/TheBiemGamer/Json-File-Helper.git
cd json-helper

Install Dependencies

Install the requirements with pip or with poetry:

Pip:

pip install -r requirements.txt

Or with Poetry:

poetry install

Usage

Importing the Module

from json_file_helper import json_file

Creating an Instance

from json_file_helper import json_file

# Initialize with an optional file path
jf = json_file("example.json")

Methods and Properties

1. Reading a JSON File

data = jf.read()
print(data)

Or with the data property:

data = jf.data
print(data)

2. Writing Data

jf.write({"name": "John", "age": 30})

3. Appending Data

Append a dictionary to a JSON dictionary or list:

jf.append({"city": "New York"})

4. Clearing a File

jf.clear()

5. Validating Schema

Use a JSON schema to validate the structure of your file:

schema = {
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "age": {"type": "integer"}
    },
    "required": ["name", "age"]
}
is_valid = jf.validate_schema(schema)
print(f"Is valid: {is_valid}")

6. Pretty Print

jf.pretty_print()

7. Accessing Properties

print(jf.keys)      # List of keys in the JSON (if it's a dictionary)
print(jf.values)    # List of values
print(jf.length)    # Number of items (for dicts or lists)
print(jf.is_empty)  # Check if the file is empty
print(jf.size)      # File size in bytes
print(jf.exists)    # Check if the file exists

Using as a Context Manager

The json_file class can also be used with with statements:

with json_file("example.json") as jf:
    data = jf.read()
    jf.append({"new_key": "new_value"})

Requirements

• Python 3.8+
• jsonschema library for schema validation

Example

Here’s a complete example:

from json_file_helper import json_file

# Initialize with a file path
jf = json_file("example.json")

# Write data to the file
jf.write({"name": "Alice", "age": 25})

# Read the file
print(jf.data)

# Append new data
jf.append({"city": "London"})

# Validate schema
schema = {
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "age": {"type": "integer"},
        "city": {"type": "string"}
    },
    "required": ["name", "age"]
}
print(jf.validate_schema(schema))

# Pretty print the file's content
jf.pretty_print()

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

TheBiemGamer (biemgamer@pm.me)