Skip to content

Commit b9f625a

Browse files
committed
adding install instructions
1 parent 51c4711 commit b9f625a

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@ DeepDiff 5-8-0 includes bug fixes and improvements:
4141

4242
### Install from PyPi:
4343

44-
`pip install deepdiff`
44+
`pip install deepdiff6`
4545

4646
If you want to use DeepDiff from commandline:
4747

48-
`pip install "deepdiff[cli]"`
48+
`pip install "deepdiff6[cli]"`
49+
50+
> Note: prior to DeepDiff 6, we used `pip install deepdiff` to install DeepDiff. DeepDiff 6 is being published with a different package name on Pypi temporarily until further notice.
4951
5052
### Importing
5153

@@ -55,7 +57,7 @@ If you want to use DeepDiff from commandline:
5557
>>> from deepdiff import DeepHash # For hashing objects based on their contents
5658
```
5759

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

6062
- DeepDiff
6163
- `$ deep diff --help`

docs/index.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,17 @@ Installation
7575

7676
Install from PyPi::
7777

78-
pip install deepdiff
78+
pip install deepdiff6
7979

8080
If you want to use DeepDiff from commandline::
8181

82-
pip install "deepdiff[cli]"
82+
pip install "deepdiff6[cli]"
8383

8484
Read about DeepDiff optimizations at :ref:`optimizations_label`
8585

86+
Note: prior to DeepDiff 6, we used pip install deepdiff to install DeepDiff::
87+
DeepDiff 6 is being published with a different package name on Pypi temporarily until further notice.
88+
8689

8790
Importing
8891
~~~~~~~~~
@@ -97,7 +100,7 @@ Importing
97100
98101
99102
Note: if you want to use DeepDiff via commandline, make sure to run::
100-
pip install "deepdiff[cli]"
103+
pip install "deepdiff6[cli]"
101104

102105
Then you can access the commands via:
103106

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ def get_reqs(filename):
3434
author='Seperman',
3535
author_email='[email protected]',
3636
license='MIT',
37-
packages=['deepdiff'],
37+
packages=['deepdiff6'],
3838
zip_safe=True,
3939
test_suite="tests",
4040
include_package_data=True,
41-
tests_require=['mock'], # 'numpy==1.11.2' numpy is needed but comes already installed with travis
41+
tests_require=['mock'],
4242
long_description=long_description,
4343
long_description_content_type='text/markdown',
4444
install_requires=reqs,

0 commit comments

Comments
 (0)