Merge pull request #913 from compas-dev/planarity-pip-extra

Change planarity to requires extra for pip installs

Author: tomvanmele

CHANGELOG.md

@@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * `compas_blender.artists.RobotModelArtist.collection` can be assigned as a Blender collection or a name.
 * Generalized the parameter `color` of `compas_blender.draw_texts` and various label drawing methods.
 * Changed `compas.IPY` to `compas.RHINO` in `orientation_rhino`.
+* Changed `planarity` to `requires_extra` for pip installations.
 
 ### Removed
 

docs/installation.rst

@@ -79,6 +79,17 @@ Note that installation with ``pip`` is also possible within a ``conda`` environm
     conda activate my-project
     pip install -e .
 
+By default, ``planarity`` is marked as an optional requirement for installation with ``pip`` on Windows.
+To include ``planarity``, add a conditional to the install command.
+
+.. code-block:: bash
+
+    pip install compas[planarity]
+
+.. code-block:: bash
+
+    pip install -e .[planarity]
+
 
 Update with conda
 =================

requirements.txt

@@ -12,7 +12,7 @@ networkx
 numba
 numpy >= 1.15.4
 pillow
-planarity
+planarity ; sys_platform != 'win32'
 pycollada
 schema
 jsonschema

setup.py

@@ -66,7 +66,9 @@ def read(*names, **kwargs):
     zip_safe=False,
     install_requires=requirements,
     python_requires='>=2.7',
-    extras_require=optional_requirements,
+    extras_require={
+        'planarity': ['planarity'],
+    },
     entry_points={
         'console_scripts': [
             'compas_rpc=compas.rpc.__main__:main'

src/compas/datastructures/network/planarity.py

@@ -8,16 +8,11 @@
 
 from itertools import product
 
-import compas
-
 from compas.geometry import angle_vectors_xy
 from compas.geometry import is_intersection_segment_segment_xy
 from compas.geometry import is_ccw_xy
 from compas.geometry import subtract_vectors_xy
 
-if not compas.IPY:
-    import planarity
-
 
 __all__ = [
     'network_is_crossed',
@@ -198,6 +193,12 @@ def network_is_planar(network):
     --------
     >>>
     """
+    try:
+        import planarity
+    except ImportError:
+        print("Planarity is not installed.")
+        raise
+
     return planarity.is_planar(list(network.edges()))
 
 

tests/compas/datastructures/test_network.py

@@ -1,6 +1,5 @@
 import pytest
 
-import compas
 from compas.datastructures import Network
 
 
@@ -33,15 +32,19 @@ def test_add_node():
 
 
 def test_non_planar(k5_network):
-    if compas.IPY:
+    try:
+        import planarity  # noqa: F401
+    except ImportError:
         return
 
     from compas.datastructures import network_is_planar
     assert network_is_planar(k5_network) is not True
 
 
 def test_planar(k5_network):
-    if compas.IPY:
+    try:
+        import planarity  # noqa: F401
+    except ImportError:
         return
 
     from compas.datastructures import network_is_planar