Add download-examples CLI command for all notebooks (#241)

Author: calexat-123

MANIFEST.in

@@ -12,6 +12,10 @@ prune examples
 prune img
 
 exclude xrspatial/_version.py
+exclude xrspatial/__pycache__/*
+exclude xrspatial/examples/*
+exclude xrspatial/examples/user_guide/*
+exclude xrspatial/examples/user_guide_idea/*
 exclude tile_idea.py
 exclude *.yml
 exclude *.enc
@@ -21,3 +25,4 @@ exclude *.dot
 exclude *.gif
 exclude *.svg
 exclude tox.ini
+exclude test_examples_cli.py

README.md

@@ -205,3 +205,4 @@ With the introduction of projects like Numba, Python gained new ways to provide
 - @chase-dwelle
 - @SAN154
 - @SapirLastimoza-Dooley
+- @lex-c

conda.recipe/build.sh

@@ -3,8 +3,7 @@
 set -e
 set -x
 
-BLD_DIR=`pwd`
-
+BLD_DIR='pwd'
 SRC_DIR=$RECIPE_DIR/..
 pushd $SRC_DIR
 

conda.recipe/meta.yaml

@@ -1,20 +1,30 @@
+{% set sdata = load_setup_py_data() %}
 
 package:
   name: xarray-spatial
   version: 0.1.2
 
+source:
+  path: ..
+  
 requirements:
-  build:
+  host:
     - python
     - setuptools
-
+    - pyct
   run:
     - python
-    - datashader
+    {% for dep in sdata.get('install_requires', {}) %}
+    - {{ dep }}
+    {% endfor %}
 
+# will need the extras_require['tests'] deps below once those are added in setup.py
 test:
   requires:
     - pytest >=2.8.5
+    # {% for dep in sdata['extras_require']['tests'] %}
+    # - {{ dep }}
+    # {% endfor %}
   imports:
     - xrspatial
 

examples/datasets.yml

@@ -0,0 +1,15 @@
+---
+
+data:
+  - url: https://xarrayspatial.blob.core.windows.net/examples-data/facilities.csv
+    title: 'Pharmacy Facilities Data'
+    files:
+      - facilities.csv
+  - url: https://xarrayspatial.blob.core.windows.net/examples-data/USA_Block_Groups-shp.zip/USA_Block_Groups.shp
+    title: 'USA Block Groups Shapefile'
+    files:
+      - USA_Block_Groups.shp
+  - url: https://xarrayspatial.blob.core.windows.net/examples-data/USA_Counties-shp.zip/USA_Counties.shp
+    title: 'USA Counties Shapefile'
+    files:
+      - USA_Counties.shp

pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    'pyct >= 0.4.8',
+    'setuptools >= 54.1.2',
+    'wheel >= 0.36.2',
+]

record.txt

@@ -1,28 +1,80 @@
+import os, sys
+import shutil
 from setuptools import setup
+import pkg_resources
 
+# build dependencies
+import pyct.build
 
-setup(name='xarray-spatial',
-      use_scm_version={
-        "write_to": "xrspatial/_version.py",
-        "write_to_template": '__version__ = "{version}"',
-        "tag_regex": r"^(?P<prefix>v)?(?P<version>[^\+]+)(?P<suffix>.*)?$",
-      },
-      description='xarray-based spatial analysis tools',
-      packages=['xrspatial',
-                'xrspatial.tests'],
-      install_requires=[
-        'dask',
-        'datashader',
-        'numba',
-        'numpy',
-        'pandas',
-        'pillow',
-        'requests',
-        'scipy',
-        'xarray',
-        ],
-      zip_safe=False,
-      classifiers=["Programming Language :: Python :: 3",
-                   "License :: OSI Approved :: MIT License",
-                   "Operating System :: OS Independent"],
-      include_package_data=True)
+# dependencies
+
+# datashader first, then pyct unless pyct version compatible with ds is specified
+# spatialpandas may not be required in final pharmacy_desert version
+# pyct may not be required after pyctdev is released
+install_requires = [
+    'dask',
+    'datashader',
+    'numba',
+    'numpy',
+    'pandas',
+    'pillow',
+    'requests',
+    'scipy',
+    'xarray',
+    'pyct',
+    ]
+
+examples = [
+  'spatialpandas',
+]
+
+# Additional tests dependencies and examples_extra may be needed in the future
+extras_require = {
+  'tests': [
+    'pytest',
+  ],
+  'examples': examples,
+}
+
+# additional doc dependencies may be needed
+extras_require['doc'] = extras_require['examples'] + ['numpydoc']
+
+extras_require['all'] = sorted(set(sum(extras_require.values(), [])))
+
+# metadata for setuptools
+
+setup_args = dict(
+  name='xarray-spatial',
+  use_scm_version={
+    "write_to": "xrspatial/_version.py",
+    "write_to_template": '__version__ = "{version}"',
+    "tag_regex": r"^(?P<prefix>v)?(?P<version>[^\+]+)(?P<suffix>.*)?$",
+  },
+  description='xarray-based spatial analysis tools',
+  install_requires=install_requires,
+  extras_require=extras_require,
+  tests_require=extras_require['tests'],
+  zip_safe=False,
+  classifiers=["Programming Language :: Python :: 3",
+               "License :: OSI Approved :: MIT License",
+               "Operating System :: OS Independent"],
+  packages=['xrspatial',
+            'xrspatial.tests'
+            ],
+  include_package_data=True,
+  entry_points={
+    'console_scripts': [
+      'xrspatial = xrspatial.__main__:main'
+    ]
+  },
+)
+
+if __name__ == '__main__':
+  example_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 
+                                              'xrspatial', 'examples')
+  if 'develop' not in sys.argv:
+    pyct.build.examples(example_path, __file__, force=True)
+  setup(**setup_args)
+  
+  if os.path.isdir(example_path):
+    shutil.rmtree(example_path)

setup.py

@@ -0,0 +1,21 @@
+import sys
+from xrspatial import __main__ as m
+from unittest.mock import patch
+
+
+# test_args include copy-examples, fetch-data, or examples (does both)
+def run_examples_cmds(*cli_cmds):
+    
+    """
+
+    Run conda package cli commands to download examples and fetch data for notebooks
+    Parameters: 'copy-examples', 'fetch-data', 'examples'
+    Output: downloads examples and data to new xrspatial-examples directory in xarray-spatial
+
+    """
+
+    for arg in cli_cmds:
+        with patch.object(sys, 'argv', ['xrspatial', arg]):
+            m.main()
+
+run_examples_cmds('examples')

test_examples_cli.py

@@ -0,0 +1,14 @@
+import os
+
+def main(args=None):
+    try:
+        import pyct.cmd
+    except ImportError:
+        import sys
+        from . import _missing_cmd
+        print(_missing_cmd())
+        sys.exit(1)
+    return pyct.cmd.substitute_main('xrspatial',args=args)
+
+if __name__ == "__main__":
+    main()