JsonPreprocessor 0.12.0

Preprocessor for JSON files with extended syntax

Getting Started

The JsonPreprocessor is a Python 3 package that enables programmers to extend the functionality of JSON files with features such as:

• Adding comments

• Importing other JSON files

• Overwriting existing parameters with new values

The JsonPreprocessor processes these enhanced JSON files and returns a dictionary object containing the deserialized data.

How to install

The JsonPreprocessor can be installed in two different ways.

1. Installation via PyPi (recommended for users)

   pip install JsonPreprocessor

   JsonPreprocessor in PyPi

2. Installation via GitHub (recommended for developers)

   • Clone the JsonPreprocessor repository to your machine.

     git clone https://github.com/test-fullautomation/python-jsonpreprocessor.git

     JsonPreprocessor in GitHub

   • Use the following command to install JsonPreprocessor (executed in repository main folder):

     python -m pip install .

     Or:

     python -m pip install --proxy <proxy> .

     This command will also download and install all dependencies that are required to work with the source files in the current repository. After the initial installation of JsonPreprocessor is done, you have the following two possibilities:

     1. Clean the previous installation:

        python "./cleanup_installation.py"

        cleanup_installation.py explicitly deletes all files and folders within the component installation folder under site-packages and also deletes local build artefacts.

     2. Render the component documentation:

        python "./genpackagedoc.py"

        This would e.g. be required in case of changes in the interface of JsonPreprocessor.

        The documentation is rendered by a separate application called GenPackageDoc, that is part of the build dependencies and runtime dependencies of JsonPreprocessor.

        GenPackageDoc needs to be configured. Details about how to do this, can be found in the README.rst (sections Install dependencies and Configure dependencies).

   • Use the following command to build JsonPreprocessor (executed in repository main folder):

     python -m build .

     Or:

     python -m pip config set global.proxy <proxy>
     python -m build .

Package Documentation

A detailed documentation of the JsonPreprocessor can be found here: JsonPreprocessor.pdf

Feedback

To give us a feedback, you can send an email to Thomas Pollerspöck

In case you want to report a bug or request any interesting feature, please don’t hesitate to raise a ticket.

Maintainers

Thomas Pollerspöck

Contributors

Mai Dinh Nam Son

Tran Duy Ngoan

License

Copyright 2020-2026 Robert Bosch GmbH

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.