Skip to content

Commit ecc15d2

Browse files
committed
updating readme about the commandline
1 parent 2451bf3 commit ecc15d2

File tree

3 files changed

+37
-3
lines changed

3 files changed

+37
-3
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ Tested on Python 3.6+ and PyPy3.
2727

2828
`pip install deepdiff`
2929

30+
If you want to use DeepDiff from commandline:
31+
32+
`pip install "deepdiff[cli]"`
33+
3034
### Importing
3135

3236
```python
@@ -35,13 +39,24 @@ Tested on Python 3.6+ and PyPy3.
3539
>>> from deepdiff import DeepHash # For hashing objects based on their contents
3640
```
3741

42+
Note: if you want to use DeepDiff via commandline, make sure to run `pip install "deepdiff[cli]"`. Then you can access the commands via:
43+
44+
- DeepDiff
45+
- `$ deep diff --help`
46+
- Delta
47+
- `$ deep patch --help`
48+
- grep
49+
- `$ deep grep --help`
50+
- extract
51+
- `$ deep extract --help`
52+
3853
# Deep Diff
3954

4055
DeepDiff gets the difference of 2 objects.
4156

4257
> - Please take a look at the [DeepDiff docs](https://zepworks.com/deepdiff/5.2.1/diff.html)
43-
> - The full documentation can be found on <https://zepworks.com/deepdiff/5.2.1/>
44-
> - Tutorials can be found on <https://zepworks.com/tags/deepdiff/>
58+
> - The full documentation of all modules can be found on <https://zepworks.com/deepdiff/5.2.1/>
59+
> - Tutorials and posts about DeepDiff can be found on <https://zepworks.com/tags/deepdiff/>
4560
4661
## A few Examples
4762

deepdiff/diff.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,7 @@ def _skip_this(self, level):
382382
Check whether this comparison should be skipped because one of the objects to compare meets exclusion criteria.
383383
:rtype: bool
384384
"""
385+
print(f"skip? {level.path()}")
385386
skip = False
386387
if self.exclude_paths and level.path() in self.exclude_paths:
387388
skip = True

docs/index.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The DeepDiff library includes the following modules:
3131
Supported Python Versions
3232
*************************
3333

34-
DeepDiff is rigorously tested against Python 3.5, 3.6, 3.7, 3.8 and Pypy3
34+
DeepDiff is rigorously tested against Python 3.6, 3.7, 3.8, 3.9 and Pypy3
3535

3636
NOTE: Python 2 is not supported any more. DeepDiff v3.3.0 was the last version to supprt Python 2.
3737

@@ -49,6 +49,10 @@ Install from PyPi::
4949

5050
pip install deepdiff
5151

52+
If you want to use DeepDiff from commandline::
53+
54+
pip install "deepdiff[cli]"
55+
5256
Read about DeepDiff optimizations at :ref:`optimizations_label`
5357

5458

@@ -64,6 +68,20 @@ Importing
6468
>>> from deepdiff import extract # For extracting a path from an object
6569
6670
71+
Note: if you want to use DeepDiff via commandline, make sure to run::
72+
pip install "deepdiff[cli]"
73+
74+
Then you can access the commands via:
75+
76+
- DeepDiff::
77+
$ deep diff --help
78+
- Delta::
79+
$ deep patch --help
80+
- grep::
81+
$ deep grep --help
82+
- extract::
83+
$ deep extract --help
84+
6785
Supported data types
6886
~~~~~~~~~~~~~~~~~~~~
6987

0 commit comments

Comments
 (0)