diff --git a/Makefile b/Makefile index 16a0543..6dbfd37 100644 --- a/Makefile +++ b/Makefile @@ -12,3 +12,15 @@ show-coverage: test: poetry run pytest + +publish: + poetry publish --dry-run + +package-install: + python3 -m pip install --user dist/*.whl + +gendiff: + poetry run gendiff + + +.PHONY: install lint test publish gendiff \ No newline at end of file diff --git a/README.md b/README.md index b3df2cb..7e0a2cd 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,32 @@ [![Test Coverage](https://api.codeclimate.com/v1/badges/9322302759fa8fdd9823/test_coverage)](https://codeclimate.com/github/remortalite/python-project-50/test_coverage) +# Генератор отличий + +Программа позволяет пользователю получить различия двух json или yaml файлов, и вывести их на печать, либо в json формат. + +# Установка и запуск + +```bash +make install + +make gendiff +``` + +Или можно установить программу в виртуальное окружение: + +```bash +make install package-install publish + +gendiff -h +``` + +# Аргументы командной строки + +`filename{1,2}` -- пути до файлов + +`-f`/`--format` [json/plain/stylish] -- формат вывода различий + # Example: [![asciicast](https://asciinema.org/a/VqUBwDVgdD3umGZYx0qYxiPBa.svg)](https://asciinema.org/a/VqUBwDVgdD3umGZYx0qYxiPBa)