add ISSUE_TEMPLATE for github and xr.show_versions() (#1485)

* add ISSUE_TEMPLATE for github and xr.show_versions()

* fix Nio import

* print version info on appveyor

* use mod.__version__ for numpy/scipy

* add CONTRIBUTING.md

* whats new

* fix whatsnew

* update flake8 prompt to only run on python sources

* update travis to run flak8

* fix flake8

* flake8 fix

Author: Joe Hamman

.github/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing to xarray
+
+## Usage questions
+
+The best places to submit questions about how to use xarray are
+[Stack Overflow](https://stackoverflow.com/questions/tagged/python-xarray) and
+the [xarray Google group](https://groups.google.com/forum/#!forum/xarray).
+
+## Reporting issues
+
+When reporting issues please include as much detail as possible about your
+operating system, xarray version and python version. Whenever possible, please
+also include a brief, self-contained code example that demonstrates the problem.
+
+## Contributing code
+
+Thanks for your interest in contributing code to xarray!
+
+- If you are new to Git or Github, please take a minute to read through a few tutorials
+  on [Git](https://git-scm.com/docs/gittutorial) and [GitHub](https://guides.github.com/).
+- The basic workflow for contributing to xarray is:
+  1. [Fork](https://help.github.com/articles/fork-a-repo/) the xarray repository
+  2. [Clone](https://help.github.com/articles/cloning-a-repository/) the xarray repository to create a local copy on your computer:
+    ```
+    git clone [email protected]:${user}/xarray.git
+    cd xarray
+    ```
+  3. Create a branch for your changes
+    ```
+    git checkout -b name-of-your-branch
+    ```      
+  4. Make change to your local copy of the xarray repository
+  5. Commit those changes
+    ```
+    git add file1 file2 file3
+    git commit -m 'a descriptive commit message'
+    ```
+  6. Push your updated branch to your fork
+    ```
+    git push origin name-of-your-branch
+    ```
+  7. [Open a pull request](https://help.github.com/articles/creating-a-pull-request/) to the pydata/xarray repository.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+#### Code Sample, a copy-pastable example if possible
+
+```python
+# Your code here
+
+```
+#### Problem description
+
+[this should explain **why** the current behavior is a problem and why the expected output is a better solution.]
+
+#### Expected Output
+
+#### Output of ``xr.show_versions()``
+
+<details>
+# Paste the output here xr.show_versions() here
+
+</details>

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
  - [ ] Closes #xxxx
  - [ ] Tests added / passed
- - [ ] Passes ``git diff upstream/master | flake8 --diff``
+ - [ ] Passes ``git diff upstream/master **/*py | flake8 --diff``
  - [ ] Fully documented, including `whats-new.rst` for all changes and `api.rst` for new API

.travis.yml

@@ -86,9 +86,11 @@ install:
   - source activate test_env
   - conda list
   - python setup.py install
+  - python xarray/util/print_versions.py
 
 script:
   - py.test xarray --cov=xarray --cov-config ci/.coveragerc --cov-report term-missing --verbose $EXTRA_FLAGS
+  - git diff upstream/master **/*py | flake8 --diff --exit-zero || true
 
 after_success:
   - coveralls

appveyor.yml

@@ -31,15 +31,12 @@ install:
   # the parent CMD process).
   - "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
 
-  # Check that we have the expected version and architecture for Python
-  - "python --version"
-  - "python -c \"import struct; print(struct.calcsize('P') * 8)\""
-
   # install xarray and dependencies
   - "conda env create --file ./ci/requirements-%CONDA_ENV%.yml"
   - "activate test_env"
   - "conda list"
   - "python setup.py install"
+  - "python xarray/util/print_versions.py"
 
 build: false
 

ci/requirements-py27-cdat+pynio.yml

@@ -16,6 +16,7 @@ dependencies:
   - pathlib2
   - pynio
   - pytest
+  - flake8
   - mock
   - scipy
   - seaborn

ci/requirements-py27-min.yml

@@ -2,6 +2,7 @@ name: test_env
 dependencies:
   - python=2.7
   - pytest
+  - flake8
   - mock
   - numpy==1.11
   - pandas==0.18.0

ci/requirements-py27-windows.yml

@@ -11,6 +11,7 @@ dependencies:
   - netcdf4
   - pathlib2
   - pytest
+  - flake8
   - mock
   - numpy
   - pandas

ci/requirements-py34.yml

@@ -3,6 +3,7 @@ dependencies:
   - python=3.4
   - bottleneck
   - pytest
+  - flake8
   - pandas
   - pip:
     - coveralls

ci/requirements-py35.yml

@@ -10,6 +10,7 @@ dependencies:
   - matplotlib
   - netcdf4
   - pytest
+  - flake8
   - numpy
   - pandas
   - scipy

ci/requirements-py36-bottleneck-dev.yml

@@ -10,6 +10,7 @@ dependencies:
   - matplotlib
   - netcdf4
   - pytest
+  - flake8
   - numpy
   - pandas
   - scipy

ci/requirements-py36-condaforge-rc.yml

@@ -11,6 +11,7 @@ dependencies:
   - matplotlib
   - netcdf4
   - pytest
+  - flake8
   - numpy
   - pandas
   - seaborn

ci/requirements-py36-dask-dev.yml

@@ -8,6 +8,7 @@ dependencies:
   - matplotlib
   - netcdf4
   - pytest
+  - flake8
   - numpy
   - pandas
   - seaborn

ci/requirements-py36-netcdf4-dev.yml

@@ -10,6 +10,7 @@ dependencies:
   - h5netcdf
   - matplotlib
   - pytest
+  - flake8
   - numpy
   - pandas
   - scipy

ci/requirements-py36-pandas-dev.yml

@@ -11,6 +11,7 @@ dependencies:
   - matplotlib
   - netcdf4
   - pytest
+  - flake8
   - numpy
   - scipy
   - toolz

ci/requirements-py36.yml

@@ -10,6 +10,7 @@ dependencies:
   - matplotlib
   - netcdf4
   - pytest
+  - flake8
   - numpy
   - pandas
   - scipy

doc/whats-new.rst

@@ -217,6 +217,10 @@ Enhancements
   (:issue:`576`).
   By `Stephan Hoyer <https://github.com/shoyer>`_.
 
+- Added :py:func:`~xarray.show_versions` function to aid in debugging
+  (:issue:`1485`).
+  By `Joe Hamman` <https://github.com/jhamman>`_.
+
 - Support using an existing, opened netCDF4 ``Dataset`` with
   :py:class:`~xarray.backends.NetCDF4DataStore`. This permits creating an
   :py:class:`~xarray.Dataset` from a netCDF4 ``Dataset`` that has been opened using

xarray/__init__.py

@@ -28,6 +28,7 @@
                       'the source directory, please instead create a new '
                       'virtual environment (using conda or virtualenv) and '
                       'then install it in-place by running: pip install -e .')
+from .util.print_versions import show_versions
 
 from . import tutorial
 from . import ufuncs

xarray/util/__init__.py

@@ -0,0 +1,151 @@
+'''utility functions for printing version information
+
+
+see pandas/pandas/util/_print_versions.py'''
+import os
+import platform
+import sys
+import struct
+import subprocess
+import codecs
+import locale
+import importlib
+
+
+def get_sys_info():
+    "Returns system information as a dict"
+
+    blob = []
+
+    # get full commit hash
+    commit = None
+    if os.path.isdir(".git") and os.path.isdir("xarray"):
+        try:
+            pipe = subprocess.Popen('git log --format="%H" -n 1'.split(" "),
+                                    stdout=subprocess.PIPE,
+                                    stderr=subprocess.PIPE)
+            so, serr = pipe.communicate()
+        except:
+            pass
+        else:
+            if pipe.returncode == 0:
+                commit = so
+                try:
+                    commit = so.decode('utf-8')
+                except ValueError:
+                    pass
+                commit = commit.strip().strip('"')
+
+    blob.append(('commit', commit))
+
+    try:
+        (sysname, nodename, release,
+         version, machine, processor) = platform.uname()
+        blob.extend([
+            ("python", "%d.%d.%d.%s.%s" % sys.version_info[:]),
+            ("python-bits", struct.calcsize("P") * 8),
+            ("OS", "%s" % (sysname)),
+            ("OS-release", "%s" % (release)),
+            # ("Version", "%s" % (version)),
+            ("machine", "%s" % (machine)),
+            ("processor", "%s" % (processor)),
+            ("byteorder", "%s" % sys.byteorder),
+            ("LC_ALL", "%s" % os.environ.get('LC_ALL', "None")),
+            ("LANG", "%s" % os.environ.get('LANG', "None")),
+            ("LOCALE", "%s.%s" % locale.getlocale()),
+
+        ])
+    except:
+        pass
+
+    return blob
+
+
+def show_versions(as_json=False):
+    sys_info = get_sys_info()
+
+    deps = [
+        # (MODULE_NAME, f(mod) -> mod version)
+        ("xarray", lambda mod: mod.__version__),
+        ("pandas", lambda mod: mod.__version__),
+        ("numpy", lambda mod: mod.__version__),
+        ("scipy", lambda mod: mod.__version__),
+        # xarray optionals
+        ("netCDF4", lambda mod: mod.__version__),
+        # ("pydap", lambda mod: mod.version.version),
+        ("h5netcdf", lambda mod: mod.__version__),
+        ("Nio", lambda mod: mod.__version__),
+        ("bottleneck", lambda mod: mod.__version__),
+        ("cyordereddict", lambda mod: mod.__version__),
+        ("dask", lambda mod: mod.__version__),
+        ("matplotlib", lambda mod: mod.__version__),
+        ("cartopy", lambda mod: mod.__version__),
+        ("seaborn", lambda mod: mod.__version__),
+        # xarray setup/test
+        ("setuptools", lambda mod: mod.__version__),
+        ("pip", lambda mod: mod.__version__),
+        ("conda", lambda mod: mod.__version__),
+        ("pytest", lambda mod: mod.__version__),
+        # Misc.
+        ("IPython", lambda mod: mod.__version__),
+        ("sphinx", lambda mod: mod.__version__),
+    ]
+
+    deps_blob = list()
+    for (modname, ver_f) in deps:
+        try:
+            if modname in sys.modules:
+                mod = sys.modules[modname]
+            else:
+                mod = importlib.import_module(modname)
+            ver = ver_f(mod)
+            deps_blob.append((modname, ver))
+        except:
+            deps_blob.append((modname, None))
+
+    if (as_json):
+        try:
+            import json
+        except:
+            import simplejson as json
+
+        j = dict(system=dict(sys_info), dependencies=dict(deps_blob))
+
+        if as_json is True:
+            print(j)
+        else:
+            with codecs.open(as_json, "wb", encoding='utf8') as f:
+                json.dump(j, f, indent=2)
+
+    else:
+
+        print("\nINSTALLED VERSIONS")
+        print("------------------")
+
+        for k, stat in sys_info:
+            print("%s: %s" % (k, stat))
+
+        print("")
+        for k, stat in deps_blob:
+            print("%s: %s" % (k, stat))
+
+
+def main():
+    from optparse import OptionParser
+    parser = OptionParser()
+    parser.add_option("-j", "--json", metavar="FILE", nargs=1,
+                      help="Save output as JSON into file, pass in "
+                      "'-' to output to stdout")
+
+    (options, args) = parser.parse_args()
+
+    if options.json == "-":
+        options.json = True
+
+    show_versions(as_json=options.json)
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())