Shapely install

Author: hovnatan

.readthedocs.yml

@@ -21,4 +21,5 @@ formats:
 python:
   version: 3.7
   install:
-    - requirements: requirements.txt
+    - requirements: requirements.txt
+    - requirements: requirements_extra_linux.txt

MANIFEST.in

@@ -1,3 +1,4 @@
 include README.md
 include requirements.txt
+include requirements_extra_linux.txt
 include LICENSE

docs/source/tutorial.sdk.rst

@@ -20,15 +20,14 @@ SDK is available on PyPI:
 The package officially supports Python 3.6+ and was tested under Linux and
 Windows (`Anaconda <https://www.anaconda.com/products/individual#windows>`_) platforms.
 
-For Windows based Anaconda distribution 
-you might also need to install beforehand :py:obj:`shapely` package:
+For Windows and Mac OS based installations to use :py:obj:`benchmark` and :py:obj:`consensus`
+functions you might also need to install beforehand :py:obj:`shapely` package,
+which we found to work properly only under Anaconda distribution, with:
 
 .. code-block:: bash
 
    conda install shapely
 
-and `C++ build tools from Microsoft
-<https://go.microsoft.com/fwlink/?LinkId=691126>`_.
 
 ----------
 

install.sh

@@ -11,7 +11,7 @@ rm -rf venv_sa_conv
 python${PYTHON_VER} -m venv venv_sa_conv
 source venv_sa_conv/bin/activate
 
-pip install shapely
+# pip install shapely
 pip install -e .
 # pip install --pre superannotate
 # pip install superannotate

requirements_extra_linux.txt

@@ -0,0 +1 @@
+Shapely>=1.7.1

setup.py

@@ -1,10 +1,18 @@
+import sys
+
 from setuptools import find_packages, setup
 
 with open('requirements.txt') as f:
     requirements = f.read()
-
 requirements = requirements.splitlines()
 
+if sys.platform == 'linux':
+    with open('requirements_extra_linux.txt') as f:
+        requirements_extra_linux = f.read()
+
+    requirements_extra_linux = requirements_extra_linux.splitlines()
+    requirements += requirements_extra_linux
+
 with open('README.md') as f:
     readme = f.read()
 readme = "\n".join(readme.split('\n')[2:])

superannotate/__init__.py

@@ -22,16 +22,13 @@
     from .consensus_benchmark.benchmark import benchmark
     from .consensus_benchmark.consensus import consensus
 except:
+    _WARNING_SHAPELY = "To use superannotate.benchmark or superannotate.consensus functions please install shapely package in Anaconda enviornment with # conda install shapely"
 
     def benchmark(*args, **kwargs):
-        raise RuntimeError(
-            "To use superannotate.benchmark or superannotate.consensus functions please install shapely package with # conda install shapely or # pip install shapely"
-        )
+        raise RuntimeError(_WARNING_SHAPELY)
 
     def consensus(*args, **kwargs):
-        raise RuntimeError(
-            "To use superannotate.benchmark or superannotate.consensus functions please install shapely package with # conda install shapely or # pip install shapely"
-        )
+        raise RuntimeError(_WARNING_SHAPELY)
 
 
 from .dataframe_filtering import (