Added setup for publishing

Author: joeyism

README.md

@@ -1,4 +1,5 @@
 # py-image-comparer
+Compares two images using [Siamese Network](https://www.cs.cmu.edu/~rsalakhu/papers/oneshot1.pdf) trained from a [Pytorch Implementation](https://github.com/joeyism/siamese-pytorch)
 
 ## Installation
 To install, run

README.rst

@@ -0,0 +1,84 @@
+
+py-image-comparer
+=================
+
+Installation
+------------
+
+To install, run
+
+.. code-block:: bash
+
+   pip install image-comparer
+
+Usage
+-----
+
+CLI
+^^^
+
+.. code-block:: bash
+
+   image-compare
+
+which wil show the follow help screen
+
+.. code-block::
+
+   usage: image-compare [-h] [--threshold THRESHOLD] Image1-Path Image2-Path
+
+For example, you can compare two images with
+
+.. code-block:: bash
+
+   image-compare tests/images/kobe.jpg tests/images/kobe2.jpg
+
+which gives the result
+
+.. code-block::
+
+   kobe.jpg and kobe2.jpg are not similar
+
+Programmatically
+^^^^^^^^^^^^^^^^
+
+With PIL
+
+.. code-block:: python
+
+   import image_comparer
+   from PIL import Image
+
+   image = Image.open("test/kobe.jpg")
+   image2 = Image.open("test/kobe2.jpg")
+   image_comparer.is_similar(image, image2, threshold=0.5)
+
+or with OpenCV
+
+.. code-block:: python
+
+   import image_comparer
+   import cv2
+
+   image = cv2.imread("test/kobe.jpg")
+   image2 = cv2.imread("test/kobe2.jpg")
+   image_comparer.is_similar(image, image2, threshold=0.5)
+
+Development
+-----------
+
+Installation
+^^^^^^^^^^^^
+
+.. code-block:: bash
+
+   pip install -r requirements-test.txt
+
+Tests
+^^^^^
+
+To run tests, run
+
+.. code-block:: bash
+
+   pytest

setup.py

@@ -3,10 +3,24 @@
 PACKAGE_NAME = "image-comparer"
 PACKAGE_NAME_UNDERLINE = PACKAGE_NAME.replace("-", "_")
 
+version = re.search(
+    '^__version__\s*=\s*"(.*)"',
+    open(f'{PACKAGE_NAME_UNDERLINE}/__init__.py').read(),
+    re.M
+    ).group(1)
+
 setup(
     name=PACKAGE_NAME,
     packages=find_packages(exclude=["tests"]),
+    version=version,
+    description='Compares two images using siamese networks',
+    long_description=open("README.md", "r").read(),
+    long_description_content_type='text/markdown',
+    author='joeyism',
+    url='https://github.com/joeyism/py-image-comparer',
+    download_url='https://github.com/joeyism/py-image-comparer/archive/{}.tar.gz'.format(version),
     install_requires=[package for package in open("requirements.txt").read().split("\n")],
+    keywords=["pytorch", "torch", "machine", "learning", "image", "compare", "comparer", "siamese", "network", "networks"],
     entry_points={
         "console_scripts": [
             f"image-compare = {PACKAGE_NAME_UNDERLINE}.cli:cli",