Merge 9603b3d into 7f10908

.travis.yml

@@ -17,9 +17,11 @@ cache: pip
 install:
   - pip install -r requirements.txt
   - pip install pytest pytest-cov==2.5.1 pytest-pep8 coveralls
+  # - pip install -r docs/rtd-requirements.txt
 
 script:
-  - pytest --cov=redis_consumer --pep8
+  - PYTHONPATH=$PWD:$PYTHONPATH pytest --cov=redis_consumer --pep8
+  # - PYTHONPATH=$PWD:$PYTHONPATH sphinx-build -nT -b dummy ./docs/source build/html
 
 jobs:
   include:

README.rst

@@ -18,4 +18,4 @@ Reads events in redis, downloads image data from the cloud, and send the data to
 Custom Consumers
 ----------------
 
-Custom consumers can be used to implement custom model pipelines. Check out :doc:`kiosk:CUSTOM-JOB`.
+Custom consumers can be used to implement custom model pipelines. Check out :doc:`kiosk:CUSTOM-JOB`.

docs/Makefile

@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/rtd-requirements.txt

@@ -9,4 +9,4 @@ pathlib==1.0.1
 redis==3.2.1
 grpcio==1.22.0
 dict-to-protobuf==0.0.3.9
-pytz==2019.1
+pytz==2019.1

docs/source/CUSTOM_CONSUMER.rst

@@ -79,4 +79,4 @@ Finally, the new consumer needs to be registered in the script |consume-redis-ev
 Deploying a custom consumer
 ---------------------------
 
-For guidance on how to complete the deployment of a custom consumer, please return to :doc:`kiosk:CUSTOM_JOB`.
+For guidance on how to complete the deployment of a custom consumer, please return to :doc:`kiosk:CUSTOM_JOB`.

docs/source/conf.py

@@ -25,10 +25,9 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Kiosk Redis Consumer'
-copyright = ('2016-{currentyear}, Van Valen Lab at the California Institute of Technology'
-             ' (Caltech)').format(
-    currentyear=datetime.now().year
-)
+copyright = ('2016-{currentyear}, Van Valen Lab at the '
+             'California Institute of Technology (Caltech)').format(
+                 currentyear=datetime.now().year)
 author = 'Van Valen Lab at Caltech'
 
 # The short X.Y version
@@ -199,15 +198,12 @@
 
 
 # -- Extension configuration -------------------------------------------------
-autodoc_mock_imports = ["tensorflow",
-                        "sklearn",
-                        "skimage",
-                        "nbformat",
+autodoc_mock_imports = ["skimage",
                         "cv2",
                         "keras_retinanet",
                         "keras_preprocessing",
-                        "keras_maskrcnn",
                         "deepcell_tracking",
+                        "deepcell_toolbox",
                         "numpy",
                         "scipy",
                         "PIL"]

docs/source/redis_consumer.consumers.rst

@@ -1,7 +1,42 @@
 redis_consumer.consumers module
 ===============================
+
+Submodules
+----------
+
+redis_consumer.consumers.base_consumer module
+---------------------------------------------
+
+.. automodule:: redis_consumer.consumers.base_consumer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:
+
+redis_consumer.consumers.image_consumer module
+----------------------------------------------
+
+.. automodule:: redis_consumer.consumers.image_consumer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:
+
+redis_consumer.consumers.tracking_consumer module
+-------------------------------------------------
+
+.. automodule:: redis_consumer.consumers.tracking_consumer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:
+
+
+Module contents
+---------------
+
 .. automodule:: redis_consumer.consumers
     :members:
     :undoc-members:
     :show-inheritance:
-    :private-members:
+    :private-members:

docs/source/redis_consumer.grpc_clients.rst

@@ -4,4 +4,4 @@ redis_consumer.grpc_clients module
 .. automodule:: redis_consumer.grpc_clients
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

docs/source/redis_consumer.processing.rst

@@ -4,4 +4,4 @@ redis_consumer.processing module
 .. automodule:: redis_consumer.processing
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

docs/source/redis_consumer.redis.rst

@@ -4,4 +4,4 @@ redis_consumer.redis module
 .. automodule:: redis_consumer.redis
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

docs/source/redis_consumer.storage.rst

@@ -4,4 +4,4 @@ redis_consumer.storage module
 .. automodule:: redis_consumer.storage
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

docs/source/redis_consumer.tracking.rst

@@ -4,4 +4,4 @@ redis_consumer.tracking module
 .. automodule:: redis_consumer.tracking
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

docs/source/redis_consumer.utils.rst

@@ -4,4 +4,4 @@ redis_consumer.utils module
 .. automodule:: redis_consumer.utils
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

pytest.ini

@@ -9,9 +9,10 @@ filterwarnings =
     ignore::PendingDeprecationWarning
 
 # Do not run tests in the build folder
-norecursedirs= 
+norecursedirs=
     build
     redis_consumer/pbs
+    docs
 
 
 # PEP-8 The following are ignored:

redis_consumer/consumers/__init__.py

@@ -0,0 +1,41 @@
+# Copyright 2016-2019 The Van Valen Lab at the California Institute of
+# Technology (Caltech), with support from the Paul Allen Family Foundation,
+# Google, & National Institutes of Health (NIH) under Grant U24CA224309-01.
+# All rights reserved.
+#
+# Licensed under a modified Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.github.com/vanvalenlab/kiosk-redis-consumer/LICENSE
+#
+# The Work provided may be used for non-commercial academic purposes only.
+# For any other use of the Work, including commercial use, please contact:
+# vanvalenlab@gmail.com
+#
+# Neither the name of Caltech nor the names of its contributors may be used
+# to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ============================================================================
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+# Base class consumers
+from redis_consumer.consumers.base_consumer import Consumer
+from redis_consumer.consumers.base_consumer import TensorFlowServingConsumer
+from redis_consumer.consumers.base_consumer import ZipFileConsumer
+
+# Custom Workflow consumers
+from redis_consumer.consumers.image_consumer import ImageFileConsumer
+from redis_consumer.consumers.tracking_consumer import TrackingConsumer
+
+del absolute_import
+del division
+del print_function