updated show_version list and warning to devs

Ouranosinc · Nov 7, 2023 · 04c5119 · 04c5119
1 parent 1ce1f47
commit 04c5119
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 28 deletions.
diff --git a/environment-dev.yml b/environment-dev.yml
@@ -3,7 +3,8 @@ channels:
   - conda-forge
 dependencies:
   - python >=3.9
-  # Don't forget to sync the changes here with environment-dev.yml!
+  # Don't forget to sync changes between environment.yml, environment-dev.yml, and setup.py!
+  # Also consider updating the list in xs.utils.show_versions if you add a new package.
   # Main packages
   - cartopy
   - cftime

diff --git a/environment.yml b/environment.yml
@@ -3,7 +3,8 @@ channels:
   - conda-forge
 dependencies:
   - python >=3.9
-  # Don't forget to sync the changes here with environment-dev.yml!
+  # Don't forget to sync changes between environment.yml, environment-dev.yml, and setup.py!
+  # Also consider updating the list in xs.utils.show_versions if you add a new package.
   # Main packages
   - cartopy
   - cftime

diff --git a/setup.py b/setup.py
@@ -36,6 +36,8 @@ def run(self):
 # This list are the minimum requirements for xscen
 # this is only meant to make `pip check` work
 # xscen dependencies can only be installed through conda-forge.
+# Don't forget to sync changes between environment.yml, environment-dev.yml, and setup.py!
+# Also consider updating the list in xs.utils.show_versions if you add a new package.
 requirements = [
     "cartopy",
     "cftime",

diff --git a/xscen/utils.py b/xscen/utils.py
@@ -1183,35 +1183,45 @@ def show_versions(
     """
     if deps is None:
         deps = [
-            "zarr",
-            "yaml",
-            "xesmf",
-            "xcollection",
-            "xclim",
-            "xarray",
-            "sparse",
-            "shapely",
-            "requests",
+            "xscen",
+            # Main packages
+            "cartopy",
+            "cftime",
+            "cf_xarray",
+            "clisops",
+            "dask",
+            "flox",
+            "fsspec",
+            "geopandas",
+            "h5netcdf",
+            "h5py",
+            "intake_esm",
+            "matplotlib",
+            "netCDF4",
+            "numpy",
+            "pandas",
+            "parse",
+            "pyyaml",
             "rechunker",
-            "pydantic",
+            "shapely",
+            "sparse",
+            "toolz",
+            "xarray",
+            "xclim",
+            "xesmf",
+            "zarr",
+            # For translations
+            "babel",
+            # Opt
+            "nc-time-axis",
             "pyarrow",
-            "parse",
-            "pandas",
-            "netCDF4",
-            "nc_time_axis",
-            "matplotlib",
-            "intake_esm",
-            "intake",
-            "h5py",
-            "h5netcdf",
-            "geopandas",
-            "fsspec",
+            # Extras specific to this function
             "fastprogress",
-            "dask",
-            "clisops",
-            "cftime",
-            "cartopy",
-            "xscen",
+            "intake",
+            "pydantic",
+            "requests",
+            "xcollection",
+            "yaml",
         ]
 
     return _show_versions(file=file, deps=deps)