README.md

Difference Generator

---

Hexlet tests and linter status:

---

Installation

pip3 install --upgrade git+https://github.com/mnogom/python-project-lvl2.git

---

Usage

1. From command line

usage: gendiff [-h] [-f FORMAT] first_file second_file

Generate diff

positional arguments:
  first_file
  second_file

optional arguments:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        set format of output

2. From python

import gendiff

style = "plain"  # ["stylish (default)" | "plain" | "json"]
output = gendiff.generate_diff("path/to/file1", "path/to/file2", style)

---

Features

1. Works with JSON and YAML format
2. Works with Plain and Recursive file structures
3. Output in Stylish, Plain and JSON formats

See examples below

---

Examples

Plain JSON @ Stylish format

Plain YAML @ Stylish format

Recursive JSON @ Stylish format

Recursive JSON @ Plain format

Recursive JSON @ JSON format