Merge pull request #73 from chrissimpkins/dev

v4.0.0

Author: chrissimpkins

.travis.yml

@@ -34,7 +34,7 @@ matrix:
       language: generic
       osx_image: xcode11    # Python 3.7.4 running on macOS 10.14.4
       before_install:
-        - brew install pngcheck
+        - export HOMEBREW_NO_INSTALL_CLEANUP=1 && brew install pngcheck
       install:
         - make build-dependencies
         - make install-executable
@@ -56,6 +56,17 @@ matrix:
       script:
         - flake8 --ignore=E501,W503,E121,E123,E126,E226,E24,E704,W503,W504 src/crunch.py
         - shellcheck --exclude=2046 src/*.sh
+    - name: "Benchmarks"
+      python: 3.7
+      env: TOX_ENV=py37
+      dist: xenial
+      install:
+        - pip install --upgrade numpy
+      install:
+        - make build-dependencies
+        - make install-executable
+      script:
+        - make benchmark
 
 # The following prevents Travis from running CI on pull requests that come from a
 # branch in the same repository. Without this, it will run the same CI for the

CHANGELOG.md

@@ -1,7 +1,19 @@
 
+benchmark:
+	cd benchmarks && $(MAKE) $@
+
 build-dependencies:
 	src/install-dependencies.sh
 
+clean:
+	rm benchmarks/img/*-crunch.png
+
+dist: 
+	./dmg-builder.sh
+
+dist-homebrew:
+	cask-repair crunch
+
 install-executable:
 	sudo cp src/crunch.py /usr/local/bin/crunch
 	@echo " "
@@ -37,7 +49,7 @@ test-coverage:
 
 test-python:
 	tox
-	flake8 --ignore=E501,W503,E121,E123,E126,E226,E24,E704,W503,W504 src/crunch.py
+	flake8 --ignore=E501,W503,E121,E123,E126,E226,E24,E704,W503,W504,N806 src/crunch.py
 
 test-shell:
 	shellcheck --exclude=2046 src/*.sh
@@ -49,4 +61,5 @@ test-valid-png-output:
 
 test: test-python test-shell test-valid-png-output
 
-.PHONY: build-dependencies install-executable install-macos-service uninstall-executable uninstall-macos-service test test-coverage test-python test-shell test-valid-png-output
+
+.PHONY: benchmark build-dependencies install-executable install-macos-service uninstall-executable uninstall-macos-service test test-coverage test-python test-shell test-valid-png-output dist

LICENSE.md

@@ -0,0 +1,7 @@
+
+benchmark:
+	cd img && /usr/bin/time -p crunch *.png
+	cd img && python3 bench.py
+
+
+.PHONY: benchmark

Makefile

@@ -0,0 +1,8 @@
+PngSuite
+--------
+
+Permission to use, copy, modify and distribute these images for any
+purpose and without fee is hereby granted.
+
+
+(c) Willem van Schaik, 1996, 2011

README.md

@@ -0,0 +1,63 @@
+#!/usr/bin/env python3
+
+# ----------------------------------------
+#
+# Copyright (c) 2019 Christopher Simpkins
+# MIT license
+#
+# ---------------------------------------
+
+
+import glob
+import os
+
+
+def grouped(iterable, n):
+    return zip(*[iter(iterable)] * n)
+
+
+paths = sorted(glob.glob("*.png"))
+
+percent_list = []
+pre_size_list = []
+post_size_list = []
+
+for path_a, path_b in grouped(paths, 2):
+    if "-crunch" in path_a:
+        post_path = path_a
+        pre_path = path_b
+    else:
+        post_path = path_b
+        pre_path = path_a
+
+    # assert that we are testing the correct pairs of files
+    assert f"{pre_path[:-4]}-crunch.png" == post_path
+
+    pre_size = os.path.getsize(pre_path)
+    post_size = os.path.getsize(post_path)
+    percent_size = (post_size / pre_size) * 100
+
+    percent_list.append(percent_size)
+    pre_size_list.append(pre_size)
+    post_size_list.append(post_size)
+
+    print(f"{post_path}: {percent_size:.2f}%")
+
+
+mean = sum(percent_list) / len(percent_list)
+total_initial_size = sum(pre_size_list)
+total_final_size = sum(post_size_list)
+delta = total_initial_size - total_final_size
+
+print(f"\nInitial:\t{total_initial_size:>8} B")
+print(f"Final:  \t{total_final_size:>8} B")
+print(f"Delta: -{delta} B")
+print(f"Mean: {mean:.2f}%")
+try:
+    import numpy as np
+
+    a = np.array(percent_list)
+    stdev = np.std(a, dtype=np.float64)
+    print(f"SD: {stdev:.2f}%")
+except Exception:
+    pass