Hexlet tests and linter status:

How and Why:

This library allows to compare two configuration files and display the difference between them. Files that can be compared must be either JSON or YAML type (ending with .json or .yaml/.yml respectively). It's important for both files to be the same type (you can't compare JSON with YAML). The difference shows what has changed in the second file relative to the first one. The difference can be showed in three ways (format types):

1. Stylish (the default one)
2. Plain
3. JSON

The output examples are represented in the Asciinema section below.

Installation

1. Choose a directory you want to store this library in
2. Copy the link of this repo
3. Paste it after git clone in your terminal
4. Input cd python-project-50
5. Input pip install .

After that you can use gendiff as a command in your CLI or as a library in your own .py files.

Usage as a CLI-command:

• gendiff requires two positional arguments that must be paths to files you want to compare. Paths to files must be specified relatively to your current working directory
• gendiff can take an optional argument -f (--format) which defines how the difference will be showed: in stylish, plain or json format
• gendiff -h shows a brief description
• gendiff path/to/first_file path/to/second_file shows a difference between files in a default (stylish) format

Usage as a library:

• Simply make an import from gendiff import generate_diff to use the difference generating function by itself
• Signature: generate_diff("path/to/first_file", "path/to/second_file", format_name="stylish"), returns a string

Requirements:

• python 3.12 or newer

Asciinema:

• flat json files, stylish output
• flat yaml files, stylish output
• nested files, stylish output
• plain ouput
• json output