Merge pull request #3 from acmiyaguchi/requirements

Add ubuntu 16.04 pinned dependencies

README.md

@@ -11,12 +11,30 @@ Install the following dependencies from the source, where the installation guide
 
 ### Install
 
-```
+```bash
 git clone https://github.com/ivapylibs/camera.git
 pip3 install -e camera/
 ```
 
+If you are installing the package on Ubuntu Xenial (16.04), then install the requirements file into a virtual environment using python3.7+.
+This requirements file includes both `improcessor` and `pptk`. 
+
+```bash
+# configure the virtual environment
+python3 -m venv venv
+source venv/bin/activate
+
+# install dependencies
+pip install -r requirements-ubuntu1604.txt
+```
+
+If you need to update dependencies, update the `.in` file and run the following command:
 
+```bash
+# install pip-tools
+pip install pip-tools
+pip-compile --output-file=requirements-ubuntu1604.txt requirements-ubuntu1604.in
+```
 
 ## Note:
 

requirements-ubuntu1604.in

@@ -0,0 +1,12 @@
+# requirements for ubuntu 16.04
+# run:
+#   pip-compile --output-file=requirements-ubuntu1604.txt requirements-ubuntu1604.in
+
+# also include optional viz requirements (pptk)
+-e file:./[viz]
+
+# dependency for the package
+improcessor@git+https://github.com/ivapylibs/improcessor@main
+
+# pin pyrealsense2 dependency to 2.38.1, which matches the latest package available for ubuntu 16.04
+pyrealsense2==2.38.1.2225

requirements-ubuntu1604.txt

@@ -0,0 +1,82 @@
+#
+# This file is autogenerated by pip-compile with Python 3.7
+# by the following command:
+#
+#    pip-compile --output-file=requirements-ubuntu1604.txt requirements-ubuntu1604.in
+#
+-e file:./
+    # via -r requirements-ubuntu1604.in
+cycler==0.11.0
+    # via matplotlib
+fonttools==4.38.0
+    # via matplotlib
+imageio==2.25.0
+    # via scikit-image
+improcessor @ git+https://github.com/ivapylibs/improcessor@main
+    # via -r requirements-ubuntu1604.in
+joblib==1.2.0
+    # via scikit-learn
+kiwisolver==1.4.4
+    # via matplotlib
+matplotlib==3.5.3
+    # via
+    #   camera
+    #   improcessor
+networkx==2.6.3
+    # via scikit-image
+numpy==1.21.6
+    # via
+    #   camera
+    #   imageio
+    #   improcessor
+    #   matplotlib
+    #   opencv-contrib-python
+    #   pptk
+    #   pywavelets
+    #   scikit-image
+    #   scikit-learn
+    #   scipy
+    #   tifffile
+opencv-contrib-python==4.5.5.62
+    # via
+    #   camera
+    #   improcessor
+packaging==23.0
+    # via
+    #   matplotlib
+    #   scikit-image
+pillow==9.4.0
+    # via
+    #   imageio
+    #   matplotlib
+    #   scikit-image
+pptk==0.1.0
+    # via camera
+pyparsing==3.0.9
+    # via matplotlib
+pyrealsense2==2.38.1.2225
+    # via
+    #   -r requirements-ubuntu1604.in
+    #   camera
+python-dateutil==2.8.2
+    # via matplotlib
+pywavelets==1.3.0
+    # via scikit-image
+scikit-image==0.19.3
+    # via improcessor
+scikit-learn==1.0.2
+    # via camera
+scipy==1.7.3
+    # via
+    #   scikit-image
+    #   scikit-learn
+six==1.16.0
+    # via python-dateutil
+threadpoolctl==3.1.0
+    # via scikit-learn
+tifffile==2021.11.2
+    # via scikit-image
+tqdm==4.64.1
+    # via camera
+typing-extensions==4.4.0
+    # via kiwisolver

setup.py

@@ -1,10 +1,21 @@
 from setuptools import setup
-setup(name='camera',
-  version   = '1.0',
-  description   = 'Classes implementing the runner interface for the commonly used cameras', 
-  url       = "https://github.com/ivapylibs/camera",
-  author    = 'IVALab',
-  packages  = ['camera'],
-  install_requires=['pyrealsense2', 'numpy', 'matplotlib','opencv-contrib-python==4.5.5.62', \
-    "sklearn", "tqdm"]
+
+setup(
+    name="camera",
+    version="1.1.0",
+    description="Classes implementing the runner interface for the commonly used cameras",
+    url="https://github.com/ivapylibs/camera",
+    author="IVALab",
+    packages=["camera"],
+    install_requires=[
+        "pyrealsense2",
+        "numpy",
+        "matplotlib",
+        "opencv-contrib-python==4.5.5.62",
+        "scikit-learn",
+        "tqdm",
+    ],
+    extras_require={
+      "viz": ["pptk"]
+    }
 )