diff --git a/README.md b/README.md new file mode 100644 index 00000000..63f1711e --- /dev/null +++ b/README.md @@ -0,0 +1,82 @@ +> 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. + +# Json Preprocessor\'s Package Description + +## Getting Started + +The JsonPreprocessor is a Python3 package which allows programmers to +handle additional features in json files such as + +- add comments +- import other json files +- overwrite already existing parameters with new values + +These json files will be handled by the JsonPreprocessor which returns +as result a dictionary object of the deserialized data. + +## How to install + +Firstly, clone **python-jsonpreprocessor** repository to your machine. + +Then go to python-jsonpreprocessor, using the 2 common commands below to +build or install this package: + +``` +setup.py build will build the package underneath 'build/' +setup.py install will install the package +``` + +After the build processes is completed, the package is located in +\'build/\', and the generated package documentation is located in +\'doc/\_build/\'. + +## Package Documentation + +A detailed documentation of the Json Preprocessor\'s package can be +found here: +[Json-Preprocessor.pdf](https://github.com/test-fullautomation/python-jsonpreprocessor/blob/develop/doc/_build/latex/Json-Preprocessor.pdf) + +## Feedback + +To give us a feedback, you can send an email to [Thomas +Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com) + +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](mailto:Thomas.Pollerspoeck@de.bosch.com) + +## Contributors + +[Mai Dinh Nam Son](mailto:son.maidinhnam@vn.bosch.com) + +[Tran Duy Ngoan](mailto:Ngoan.TranDuy@vn.bosch.com) + +## License + +Copyright 2020-2022 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 + +> [![License: Apache +> v2](https://img.shields.io/pypi/l/robotframework.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) + +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. diff --git a/README.rst b/README.rst index 7135e02c..3527fa21 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +.. Copyright 2020-2022 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. diff --git a/config/CConfig.py b/config/CConfig.py index d7ddb691..19b5e276 100644 --- a/config/CConfig.py +++ b/config/CConfig.py @@ -1,6 +1,6 @@ # ************************************************************************************************************** # -# Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +# Copyright 2020-2022 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. diff --git a/config/CExtendedSetup.py b/config/CExtendedSetup.py index 541501a5..1c1a7867 100644 --- a/config/CExtendedSetup.py +++ b/config/CExtendedSetup.py @@ -1,6 +1,6 @@ # ************************************************************************************************************** # -# Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +# Copyright 2020-2022 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. diff --git a/doc/CJsonPreprocessor.rst b/doc/CJsonPreprocessor.rst index 63f2fb1a..4e7a9e8a 100644 --- a/doc/CJsonPreprocessor.rst +++ b/doc/CJsonPreprocessor.rst @@ -1,4 +1,4 @@ -.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +.. Copyright 2020-2022 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. diff --git a/doc/_build/latex/Json-Preprocessor.pdf b/doc/_build/latex/Json-Preprocessor.pdf index 2af449d2..f8387b13 100644 Binary files a/doc/_build/latex/Json-Preprocessor.pdf and b/doc/_build/latex/Json-Preprocessor.pdf differ diff --git a/doc/additional_doc/feature_documentation.rst b/doc/additional_doc/feature_documentation.rst index 36a3eacd..7651ae7a 100644 --- a/doc/additional_doc/feature_documentation.rst +++ b/doc/additional_doc/feature_documentation.rst @@ -1,4 +1,4 @@ -.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +.. Copyright 2020-2022 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. diff --git a/doc/conf.py b/doc/conf.py index 75c607a6..958d6ab7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,4 +1,4 @@ -# Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +# Copyright 2020-2022 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. diff --git a/doc/index.rst b/doc/index.rst index e847ced9..0f60b070 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,4 +1,4 @@ -.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +.. Copyright 2020-2022 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. diff --git a/setup.py b/setup.py index 93532637..22358c59 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,6 @@ # ************************************************************************************************************** # -# Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +# Copyright 2020-2022 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. diff --git a/sphinx-makeall.py b/sphinx-makeall.py index c995a7e9..8b5d87d8 100644 --- a/sphinx-makeall.py +++ b/sphinx-makeall.py @@ -1,6 +1,6 @@ # ************************************************************************************************************** # -# Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +# Copyright 2020-2022 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.