Ready: Fix examples download cli cmd (#349)

* edit versioning in setup.py to fix examples download issue

* edit manifest to pass travis

* edit manifest, setup, and version to fix versioning and include for conda build

* fix versioning: single source of truth from setup.py param get_setup_version; split version string for conda and pip install; set check manifest ignore xrspatial/examples in pyproject.toml

* check tag for version

* add change for tags

* test git tags for version source

* flake8 setup.py fix indent

* test out single-source version from tags

* fix versioning for pip packaging and put explicit version in conda.recipe meta.yaml. Add test script for pip packaging new version generation and examples download

* add line in MANIFEST

* add gitattributes

* edit versioning formatting and add test pip packaging edits

* placate flake8

* give it back to xrs

Co-authored-by: Brendan Collins <brendan@makepath.com>

Author: calexat-123

.gitattributes

@@ -0,0 +1,2 @@
+__init__.py export-subst
+setup.py export-subst

.gitignore

@@ -28,6 +28,7 @@ share/python-wheels/
 MANIFEST
 xrspatial/_version.py
 
+
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.

MANIFEST.in

@@ -2,6 +2,8 @@ include *.txt
 include *.md
 
 graft xrspatial
+graft xrspatial/examples
+graft xrspatial/examples/user_guide
 
 prune docs
 prune *.egg-info
@@ -11,13 +13,15 @@ prune conda.recipe
 prune img
 prune .idea
 
-include xrspatial/examples/*
-include xrspatial/examples/user_guide/*
-
 exclude examples/.ipynb_checkpoints/*
+exclude examples/user_guide/.ipynb_checkpoints/*
 exclude xrspatial/_version.py
+exclude xrspatial/.DS_Store
+exclude xrspatial/.version
 exclude xrspatial/__pycache__/*
-exclude xrspatial/examples/user_guide_idea/*
+exclude xrspatial/tests/__pycache__/*
+exclude xrspatial/tests/.DS_Store
+exclude xrspatial/tests/_qgis_results/__pycache__/*
 exclude tile_idea.py
 exclude *.enc
 exclude .gitignore
@@ -32,4 +36,6 @@ include *.yml
 recursive-include examples *.gif
 recursive-include examples *.ipynb
 recursive-include examples *.py
-recursive-include examples *.yml
+recursive-include examples *.yml
+recursive-include test_pip_packaging *.py
+recursive-include test_pip_packaging *.sh

conda.recipe/meta.yaml

@@ -2,29 +2,30 @@
 
 package:
   name: xarray-spatial
-  version: 0.2.0
+  version: "0.2.0"
+
 
 source:
   path: ..
 
 requirements:
   host:
     - python
-    - setuptools
+    - setuptools >=46.4.0
     - pyct
+    - param
   run:
     - python
     {% 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 %}
+     {% for dep in sdata['extras_require']['tests'] %}
+     - {{ dep }}
+     {% endfor %}
   imports:
     - xrspatial
 

pyproject.toml

@@ -3,4 +3,6 @@ requires = [
     'pyct >= 0.4.8',
     'setuptools >= 54.1.2',
     'wheel >= 0.36.2',
-]
+]
+[tool.check-manifest]
+ignore = ["xrspatial/examples/*", "xrspatial/examples/user_guide/*"]

setup.py

@@ -3,8 +3,10 @@
 import shutil
 from setuptools import setup
 
+
 # build dependencies
 import pyct.build
+import param
 
 # dependencies
 
@@ -23,6 +25,8 @@
     'scipy',
     'xarray',
     'pyct <=0.4.6',
+    'param >=1.6.1',
+    'distributed >=2021.03.0',
     'spatialpandas'
 ]
 
@@ -42,15 +46,25 @@
 
 extras_require['all'] = sorted(set(sum(extras_require.values(), [])))
 
+version = param.version.get_setup_version(__file__, 'xarray-spatial',
+                                          pkgname='xrspatial',
+                                          archive_commit="$Format:%h$")
+
+if 'sdist' in sys.argv and 'bdist_wheel' in sys.argv:
+    try:
+        version_test = version.split('.post')[1]
+        version = version.split('.post')[0]
+    except IndexError:
+        version = version.split('+')[0]
+    if version is None:
+        sys.exit('invalid version')
+
+
 # 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>.*)?$',
-    },
+    version=version,
     description='xarray-based spatial analysis tools',
     install_requires=install_requires,
     extras_require=extras_require,
@@ -70,9 +84,10 @@
     },
 )
 
+
 if __name__ == '__main__':
     example_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),
-                                'xarray-spatial', 'examples')
+                                'xrspatial', 'examples')
     if 'develop' not in sys.argv:
         pyct.build.examples(example_path, __file__, force=True)
     setup(**setup_args)

test_pip_packaging/gen_tags.py

@@ -0,0 +1,41 @@
+import os
+import sys
+import param
+
+
+version_before = param.version.get_setup_version(
+    os.path.dirname(__file__),
+    'xarray-spatial',
+    pkgname='xrspatial',
+    archive_commit="$Format:%h$")
+
+version_digits = None
+
+try:
+    version_digits_test = version_before.split('.post')[1]
+    version_digits = version_before.split('.post')[0]
+except IndexError:
+    version_digits = version_before.rsplit('+')[0]
+
+if version_digits is None:
+    sys.exit('version digits not found; '
+             'check your git tags with cmd: git tag -l')
+
+digits_list = version_digits.split('.')
+
+if len(digits_list) < 3:
+    sys.exit('less than 3 digits in version')
+elif len(digits_list) == 4:
+    last_digit = digits_list[-1]
+    first_digits = '.'.join(digits_list[0], digits_list[1], digits_list[2])
+elif len(digits_list) == 3:
+    last_digit = '0'
+    first_digits = version_digits
+
+next_version = '.'.join([first_digits, str(int(last_digit) + 1)])
+
+if (len(next_version.split('.')) < 4 or
+        len(next_version.rsplit('.', 1)[0].split('.')) != 3):
+    sys.exit(f"next version not formatted correctly {next_version}")
+
+print(f'v{next_version}')

test_pip_packaging/test_ex_paths.sh

@@ -0,0 +1,55 @@
+#!/bin/bash
+
+# generates new package version, builds pip package,
+# uploads to pypi, creates new env and new dir,
+# installs xarray-spatial, runs examples, and ls
+# to see if correct files are in folder
+
+# clear previous build detritus
+rm -rf build/
+rm -rf dist/
+rm -rf xarray_spatial_*
+rm -f xrspatial/.version
+
+
+# change name of package
+
+
+# add tag
+version="$(python test_pip_packaging/gen_tags.py)"
+echo "$version"
+git tag -a "$version" -m new
+git push origin "$version"
+
+
+# clear previous tag
+#last_version="$(git describe --abbrev=0 --tags "$(git rev-list --tags --skip=1 --max-count=1)")"
+#echo "$last_version"
+#git tag -d "$last_version"
+#git push --delete origin "$last_version"
+
+
+# run sdist and upload twine
+python setup.py sdist bdist_wheel
+twine upload --username="$username" --password="$password" dist/*
+
+
+# test out in new env
+# conda deactivate
+# cd ..
+# mkdir test_cli || cd .
+# cd test_cli || exit
+# rm -rf xrspatial-examples
+# conda deactivate
+# conda create -n test_cli -y
+# conda activate test_cli
+# conda install -c anaconda pip -y
+# version_arr=(${version//v/ })
+# version_num=${version_arr[1]}
+# sleep 10s
+# pip install xarray-spatial=="$version_num"
+# xrspatial examples
+# pip uninstall xarray-spatial -y
+# ls xrspatial-examples
+# conda deactivate
+# cd ../xarray-spatial || exit

tox.ini

@@ -5,5 +5,5 @@ envlist = py{36,37,38}
 
 [testenv]
 description = Unit tests
-deps = -rrequirements.txt
+deps = requirements.txt
 commands = pytest

xrspatial/__init__.py

@@ -42,7 +42,7 @@
 from xrspatial.pathfinding import a_star_search  # noqa
 
 try:
-    from ._version import __version__
+    from .version import __version__
 except ImportError:
     __version__ = "unknown"