diff --git a/README.md b/README.md index c0a90ad..9afce9b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ # npkPy The npkPy package module is an unpacking tool for MikroTiks custom NPK container format. The tool is capable -to display to the content of any NPK package and to export all container. +to display the content of any NPK package and to export all container. ["NPK stands for MikroTik RouterOS upgrade package"](https://whatis.techtarget.com/fileformat/NPK-MikroTik-RouterOS-upgrade-package) and since there is no solid unpacking tool for the format available, I want to share my approach of it. @@ -21,6 +21,12 @@ All recent packages are signed with EC-KCDSA signature, and there's no way to create a valid npk file unless you know a secret key. ``` +## Installation + +``` +pip install npkPy +``` + ## Usage ``` diff --git a/bootstrap.sh b/bootstrap.sh index 223f13c..18d5098 100755 --- a/bootstrap.sh +++ b/bootstrap.sh @@ -11,7 +11,7 @@ if [[ ! -e ${venv} ]]; then fi git config user.name "botlabsDev" -git config user.email "git@botlabs.dev" +git config user.email "botlabs.dev@botlabs.dev" echo "--git config--" echo -n "git user:"; git config user.name echo -n "git email:"; git config user.email diff --git a/pytest.sh b/pytest.sh index aa7946f..ad4d3a5 100755 --- a/pytest.sh +++ b/pytest.sh @@ -1,11 +1,3 @@ !/bin/bash -if [ ! -z "$1" ] -then - clear; echo "test specific file: $1" - pytest --cov=./ $1 -v -else - clear; echo "test all project files" - pytest --cov=npkpy --cov=acceptance_test -v - -fi +pytest --cov=npkpy --cov=acceptance_test -v diff --git a/setup.py b/setup.py index d6b0a75..2330512 100755 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ setuptools.setup( ], entry_points={ 'console_scripts': [ - "npkPy=npkpy.main:main", + "npkpy=npkpy.main:main", # "npkDownloader=npkpy.download:main", ], }, diff --git a/tests_acceptance_test/acceptance_test.py b/tests_acceptance_test/acceptance_test.py index 8418bcf..2e3777d 100644 --- a/tests_acceptance_test/acceptance_test.py +++ b/tests_acceptance_test/acceptance_test.py @@ -19,12 +19,12 @@ class Test_npkPy(unittest.TestCase): self.dstFolder.rmdir() def test_showAllContainersFromNpkPkg(self): - cmd = ["npkPy", "--file", self.pathToNpk, "--showContainer"] + cmd = ["npkpy", "--file", self.pathToNpk, "--showContainer"] output = runCmdInTerminal(cmd) self.assertEqual(self.npkContainerList, output) def test_exportAllContainerFromNpk(self): - cmd = ["npkPy", "--file", self.pathToNpk, "--dstFolder", self.dstFolder.absolute(), "--exportAll"] + cmd = ["npkpy", "--file", self.pathToNpk, "--dstFolder", self.dstFolder.absolute(), "--exportAll"] runCmdInTerminal(cmd) @@ -42,7 +42,7 @@ class Test_npkPy(unittest.TestCase): 'npkPyExport_gps-6.45.6/009_cnt_CntArchitectureTag.raw'], exportedContainer) def test_extractSquashFsContainerFromNpk(self): - cmd = ["npkPy", "--file", self.pathToNpk, "--dstFolder", self.dstFolder.absolute(), "--exportSquashFs"] + cmd = ["npkpy", "--file", self.pathToNpk, "--dstFolder", self.dstFolder.absolute(), "--exportSquashFs"] runCmdInTerminal(cmd) @@ -51,7 +51,7 @@ class Test_npkPy(unittest.TestCase): # def test_extractZlibContainerFromNpk_NonExisitngNotExtracted(self): - cmd = ["npkPy", "--file", self.pathToNpk, "--dstFolder", self.dstFolder.absolute(), "--exportZlib"] + cmd = ["npkpy", "--file", self.pathToNpk, "--dstFolder", self.dstFolder.absolute(), "--exportZlib"] runCmdInTerminal(cmd)