Fix lint warnings & add make target for publishing

Author: Kirill V. Lyadvinsky

.pylintrc

@@ -0,0 +1,11 @@
+[TYPECHECK]
+ignored-classes=Header
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=20
+
+[MISCELLANEOUS]
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX

Makefile

@@ -1,19 +1,24 @@
-.PHONY: init test clean coverage lint
+.PHONY: test clean coverage lint distclean
+
+PYTHON ?= python3
 
 test:
-	python3 -m unittest discover -v -b
+	$(PYTHON) -m unittest discover -v -b
 
 clean:
-	rm -rf test/*.pyc
-	rm -rf zxtools/*.pyc
-	rm -rf test/__pycache__
-	rm -rf zxtools/__pycache__
-	rm -rf zxtools.egg-info
+	rm -rf dist/ build/ *.egg-info
 	rm -rf coverage.xml
+	find . -name '__pycache__' | xargs rm -rf
+
+distclean: clean
 
 coverage:
 	coverage run --source zxtools setup.py test
-	coverage report -m
+	coverage report -m --fail-under=90
 
 lint:
 	pylint zxtools -f parseable -r n
+
+release: clean lint coverage clean
+	$(PYTHON) setup.py sdist bdist_wheel upload
+

zxtools/__init__.py

@@ -7,6 +7,7 @@
 # Licensed under the BSD 3-Clause license.
 # See LICENSE file in the project root for full license information.
 #
+""" Global contants is here"""
 
-__version__ = '1.0.22'
+__version__ = '1.0.23'
 CHUNK_SIZE = 512 * 1024  # 512 KBytes

zxtools/hobeta.py

@@ -25,6 +25,7 @@
 
 
 def hobeta_help(*parsed_args):
+    """Shows help"""
     print(
         "Hobeta file has the following format:\n"
         "(this is according to http://speccy.info/Hobeta)\n"

zxtools/zeus2txt.py

@@ -20,16 +20,19 @@
 
 
 def show_info(*parsed_args):
+    """Show some statistic about Zeus file"""
+    # TODO Implement this function
     return parsed_args
 
 
 def read_file(src_file):
+    """Read source file for future processing"""
     with src_file:
         while True:
             chunk = src_file.read(CHUNK_SIZE)
             if chunk:
-                for b in chunk:
-                    yield b
+                for byte in chunk:
+                    yield byte
             else:
                 break
 
@@ -61,10 +64,10 @@ def convert_file(parsed_args):
     strnum = 0
     cur_buffer = ""
     cur_line = io.StringIO()
-    for b in read_file(parsed_args.zeus_file):
+    for cur_char in read_file(parsed_args.zeus_file):
         if process_string:
-            cur_buffer += "0x%02X " % b
-            if not b:  # End of string
+            cur_buffer += "0x%02X " % cur_char
+            if not cur_char:  # End of string
                 process_string = False
                 strnum_lo = False, 0
                 cur_str = cur_line.getvalue()
@@ -76,25 +79,25 @@ def convert_file(parsed_args):
                     print(file=output)
                 continue
             if tab:
-                print(" "*b, end="", file=cur_line)
+                print(" "*cur_char, end="", file=cur_line)
                 tab = False
                 continue
-            if b == 0x0A:
+            if cur_char == 0x0A:
                 tab = True
                 continue
-            if b < ASM_FIRST_TOKEN:  # Printable character
-                print(chr(b), end="", file=cur_line)
+            if cur_char < ASM_FIRST_TOKEN:  # Printable character
+                print(chr(cur_char), end="", file=cur_line)
                 continue
             try:
-                print(ASM_META[b-ASM_FIRST_TOKEN], end="", file=cur_line)
+                print(ASM_META[cur_char-ASM_FIRST_TOKEN], end="", file=cur_line)
             except IndexError:
                 logger.warning("Token not defined: 0x%02X (%d), at line %05d. "
-                               "Skipped.", b, b, strnum)
+                               "Skipped.", cur_char, cur_char, strnum)
         else:
             if not strnum_lo[0]:
-                strnum_lo = True, b
+                strnum_lo = True, cur_char
             else:
-                strnum = strnum_lo[1] + b*256
+                strnum = strnum_lo[1] + cur_char*256
                 if strnum == 0xFFFF:  # End of file
                     print(file=output)
                     break