json-scout 0.1.0

Scout JSON structure and navigate data safely with intuitive exploration tools.

JSON Scout

Scout JSON structure and navigate data safely with intuitive exploration tools.

JSON Scout provides a robust suite of tools designed for developers and data professionals who need to introspect, analyze, and safely navigate complex JSON data structures. Whether you're working with APIs, configuration files, or large datasets, JSON Scout offers both low-level utilities and high-level abstractions to make JSON exploration intuitive and error-free.

✨ Key Features

• 🔍 Structural Analysis: Automatic schema discovery and hierarchy inspection
• 🛡️ Safe Navigation: Exception-free access with monadic-style Maybe wrapper
• 🔧 Comprehensive Utilities: File operations, XML integration, and unified interface
• 📊 Enterprise Ready: Type safety, performance optimization, and comprehensive documentation

🚀 Quick Start

Installation

pip install json-scout

Basic Usage

import jsonscout as js

# Sample data
data = {
    "users": [
        {"name": "Alice", "age": 30, "email": "[e-mail]"},
        {"name": "Bob", "age": 25},
        {"name": "Charlie", "age": 35, "email": "[e-mail]"}
    ],
    "metadata": {"version": "1.0", "created": "2024-01-01"}
}

# Safe navigation with automatic error handling
explorer = js.Xplore(data)
user_name = explorer['users'][0]['name'].value()  # Returns: "Alice"
missing_field = explorer['users'][1]['email'].value()  # Returns: None (no exception)

# Structural analysis
explore = js.Explore(data['users'])
field_frequency = explore.field_counts()
print(field_frequency)  # {'name': 3, 'age': 3, 'email': 2}

# File operations
json_files = js.get_json_file_paths('/path/to/data', '*.json')
for file_path in json_files:
    data = js.read_json_file(file_path)
    explorer = js.Xplore(data)
    # Process safely...

📚 Documentation

• Complete Documentation: Comprehensive guides and examples
• API Reference: Detailed API documentation with examples

🏗️ Core Components

• Explore: Lightweight structural analysis and schema discovery
• Maybe: Monadic wrapper for safe, chainable data access
• SimpleXML: Efficient XML-to-dictionary conversion utilities
• Xplore: Unified facade combining all functionality

🎯 Use Cases

• API Response Analysis: Schema evolution tracking and data validation
• Configuration Management: Safe navigation of complex configuration hierarchies
• Data Pipeline Processing: ETL operations with robust error handling
• Research and Analysis: Dataset exploration and statistical analysis

🤝 Contributing

We welcome contributions! Please see our contributing guidelines for details on how to submit bug reports, feature requests, and code contributions.

📄 License

JSON Scout is licensed under the Apache License 2.0.
© 2025 Chathura Jayalath. See the NOTICE file for more details.