diff --git a/README.md b/README.md index 5ddf9343d22d0ec2bf44696169c18f44913a45e5..a6d8cd07c6b6807434484ba55e6c7b6aeb50acd9 100644 --- a/README.md +++ b/README.md @@ -1 +1,39 @@ # python-mkp + +[](https://travis-ci.org/tom-mi/python-mkp) + +Pack or unpack [Check_MK](https://mathias-kettner.de/check_mk.html) mkp files. + +## Installation + + pip install mkp + +## Usage + +### Extract mkp package + + import mkp + + package = mkp.load_file('foo-1.0.mkp') + print(package.info) + package.extract_files('path/to/somewhere') + +### Pack files to mkp package + + import mkp + + info = { + 'author': 'tom-mi', + 'description': 'Test the system', + 'download_url': 'http://example.com/', + 'files': mkp.find_files('path/to/files'), + 'name': 'test', + 'title': 'Test', + 'version': '1.0', + 'version.min_required': '1.2.3', + } + mkp.pack_to_file(info, 'path/to/files', 'test-1.0.mkp') + +## License + +This software is licensed under GPLv2.