From 17582f2b2b2fddcf075c65928c352109ff397de4 Mon Sep 17 00:00:00 2001 From: ShaynAli Date: Tue, 24 Dec 2019 07:49:36 -0500 Subject: [PATCH 1/3] Project rename --- .gitignore | 2 +- readme.md | 2 +- setup.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) mode change 100644 => 100755 .gitignore mode change 100644 => 100755 setup.py diff --git a/.gitignore b/.gitignore old mode 100644 new mode 100755 index bfa3181..b04f678 --- a/.gitignore +++ b/.gitignore @@ -16,4 +16,4 @@ pyvenv.cfg !.gitkeep # Install files -vsa_compression.egg-info/ +voronoi_compression.egg-info/ diff --git a/readme.md b/readme.md index 5f8639a..0a07d3b 100755 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# VSA Compression +# Voronoi Compression Uses Voronoi cells to compress and decompress an image diff --git a/setup.py b/setup.py old mode 100644 new mode 100755 index 45b4bae..9deef6d --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ requirements = requirements_file.read().splitlines() setup( - name='vsa-compression', + name='voronoi-compression', version='0.2', author='Shayaan Syed Ali', author_email='shayaan.syed.ali@gmail.com', From 0d5dfd80e237b67b069a66e5d9bc0129560e6746 Mon Sep 17 00:00:00 2001 From: ShaynAli Date: Tue, 24 Dec 2019 07:55:13 -0500 Subject: [PATCH 2/3] Cleanup --- README.md | 9 --------- compression.py | 2 +- LICENSE.md => license.md | 0 readme.md | 34 +++++++++++++++++----------------- 4 files changed, 18 insertions(+), 27 deletions(-) delete mode 100644 README.md rename LICENSE.md => license.md (100%) diff --git a/README.md b/README.md deleted file mode 100644 index 08f83de..0000000 --- a/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# VSA-Compression - -A lossy compression algorithm using Voronoi cells to encode information - -## Usage - -` python .\compression.py ` - -The target image must be located in `images/raw`, and the compressed image will be output to `images/compressed`. diff --git a/compression.py b/compression.py index afc25bf..0589e44 100755 --- a/compression.py +++ b/compression.py @@ -163,7 +163,7 @@ def main(in_image, out_image, progress=False): if __name__ == '__main__': import argparse - parser = argparse.ArgumentParser(description='Uses Voronoi cells to compress and decompress an image') + parser = argparse.ArgumentParser(description='Uses Voronoi cells to compress and decompress an image.') parser.add_argument('-p', '--progress', action='store_true', help='show progress bars') parser.add_argument('-i', '--in-image', required=True, diff --git a/LICENSE.md b/license.md similarity index 100% rename from LICENSE.md rename to license.md diff --git a/readme.md b/readme.md index 0a07d3b..1b32098 100755 --- a/readme.md +++ b/readme.md @@ -1,17 +1,17 @@ -# Voronoi Compression - -Uses Voronoi cells to compress and decompress an image - -## Usage - -``` -compression.py [-h] -i IN_IMAGE -o OUT_IMAGE - -arguments: - -h, --help show this help message and exit - -i IN_IMAGE, --in-image IN_IMAGE - the filepath to read an image from, this image will be - compressed - -o OUT_IMAGE, --out-image OUT_IMAGE - the filepath to write the compressed image to -``` +# Voronoi Compression + +Uses Voronoi cells to compress and decompress an image. + +## Usage + +``` +compression.py [-h] -i IN_IMAGE -o OUT_IMAGE + +arguments: + -h, --help show this help message and exit + -i IN_IMAGE, --in-image IN_IMAGE + the filepath to read an image from, this image will be + compressed + -o OUT_IMAGE, --out-image OUT_IMAGE + the filepath to write the compressed image to +``` From 750383fe70f42d99f051969ce539a8f7b9f9debc Mon Sep 17 00:00:00 2001 From: ShaynAli Date: Tue, 24 Dec 2019 07:56:08 -0500 Subject: [PATCH 3/3] Version bump to 1.0 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 9deef6d..4d9887b 100755 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setup( name='voronoi-compression', - version='0.2', + version='1.0', author='Shayaan Syed Ali', author_email='shayaan.syed.ali@gmail.com', install_requires=requirements,