Skip to content

Commit 25bba00

Browse files
authored
Update README.md
1 parent cffd089 commit 25bba00

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Python CLI tool and library for comparing CSV database dumps and finding differe
1010

1111
## Installation
1212

13-
pip install csv-diff
13+
pip install db-diff
1414

1515
## Usage
1616

@@ -28,9 +28,9 @@ Consider two CSV files:
2828
1,Cleo,5
2929
3,Bailey,1
3030

31-
`csv-diff` can show a human-readable summary of differences between the files:
31+
`db-diff` can show a human-readable summary of differences between the files:
3232

33-
$ csv-diff one.csv two.csv --key=id
33+
$ db-diff one.csv two.csv --key=id
3434
1 row changed, 1 row added, 1 row removed
3535

3636
1 row changed
@@ -58,7 +58,7 @@ You can also feed it JSON files, provided they are a JSON array of objects where
5858

5959
Use `--show-unchanged` to include full details of the unchanged values for rows with at least one change in the diff output:
6060

61-
% csv-diff one.csv two.csv --key=id --show-unchanged
61+
% db-diff one.csv two.csv --key=id --show-unchanged
6262
1 row changed
6363

6464
id: 1
@@ -71,7 +71,7 @@ Use `--show-unchanged` to include full details of the unchanged values for rows
7171

7272
You can use the `--json` option to get a machine-readable difference:
7373

74-
$ csv-diff one.csv two.csv --key=id --json
74+
$ db-diff one.csv two.csv --key=id --json
7575
{
7676
"added": [
7777
{
@@ -111,7 +111,7 @@ You can specify additional keys to be displayed in the human-readable format usi
111111
For example, to output a link to `https://news.ycombinator.com/latest?id={id}` for each item with an ID, you could use this:
112112

113113
```bash
114-
csv-diff one.csv two.csv --key=id \
114+
db-diff one.csv two.csv --key=id \
115115
--extra latest "https://news.ycombinator.com/latest?id={id}"
116116
```
117117
These extras display something like this:
@@ -155,4 +155,4 @@ Suppose current directory contains two csv files : one.csv two.csv
155155

156156
## Alternatives
157157

158-
- [csvdiff](https://github.com/aswinkarthik/csvdiff) is a "fast diff tool for comparing CSV files" - you may get better results from this than from `csv-diff` against larger files.
158+
- [csvdiff](https://github.com/aswinkarthik/csvdiff) is a "fast diff tool for comparing CSV files" - you may get better results from this than from `db-diff` against larger files.

0 commit comments

Comments
 (0)