diff --git a/README.md b/README.md index 6fbe9259..9222d319 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,19 @@ ## Getting Started -The JsonPreprocessor is a Python3 package which allows programmers to -handle additional features in json files such as +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. +These JSON files will be handled by the **JsonPreprocessor** which +returns as result a dictionary object of the deserialized data. ## How to install -**JsonPreprocessor** can be installed in two different ways. +The **JsonPreprocessor** can be installed in two different ways. 1. Installation via PyPi (recommended for users) @@ -27,14 +27,51 @@ as result a dictionary object of the deserialized data. 2. Installation via GitHub (recommended for developers) - Clone the **JsonPreprocessor** repository to your machine. + - Clone the **JsonPreprocessor** repository to your machine. - ``` - git clone https://github.com/test-fullautomation/python-jsonpreprocessor.git - ``` + ``` + git clone https://github.com/test-fullautomation/python-jsonpreprocessor.git + ``` - [JsonPreprocessor in - GitHub](https://github.com/test-fullautomation/python-jsonpreprocessor) + [JsonPreprocessor in + GitHub](https://github.com/test-fullautomation/python-jsonpreprocessor) + + - Install dependencies + + **JsonPreprocessor** requires some additional Python libraries. + Before you install the cloned repository sources you have to + install the dependencies manually. The names of all related + packages you can find in the file `requirements.txt` in the + repository root folder. Use pip to install them: + + ``` + pip install -r requirements.txt + ``` + + Additionally install **LaTeX** (recommended: TeX Live). This is + used to render the documentation. + + - Configure dependencies + + The installation of **JsonPreprocessor** includes to generate + the documentation in PDF format. This is done by an application + called **GenPackageDoc**, that is part of the installation + dependencies (see `requirements.txt`). + + **GenPackageDoc** uses **LaTeX** to generate the documentation + in PDF format. Therefore **GenPackageDoc** needs to know where + to find **LaTeX**. This is defined in the **GenPackageDoc** + configuration file + + ``` + packagedoc\packagedoc_config.json + ``` + + Before you start the installation you have to introduce the + following environment variable, that is used in + `packagedoc_config.json`: + + - `GENDOC_LATEXPATH` : path to `pdflatex` executable Use the following command to install **JsonPreprocessor**: diff --git a/README.rst b/README.rst index 059d94b5..6b38b7af 100644 --- a/README.rst +++ b/README.rst @@ -18,20 +18,20 @@ 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 +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 +These JSON files will be handled by the **JsonPreprocessor** which returns as result a dictionary object of the deserialized data. How to install -------------- -**JsonPreprocessor** can be installed in two different ways. +The **JsonPreprocessor** can be installed in two different ways. 1. Installation via PyPi (recommended for users) @@ -43,13 +43,41 @@ How to install 2. Installation via GitHub (recommended for developers) - Clone the **JsonPreprocessor** repository to your machine. + * Clone the **JsonPreprocessor** repository to your machine. - .. code:: + .. code:: + + git clone https://github.com/test-fullautomation/python-jsonpreprocessor.git + + `JsonPreprocessor in GitHub `_ + + * Install dependencies + + **JsonPreprocessor** requires some additional Python libraries. Before you install the cloned repository sources + you have to install the dependencies manually. The names of all related packages you can find in the file ``requirements.txt`` + in the repository root folder. Use pip to install them: + + .. code:: + + pip install -r requirements.txt - git clone https://github.com/test-fullautomation/python-jsonpreprocessor.git + Additionally install **LaTeX** (recommended: TeX Live). This is used to render the documentation. - `JsonPreprocessor in GitHub `_ + * Configure dependencies + + The installation of **JsonPreprocessor** includes to generate the documentation in PDF format. This is done by + an application called **GenPackageDoc**, that is part of the installation dependencies (see ``requirements.txt``). + + **GenPackageDoc** uses **LaTeX** to generate the documentation in PDF format. Therefore **GenPackageDoc** needs to know where to find + **LaTeX**. This is defined in the **GenPackageDoc** configuration file + + .. code:: + + packagedoc\packagedoc_config.json + + Before you start the installation you have to introduce the following environment variable, that is used in ``packagedoc_config.json``: + + - ``GENDOC_LATEXPATH`` : path to ``pdflatex`` executable Use the following command to install **JsonPreprocessor**: @@ -57,6 +85,7 @@ How to install setup.py install + Package Documentation --------------------- diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..c6917d34 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +colorama +pypandoc +GenPackageDoc +PythonExtensionsCollection