Hexlet tests and linter status:

Этот проект представляет собой программу - Вычислитель отличий

Вычислитель отличий – программа, определяющая разницу между двумя структурами данных. Это популярная задача, для решения которой существует множество онлайн-сервисов. Подобный механизм, например, используется при выводе тестов или при автоматическом отслеживании изменений в конфигурационных файлах.

Возможности утилиты:

Поддержка разных входных форматов: yaml, json
Генерация отчета в виде plain text, stylish и json

Установка

Для установки программы необходимо использовать команду, находясь в корневой директории проекта

poetry install

Так же имеется возможность сделать билд проекта с последующей установкой при помощи двух команд

poetry build && pip install dist/*.whl

Так же можно установить программу без клонирования репозитория, но после этого нужно будет установить зависимости, указанные ниже

python3 -m pip install --user git+https://github.com/ReYaNOW/python-project-50.git

Устанавливать программу стоит в отдельном окружении для избежания проблем с зависимостями

Как создать окружение и активировать его

Windows PowerShell

python -m venv venv; ./venv/Scripts/activate.ps1

Linux

python3 -m venv venv && source venv/bin/activate

Использование

Для того чтобы увидеть мануал по программе, необходимо использовать команду

gendiff

или

gendiff -h

Для сравнения файлов необходимо использовать команду

gendiff [Путь до файла 1] [Путь до файла 2]  

Пример работы команды c json файлами

Пример работы команды с yaml и json файлами со вложенными структурами

Пример работы команды в формате plain text

Пример работы команды в формате json

Минимальные требования:

Python^3.10
Poetry

Библиотеки Python:

Flake8
Pytest
Pytest-cov
PyYAML