Merge branch 'master' of https://github.com/superannotateai/superannotate-python-sdk

Author: agyurjin

.readthedocs.yml

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

MANIFEST.in

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

Makefile

@@ -1,32 +1,29 @@
-.PHONY: all clean tests stress-tests coverage test_coverage install lint docs dist check_formatting
+.PHONY: clean tests stress-tests test_coverage install lint docs dist check_formatting
 
 PYTHON=python3
 PYLINT=pylint
 PYTESTS=pytest
 COVERAGE=coverage
 
 tests: check_formatting docs
-	$(PYTESTS) -n auto
+	$(PYTESTS) -n auto tests
 
 stress-tests: SA_STRESS_TESTS=1
 stress-tests: tests
-	$(PYTESTS) -n auto
 
 clean:
 	rm -rf superannotate.egg-info
 	rm -rf build
 	rm -rf dist
 	rm -rf htmlcov
 
-coverage: test_coverage
-
 test_coverage: check_formatting
-	-$(PYTESTS) --cov=superannotate -n auto
+	-$(PYTESTS) --cov=superannotate -n auto tests
 	$(COVERAGE) html
 	@echo "\033[95m\n\nCoverage successful! View the output at file://htmlcov/index.html.\n\033[0m"
 
 install:
-	pip install .
+	pip install -e .
 
 lint: check_formatting
 	-$(PYLINT) --output-format=json superannotate/ | pylint-json2html -o pylint.html

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
@@ -20,13 +20,13 @@ pip install -e .
 pip install pytest pytest-xdist
 
 # for coverage
-# pip install coverage pytest-cov
+pip install coverage pytest-cov
 
 # for linting
-# pip install pylint pylint-json2html pylint-pytest
+pip install pylint pylint-json2html pylint-pytest
 
 # for docs
-# pip install sphinx sphinx_rtd_theme
+pip install sphinx sphinx_rtd_theme
 
 # for on PyPI distribution
-# pip install twine
+pip install twine

pytest.ini

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

requirements_extra.txt

@@ -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.txt') as f:
+        requirements_extra = f.read()
+
+    requirements_extra = requirements_extra.splitlines()
+    requirements += requirements_extra
+
 with open('README.md') as f:
     readme = f.read()
 readme = "\n".join(readme.split('\n')[2:])

setup.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 (

superannotate/__init__.py

@@ -350,7 +350,8 @@ def fill_class_and_attribute_ids(annotation_json, annotation_classes_dict):
 
 def check_annotation_json(annotation_json):
     if "metadata" not in annotation_json or "width" not in annotation_json[
-        "metadata"] or "height" not in annotation_json["metadata"]:
+        "metadata"] or "height" not in annotation_json[
+            "metadata"] or "name" not in annotation_json["metadata"]:
         return False
     else:
         return True