From 2bd727a79c8fb5c8d6c2d6cca1821d974a994e7b Mon Sep 17 00:00:00 2001 From: qth2hi Date: Mon, 7 Mar 2022 14:22:18 +0100 Subject: [PATCH] =?UTF-8?q?Maint=C3=A9nance:?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * License text adapted in README.rst * Added README.md * Code maintenance (company name) --- README.md | 82 +++++++++++++++++++ README.rst | 22 ++++- config/CConfig.py | 2 +- config/CExtendedSetup.py | 2 +- doc/CJsonPreprocessor.rst | 2 +- doc/_build/latex/Json-Preprocessor.pdf | Bin 302892 -> 302891 bytes doc/additional_doc/feature_documentation.rst | 2 +- doc/conf.py | 2 +- doc/index.rst | 2 +- setup.py | 2 +- sphinx-makeall.py | 2 +- 11 files changed, 108 insertions(+), 12 deletions(-) create mode 100644 README.md 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 81dbf178..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. @@ -72,7 +72,21 @@ Contributors License ------- -json-preprocessor is open source software provided under the `Apache License -2.0`__. +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| + +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. + + +.. |License: Apache v2| image:: https://img.shields.io/pypi/l/robotframework.svg + :target: http://www.apache.org/licenses/LICENSE-2.0.html -__ http://apache.org/licenses/LICENSE-2.0 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 2af449d26a34f62302fc94b83a28bd66169d1ede..f8387b13b4c0e9cf82ae43f1169adfe6165e8840 100644 GIT binary patch delta 3985 zcmai1YlxI(6n1q)8I4M@3%WEF>$)iU-Y=VMtnMsDR}@9C4JREVH81N{R@6tN2CHsf zs&B36k3S^bP%u-1{NWZN5eh<7poKpS6_uz+k*w!)cHNnC7Frk<&U-oMJkL4Ld%nIS z6ZRgNus=+xGimEzbxlcmTkDE`F@EEf8D%-79k2f~arXK#8^*l-@1Ku9GdDN#*so&`+DTozf4p>O&x>b9F26GU z>T_SVPutske#FeP*ScT6`1QX zx2wBOFPppZgMVJ@?s(+H+PT+HJ~X4V>4opc?S1sw&ErQm^zKppuDfqb|H+vfu1&dq z`S}**KRLU;_drtIyr|r_viscj1sB`zegDwZt>^dkd~xW*^wdu)mVUha&9A<`@%bCg zPwd)sdFtf$bC2J+P=B%T)`&%i=bg=$S1n!F)mbjRlrO(is(-gsUx(jF{6-xr)#n~t zJwppGjTAOa7qU@^#-{wtCs!|RD|M9%)7qMqP)gj|lK!wI*V|+YBKs?>D&({OQbi?) zv1ya0TXT(*$dZaq8lRrpntOPdC80z5U{9|3E*opTsA!}2>AD^qlWZwillEszo-O$x z(uwa4d&)(fF3FY@JLQB+4-CI#wMs{A!>Pbd8ROD<*%HgyYOmAX+mKk`i76A)KeA&y zF&RQSXFHa7Vp8gKCzk45dSZKSNu5pgj$C6xU5BVSmc|+4ONbySi$eG)Ty2)H1wn$r z*$@UWOa{wBh$u7x7B(43fUs%JoJ11{yx8ZAput2>@Jz+dTrP=hrxY^susu&NNM@5+ z+{82PGbCyiqObT(eVV&1iJFFst0SRbp!Hb#QfQ-@LuV*-QhGz~lNpaUZOKrJ3Mo0^ z*r`ZXG9#DZp4l7;Mn!EL;Z`DOZ>xfafA~dqe4`_zW%~k!Q%b26ag2T3hCGmJCPhP< zgpG+Hj#Y$Kkqconp40_wS`u#2Y@X5to0Y@|f;OT;Nm3P!c8YMPqVbj;w&+%xiS_g> z9LE7CRX%K}4G{QC86c?iLLVe^;)EpuqPC){<};%cK-X}b*<@rQ0l!Knw776sl3)O} z(+qyaU`1;QO)4EWxF*S=I^2MdTS|m7lC+(WiDH>3r7X+X0B!2TXjX8_xKMj`G~hBJ zy}vg%F+ra64jozR!abuu!-4^64BrPOsPzx`4xN$tt&#$%tYIag@DkEmR9;ZQM9msQ z*pkXiRyxWnSsnCEDS&a1n!z^$hc&M;uLmEK!F?)9>lxLaC4vBhWBY<&NvR9oF&pZW`*6DAqe==?zyQQ9j1``S9HY3cq0JJ4WvYweD=tU&PevZygHumB^Y1XG`(b3kUJZysz;C)`P3C};ti2{M>GsftV3Sj|AM6-7ZS zOtzK#hNM8FPidv26CFDo*-MT0-W!Ubad`7d&|W(7EF?mDB`nP@;BBnoDHBL*Df|iw zK(m8|O-RZpO*BZr7L-Y9BUH{g+7Zh6fw`fo2+2KdAil_0Zh*9d=)u!~WL znH3$8>0cGB(b-6f23_JEw?#_|Q$@%vMJ9UfSf!OS_kU3xQIp=xTF>vms)DU%qNn$H+QZdcB)C&5C6_)1O z9P~G_una4-CL>Eo4DCZfkdWw?OsGf-#KI7Jr*qf6ciwXbUGC+=?|II1e&_uhI97A; zSk0kuTa_I+etScb?}Npks_N&j{IzXz*NaCst(n`~{=$lu{dJAG!?n5b9d*a2PWtW7 zBT!TG+PPCdU3_Zs)?X%Ee`VZ1rv|s|tg8;!w!d@m{k@a7e^d4CuJg0@UOKkr=lr9Y zWvB1DZu9ghgUdI)vAoNSo&3Wi?bYX=nX#{D&b!m^Sv29qO&ja>JbCZXf!4XnXD2Uw zI56|QA5Sj3@W&Iq1C7sZ?Cf8->CAo0^WUvlJ+0w*CVjq*lE%t3|pEnP`Zzm(b4U~{VQ$*s+03;%!-VH8Z; z^pzc%`iblaqXQGtuXbeSj&h`QOzV0xb8dC2QVT{KeMq}|NesnNur@tWI11v(2S{sP z9#zUklRi*5(n889pALI>7|00Gz>ya zoBQcV8U|p}ope;?(=Yoo4_3JpcV_Ant~x|5eQBIwx|9lvM^Pysm9Mmtu%H+jk`1Bg z!=#iJN=2oaV+n)62ok2XP!dgG?xlOq04EcPVFi{@M#d;EQU*uK+Dq#K2n^^&?k#%H zFwz*JH;`1YQ3OWKS(6GXpF-`Fi%5Z@6cLyqv@Ck*X7z`{|-X7CVf_+p=&;)`rLk0$9&w z>Afg)Bw&MN7^tsu_fumON}RHcAmvs>9!{h#z%hu!y<*t^r5*qf5O{KtFfcOYYNv(! z@hZ3e=NYOdWtdk9qZiA@CB>P9+A$@RM!?GnXt)VW5Yck$&`?0jN{Tv+ri81^H%yER zQaD8JRVyY>_^E3Pilk`Efdb`(ts%$NA9y>B<{tK_(WJj41*UJ19%b7pp+!- zc^3r?R1}0>#WU^R~| ztwq){&rrDlCX69LVl_g8nl~N70v{OY99dFnF*+~y1ghRx>Ko;K4n2yFMU|kV$Vd=N zBL*uQ2YG>q2?Oz~Y&r?8P%iQ~QF?2><59JV&6F5>zUfl7NiWcnY`Gzkny2Rb9Cc_h zfg+7{9y?lAc|}k`SUv{`^N!^aVbPYtzOpz7s6zl>6bRE^u%@0bF|k~dtOuQLdp$Gn ze${MDTlCGUCC-l_hUR(JBGpx}asIrvR@Ibi{NF1pb4^Xz4LzORJ)67p4`ne@PgB{c KQ(G6eW&Z`8@m0G3 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.