Skip to content

CLI tool and Python package for visualising the differences between things

License

Notifications You must be signed in to change notification settings

cariad/differently

Repository files navigation

differently

codecov CircleCI codecov

differently is a CLI tool and Python package for visualising the differences between things.

Installation

differently requires Python 3.8 or later.

pip install differently

Example

differently examples/1.md examples/2.md
# "differently" example file                           =  # "differently" example file
                                                       =
To run this example, install `differently` then run:   =  To run this example, install `differently` then run:
                                                       =
```bash                                                =  ```bash
differently 1.md 2.md                                  =  differently 1.md 2.md
```                                                    =  ```
                                                       =
This line says "foo" in 1.md.                          ~  This line says "bar" in 2.md.
                                                       =
Now, a deletion:                                       =  Now, a deletion:
                                                       x
Hello from 1.md.                                       x
                                                       =
The line above should appear in 1.md but deleted in    =  The line above should appear in 1.md but deleted in
the diff because it's not in 2.md.                     =  the diff because it's not in 2.md.
                                                       =
And finally, this next line doesn't exist in 1.md but  =  And finally, this next line doesn't exist in 1.md but
should be added in the diff because it's in 2.md:      =  should be added in the diff because it's in 2.md:
                                                       >
                                                       >  Hello from 2.md.

differently also supports JSON and YAML comparisons and Python usage. Read the full documentation at cariad.github.io/differently.

👋 Hello!

Hello! I'm Cariad Eccleston and I'm an independent/freelance software engineer. If my work has value to you, please consider sponsoring.

If you ever raise a bug, request a feature or ask a question then mention that you're a sponsor and I'll respond as a priority. Thank you!