Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified JsonPreprocessor/JsonPreprocessor.pdf
Binary file not shown.
34 changes: 24 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,33 @@ as result a dictionary object of the deserialized data.

## How to install

Firstly, clone **python-jsonpreprocessor** repository to your machine.
**JsonPreprocessor** can be installed in two different ways.

Then go to python-jsonpreprocessor, using the 2 common commands below to
build or install this package:
1. Installation via PyPi (recommended for users)

```
setup.py build will build the package underneath 'build/'
setup.py install will install the package
```
```
pip install JsonPreprocessor
```

After the build processes is completed, the package is located in
\'build/\', and the generated package documentation is located in
\'doc/\_build/\'.
[JsonPreprocessor in
PyPi](https://pypi.org/project/JsonPreprocessor/)

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](https://github.com/test-fullautomation/python-jsonpreprocessor)

Use the following command to install **JsonPreprocessor**:

```
setup.py install
```

## Package Documentation

Expand Down
27 changes: 20 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,31 @@ a dictionary object of the deserialized data.
How to install
--------------

Firstly, clone **python-jsonpreprocessor** repository to your machine.
**JsonPreprocessor** can be installed in two different ways.

Then go to python-jsonpreprocessor, using the 2 common commands below to build or install this package:
1. Installation via PyPi (recommended for users)

.. code::
.. code::

setup.py build will build the package underneath 'build/'
setup.py install will install the package
pip install JsonPreprocessor

After the build processes is completed, the package is located in 'build/', and the generated
package documentation is located in 'doc/_build/'.
`JsonPreprocessor in PyPi <https://pypi.org/project/JsonPreprocessor/>`_

2. Installation via GitHub (recommended for developers)

Clone the **JsonPreprocessor** repository to your machine.

.. code::

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

`JsonPreprocessor in GitHub <https://github.com/test-fullautomation/python-jsonpreprocessor>`_

Use the following command to install **JsonPreprocessor**:

.. code::

setup.py install

Package Documentation
---------------------
Expand Down
32 changes: 0 additions & 32 deletions doc/CJsonPreprocessor.rst

This file was deleted.

4 changes: 0 additions & 4 deletions doc/_build/html/.buildinfo

This file was deleted.

183 changes: 0 additions & 183 deletions doc/_build/html/CJsonPreprocessor.html

This file was deleted.

Binary file removed doc/_build/html/_images/python3-jsonpreprocessor.png
Binary file not shown.
Loading