JsonCrack 📊

JsonCrack is a Python package that visualizes JSON as a vertical graph to help developers understand complex JSON structures easily Supporting drf-spectacular Schema.

---

🚀 Features

💚 Convert JavaScript-style JSON (null, true, false) → Python (None, True, False)
💚 Generate vertical graph visualization of JSON data
💚 Automatically detects OS to display the graph (Windows, Mac, Linux)
💚 No need for a web interface—runs locally
💚 Support drf-spectacular—Visualize Django Rest Framework Documentation Example Responses

---

📚 Installation

1. Install Graphviz (required for rendering graphs):

   • Windows: Download and install from Graphviz website
   • Mac:

     brew install graphviz
     

   • Linux (Debian/Ubuntu):

     sudo apt install graphviz
     

2. Install JsonCrack:

   pip install JsonCrack
   

---

🔥 Quick Start

data is in java script style

1⃣ Convert JavaScript-style JSON to Python

from JsonCrack.Cracker import JSON

data = '''
{
    "name": "Alice",
    "active": true,
    "address": null
}
'''

# Convert JS JSON to Python format
json_obj = JSON(data)
python_json = json_obj.convert_js_to_python()
print(python_json)

🟢 Output:

{'name': 'Alice', 'active': True, 'address': None}

---

2⃣ Visualize JSON Data

json_obj.visualize(display=True, output_file="visualize_output",)

📌 This will open a PNG file with name visualize_output displaying the JSON structure as a vertical graph.
🟢 Output:

3⃣ Convert & Visualize in One Step with display(default)

from JsonCrack.Cracker import JSON
data =  [{
    "name": "Alice",
    "active": True,
    "address": None
},
    {
        "name": "Salma",
    "active": False,
    "address": "New York"
    }
    ]
json_obj = JSON(data)
json_obj.visualize()

🟢 Output:

3⃣ Convert & save Visualize in One Step without display

from JsonCrack.Cracker import JSON
data = {
    "name": "Alice",
    "active": True,
    "address": None
}
json_obj = JSON(data)
json_obj.visualize(display=False)

3⃣ Integration With Django

#add this to Django settings.py
REST_FRAMEWORK={'DEFAULT_SCHEMA_CLASS': 'JsonCrack.AutoSchema'}

🟢 Example Results: http://localhost:8000/media/xhvo+f6^l-\IIXVAMJC1J.png http://localhost:8000/media/xhvo+f6^l-\HM2VFKK0VN.png http://localhost:8000/media/xhvo+f6^l-\2WB4HC5DAU.png

🛠 Development

1. Clone the repository:

   git clone https://github.com/MahmoudGShake/JsonCrack.git
   cd JsonCrack
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Install package in editable mode:

   pip install -e .
   

---

👥 Contributing

We welcome contributions! 🎉

1. Fork the repository
2. Create a new branch (git checkout -b feature-branch)
3. Make your changes
4. Commit and push (git commit -m "Added new feature" && git push origin feature-branch)
5. Create a pull request

---

🐝 License

MIT License - Free to use and modify. See LICENSE for details.

---

💡 Future Improvements

🚧 Planned features:

• Interactive web-based visualization
• More export formats (SVG, PDF, JSON Tree)
• Better error handling for invalid JSON

---

🌟 Show Your Support

🌟 Star this repository on GitHub if you find it useful!
💬 Feel free to open issues for bug reports & feature requests.

---

Happy Coding! 🚀