1919- [ Examples] ( #examples )
2020- [ Performance] ( #performance )
2121- [ Development] ( #development )
22+ - [ Contributing] ( #contributing )
23+ - [ Compatibility] ( #compatibility )
24+ - [ Changelog] ( #changelog )
2225- [ License] ( #license )
2326
2427---
4043
4144## Installation
4245
43- Install the latest version directly from GitHub:
46+ ### From GitHub (Latest Development Version)
4447
4548``` sh
4649pip install git+https://github.com/datsom1/db-diff.git
@@ -248,11 +251,11 @@ A summary of key options:
248251| ` --fields TEXT ` | Comma-separated list of fields to compare (all others ignored) |
249252| ` --ignorefields TEXT ` | Comma-separated list of fields to ignore during comparison |
250253| ` --showunchanged ` | Show all fields for changed records, not just changed fields |
251- | ` --time ` | Measure and display elapsed time for the diff operation |
252254| ` --format TEXT ` | Explicitly specify input format: ` csv ` , ` tsv ` , or ` json ` (default: auto-detect) |
253255| ` --encoding TEXT ` | Input file encoding (default: utf-8) |
254256| ` --streaming ` | Use streaming mode for very large CSV/TSV files (requires files to be sorted by key) |
255257| ` --listfields ` | List available fields/columns in the input files and exit |
258+ | ` --verbose ` , ` -v ` | Enable verbose output with detailed logging |
256259| ` --version ` | Show the version and exit |
257260| ` -h, --help ` | Show help message and exit |
258261
@@ -296,6 +299,12 @@ db-diff one.csv two.csv --key=Id --ignorefields=LastModifiedDate
296299db-diff large1.csv large2.csv --key=Id --streaming
297300```
298301
302+ ** Verbose output with detailed logging:**
303+
304+ ``` sh
305+ db-diff one.csv two.csv --key=Id --verbose
306+ ```
307+
299308---
300309
301310## Performance
@@ -314,13 +323,31 @@ git clone https://github.com/datsom1/db-diff.git
314323cd db-diff
315324```
316325
317- Install dependencies:
326+ Install development dependencies:
318327
319328``` sh
320- pip install -e .
329+ pip install -e " .[dev] "
321330```
322331
323- ---
332+ Run tests:
333+
334+ ``` sh
335+ pytest
336+ ```
337+
338+ ## Contributing
339+
340+ Contributions are welcome! Please feel free to submit a Pull Request.
341+
342+ ## Compatibility
343+
344+ - Python 3.6+
345+ - Works on Windows, macOS, and Linux
346+ - Handles various file encodings (UTF-8, UTF-16, Latin1, etc.)
347+
348+ ## Changelog
349+
350+ For a detailed list of changes for each version, please see the [ CHANGELOG] ( https://github.com/datsom1/db-diff/releases ) .
324351
325352## License
326353
@@ -329,4 +356,5 @@ This project is licensed under the [Apache License 2.0](LICENSE).
329356---
330357
331358** Author:** Thomas Coyle
332- ** Repository:** https://github.com/datsom1/db-diff
359+ ** Repository:** https://github.com/datsom1/db-diff
360+ ** Last Updated:** June 2025
0 commit comments