Merge pull request #24 from ocefpaf/release

Preparing for first release

.gitattributes

@@ -0,0 +1 @@
+odvc/_version.py export-subst

.stickler.yml

@@ -0,0 +1,6 @@
+linters:
+  flake8:
+    max-line-length: 100
+    max-complexity: 10
+files:
+  ignore: ['*.ipynb', 'conf.py', '_version.py', 'versioneer.py']

.travis.yml

@@ -1,17 +1,56 @@
 language: python
 
-env:
-    - CONDA="python=2.7"
-    - CONDA="python=3.4"
+sudo: false
+
+cache:
+  directories:
+    - $HOME/miniconda
+
+# Removing the directory will remove the env but leave the cached packages
+# at $HOME/miniconda/pkgs. That is a win-win because when re-creating the
+# env we will download only the new packages.
+before_cache:
+  - rm -rf $HOME/miniconda/envs/TEST
+
+matrix:
+  fast_finish: true
+  include:
+  - python: 2.7
+    env: TEST_TARGET=default
+  - python: 3.6
+    env: TEST_TARGET=default
+  - python: 3.5
+    env: TEST_TARGET=default
+  - python: 3.6
+    env: TEST_TARGET=coding_standards
 
 before_install:
-    - wget http://bit.ly/miniconda -O miniconda.sh
-    - bash miniconda.sh -b -p $HOME/miniconda
-    - export PATH="$HOME/miniconda/bin:$PATH"
-    - conda update --yes conda
-    - travis_retry conda create --yes -n test $CONDA --file requirements.txt
-    - source activate test
-    - travis_retry conda install pytest
+  - |
+    echo ""
+    if [ ! -f $HOME/miniconda/bin/conda ] ; then
+      echo "Fresh miniconda installation."
+      wget http://bit.ly/miniconda -O miniconda.sh
+      rm -rf $HOME/miniconda
+      bash miniconda.sh -b -p $HOME/miniconda
+    fi
+
+  - export PATH="$HOME/miniconda/bin:$PATH"
+  - conda config --set always_yes yes --set changeps1 no --set show_channel_urls true
+  - conda update conda
+  - conda config --add channels conda-forge --force
+  - conda create -n TEST python=$TRAVIS_PYTHON_VERSION --file requirements.txt --file requirements-dev.txt
+  - source activate TEST
+
+install:
+  - python setup.py sdist && version=$(python setup.py --version) && pushd dist  && pip install odvc-${version}.tar.gz && popd
 
 script:
-    - python setup.py test
+  - if [[ $TEST_TARGET == 'default' ]]; then
+      py.test -s -rxs -v test;
+    fi
+
+  - if [[ $TEST_TARGET == 'coding_standards' ]]; then
+      flake8 odvc --max-line-length=100 --exclude _version.py ;
+      flake8 test --max-line-length=100 ;
+    fi
+

CHANGES.txt

@@ -1,6 +1,6 @@
 Changelog
 ---------
 
-Version 0.0.1
+Version 0.1.0
 
 * First version

LICENSE.txt

@@ -1,22 +1,11 @@
-The MIT License (MIT)
+Copyright 2017 Filipe Fernandes
 
-Copyright (c) 2015 pyoceans
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -1,3 +1,4 @@
 include README.rst
 include *.txt
 include odvc/*.py
+include versioneer.py

README.rst

@@ -1,4 +1,14 @@
 odvc
 ------
 
+.. image:: https://travis-ci.org/ioos/odvc.svg?branch=master
+    :target: https://travis-ci.org/ioos/odvc
+
 Ocean Dimensionless Vertical Coordinates
+
+CAVEAT: this package is not ready for production use!
+
+The `formulas.py` works also as a guide on how to code the CF Ocean Dimensionless Vertical Coordinates in Python,
+while `utils.py` contains a few handy functions to use the formulas with dask arrays.
+
+For more information on how to integrate this into your project see the iris package vertical coordinates.

odvc/__init__.py

@@ -1,9 +1,28 @@
 # -*- coding: utf-8 -*-
 
-from __future__ import (absolute_import, division, print_function,
-                        unicode_literals)
+from __future__ import absolute_import, division, print_function
 
-from .utils import *
-from .formulas import *
+from . import utils
+from ._version import get_versions
+from .formulas import (
+    ocean_double_sigma_coordinate,
+    ocean_s_coordinate,
+    ocean_s_coordinate_g1,
+    ocean_s_coordinate_g2,
+    ocean_sigma_coordinate,
+    ocean_sigma_z_coordinate,
+)
 
-__version__ = '0.0.1'
+
+__version__ = get_versions()['version']
+del get_versions
+
+__all__ = [
+    utils,
+    ocean_double_sigma_coordinate,
+    ocean_sigma_z_coordinate,
+    ocean_sigma_coordinate,
+    ocean_s_coordinate,
+    ocean_s_coordinate_g1,
+    ocean_s_coordinate_g2
+]