add matplotlib as a requirement (#80)

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 files: "inequality\/"
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.6.1"
+    rev: "v0.6.3"
     hooks:
       - id: ruff
       - id: ruff-format

README.md

@@ -27,6 +27,7 @@ $ conda install -c conda-forge inequality
 #### Requirements
 
 - libpysal
+- matplotlib
 - numpy
 - scipy
 

ci/310-oldest.yaml

@@ -5,13 +5,14 @@ dependencies:
   - python=3.10
   # required
   - libpysal=4.5
+  - matplotlib>=3.6
   - numpy=1.23
   - scipy=1.8
   # testing
-  - seaborn
-  - mapclassify
+  - codecov
   - geopandas
+  - mapclassify
   - pytest
   - pytest-cov
   - pytest-xdist
-  - codecov
+  - seaborn

ci/311-latest.yaml

@@ -5,12 +5,13 @@ dependencies:
   - python=3.11
   # required
   - libpysal
+  - matplotlib>=3.6
   - numpy
   - scipy
-  - seaborn
-  - mapclassify
   # testing
+  - codecov
+  - mapclassify
   - pytest
   - pytest-cov
   - pytest-xdist
-  - codecov
+  - seaborn

ci/312-dev.yaml

@@ -4,14 +4,17 @@ channels:
 dependencies:
   - python=3.12
   # testing
+  - codecov
   - pytest
   - pytest-cov
   - pytest-xdist
-  - codecov
   - seaborn
   - pip:
     # dev versions of packages
-    - --pre --index-url   https://pypi.anaconda.org/scientific-python-nightly-wheels/simple   --extra-index-url https://pypi.org/simple
+    - --pre \
+      --index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple \
+      --extra-index-url https://pypi.org/simple
+    - matplotlib
     - numpy
     - scipy
     - git+https://github.com/pysal/libpysal.git@main

ci/312-latest.yaml

@@ -5,15 +5,16 @@ dependencies:
   - python=3.12
   # required
   - libpysal
+  - matplotlib
   - numpy
   - scipy
   # testing
+  - codecov
+  - mapclassify
   - pytest
   - pytest-cov
   - pytest-xdist
-  - codecov
   - seaborn
-  - mapclassify
   # docs
   - nbsphinx
   - numpydoc

inequality/pen.py

@@ -16,7 +16,10 @@
 
 import math
 
+import matplotlib.patches as patches
+import matplotlib.pyplot as plt
 import numpy as np
+from mpl_toolkits.axes_grid1.inset_locator import inset_axes
 
 
 def _check_deps(caller="pen"):
@@ -26,8 +29,7 @@ def _check_deps(caller="pen"):
     Returns
     -------
     tuple
-        A tuple containing the imported modules (Seaborn, mapclassify,
-        Matplotlib pyplot, Matplotlib patches).
+        A tuple containing the imported modules (Seaborn, mapclassify, pandas).
     """
     try:
         import seaborn as sns
@@ -43,22 +45,14 @@ def _check_deps(caller="pen"):
         msg = f"{msg} Install it using `conda install -c conda-forge mapclassify`"
         raise ImportError(msg) from e
 
-    try:
-        import matplotlib.patches as patches
-        import matplotlib.pyplot as plt
-        from mpl_toolkits.axes_grid1.inset_locator import inset_axes
-    except ImportError as e:
-        msg = f"{caller} requires matplotlib. "
-        msg = f"{msg} Install it using `conda install -c conda-forge matplotlib`"
-        raise ImportError(msg) from e
     try:
         import pandas as pd
     except ImportError as e:
         msg = f"{caller} requires pandas. "
         msg = f"{msg} Install it using `conda install -c conda-forge pandas`"
         raise ImportError(msg) from e
 
-    return sns, mc, plt, patches, inset_axes, pd
+    return sns, mc, pd
 
 
 def pen(
@@ -111,7 +105,7 @@ def pen(
 
     """
 
-    sns, mc, plt, patches, inset_axes, pd = _check_deps()
+    sns, mc, pd = _check_deps()
 
     if ax is None:
         fig, ax = plt.subplots(1, 1, figsize=figsize)
@@ -260,7 +254,7 @@ def pengram(
     matplotlib.axes.Axes
         Matplotlib Axes objects for the combined choropleth and Pen's parade.
     """
-    sns, mc, plt, patches, inset_axes, pd = _check_deps()
+    sns, mc, pd = _check_deps()
 
     if ax is None:
         fig, ax = plt.subplots(figsize=figsize)

inequality/tests/test_pengram.py

@@ -43,12 +43,9 @@ def sample_gdf():
 
 def test_check_deps():
     """Test that _check_deps function imports all necessary dependencies."""
-    sns, mc, plt, patches, inset_axes, pd = _check_deps()
+    sns, mc, pd = _check_deps()
     assert sns is not None
     assert mc is not None
-    assert plt is not None
-    assert patches is not None
-    assert inset_axes is not None
     assert pd is not None
 
 

pyproject.toml

@@ -27,6 +27,7 @@ classifiers = [
 requires-python = ">=3.10"
 dependencies = [
     "libpysal>=4.5",
+    "matplotlib>=3.6",
     "numpy>=1.23",
     "scipy>=1.8",
 ]