Skip to content

Commit

Permalink
updating docs and removing deepdiff6 mention
Browse files Browse the repository at this point in the history
  • Loading branch information
seperman committed Oct 18, 2022
1 parent 11390f0 commit a527965
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 19 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,18 @@ DeepDiff 6-0-0

- [Exclude obj callback strict](https://github.com/seperman/deepdiff/pull/320/files) parameter is added to DeepDiff by Mikhail Khviyuzov [mskhviyu](https://github.com/mskhviyu).
- A fix for diffing using `iterable_compare_func` with nested objects by [dtorres-sf](https://github.com/dtorres-sf) who originally contributed this feature.
- Temporarily we are publishing DeepDiff under `DeepDiff6` on pypi until further notice.

Note: There are no breaking changes in DeepDiff 6 compared to the latest DeepDiff 5 releases.

## Installation

### Install from PyPi:

`pip install deepdiff6`
`pip install deepdiff`

If you want to use DeepDiff from commandline:

`pip install "deepdiff6[cli]"`


> Note: Prior to DeepDiff 6, it was published under DeepDiff name on pypi.
> DeepDiff 6 is being published under DeepDiff6 package name on Pypi temporarily until further notice.
`pip install "deepdiff[cli]"`

### Importing

Expand All @@ -60,7 +54,7 @@ If you want to use DeepDiff from commandline:
>>> from deepdiff import DeepHash # For hashing objects based on their contents
```

Note: if you want to use DeepDiff via commandline, make sure to run `pip install "deepdiff6[cli]"`. Then you can access the commands via:
Note: if you want to use DeepDiff via commandline, make sure to run `pip install "deepdiff[cli]"`. Then you can access the commands via:

- DeepDiff
- `$ deep diff --help`
Expand Down
13 changes: 3 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ DeepDiff 6-0-0
- A fix for diffing using ``iterable_compare_func`` with nested objects
by `dtorres-sf <https://github.com/dtorres-sf>`__ who originally
contributed this feature.
- Temporarily we are publishing DeepDiff under ``DeepDiff6`` on pypi
until further notice.

Note: There are no breaking changes in DeepDiff 6 compared to the latest DeepDiff 5 releases.

Expand All @@ -72,19 +70,14 @@ Installation

Install from PyPi::

pip install deepdiff6
pip install deepdiff

If you want to use DeepDiff from commandline::

pip install "deepdiff6[cli]"
pip install "deepdiff[cli]"

Read about DeepDiff optimizations at :ref:`optimizations_label`

.. note:: Prior to DeepDiff 6, it was published under DeepDiff name on pypi.

DeepDiff 6 is being published under DeepDiff6 package name on Pypi temporarily until further notice.


Importing
~~~~~~~~~

Expand All @@ -98,7 +91,7 @@ Importing
.. note:: if you want to use DeepDiff via commandline, make sure to run::
pip install "deepdiff6[cli]"
pip install "deepdiff[cli]"

Then you can access the commands via:

Expand Down

0 comments on commit a527965

Please sign in to comment.