sound-round / python-project-lvl2

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

gendiff

Badges

Maintainability Github Actions Status Github Actions Status Test Coverage

Hexlet tests and linter status:

Actions Status

Description

gendiff — a program that determines the difference between two data structures. Utility features:

  • Support for different input formats: yaml, json,
  • Generating a report in plain text, stylish, and json format.

Visuals

Demo gendiff on asciinema with JSON-files:

asciicast

Demo gendiff on asciinema with YAML-files:

asciicast

Demo gendiff on asciinema with nested files:

asciicast

Demo gendiff on asciinema with plain-format:

asciicast

Final demo gendiff on asciinema:

asciicast

Install

Use the following commands to install gendiff:

make build
make package-install
make install

Local testing

Use the following command to test the package:

make lint

Commands and options

$ gendiff -h   
usage: gendiff [-h] [-f {stylish,plain,json}] first_file second_file

Generate diff

positional arguments:
  first_file
  second_file

optional arguments:
  -h, --help            show this help message and exit
  -f {stylish,plain,json}, --format {stylish,plain,json}
                        set format of output (default: "stylish") 

Support

If you have questions you can email me to yudaev1@gmail.com

Links

This project was built using these tools:

Tool Description
poetry "Python dependency management and packaging made easy"
flake8 "The tool for style guide enforcement"
code climate "Actionable metrics for engineering"
github actions "Automatization software workflows with CI/CD"

About


Languages

Language:Python 96.5%Language:Makefile 3.5%