/json-maestro

JSONMaestro is a powerful tool designed for cleaning and processing JSON-like files. It simplifies tasks such as removing comments, eliminating duplicate keys, adding schema keys, and sorting keys. Ideal for developers working with configuration files and API responses, JSONMaestro enhances data integrity and prepares JSON data for further analysis

Primary LanguagePythonMIT LicenseMIT

JSONMaestro

Python Pylance Pytest License Version

JSONMaestro is a powerful Python tool designed to clean, process, and optimize JSON-like files. It handles various operations such as removing comments, eliminating duplicates, adding schema keys, and sorting keys. This utility is particularly useful for developers working with configuration files, API responses, or any JSON-structured data that needs refinement.

Key features:

  • Supports JSON, JSONC, and VSCode settings.json files
  • Removes duplicate keys and comments
  • Adds schema keys for improved structure
  • Offers flexible key sorting options
  • Preserves data integrity while cleaning

JSONMaestro streamlines the process of preparing JSON data for further analysis or integration, making it an essential tool for data preprocessing and configuration management tasks.

Getting Started

From Source

  1. Clone the repository
git clone https://github.com/gbowne1/json-maestro.git # via https
git clone git@github.com:gbowne1/json-maestro.git # via ssh
  1. navigate to the cloned repository
cd /path/to/cloned/json-maestro
  1. install requirements
pip install -r requirements.txt
pip install -r dev.requirements
pip install --upgrade build
  1. build json maestro
python3 -m build
  1. install json maestro using your prefered method (NOTE: both are shown here, either one should work)
pip install .

Contributing

See CONTRIBUTING.md

If you would like to work on issues and new features, we welcome your issues and Pull Requests.

License

MIT

See the License