Merge pull request #154 from ODM2/release/0.7.1

Release/0.7.1
ODM2 · Mar 2, 2018 · 9945421 · 9945421
2 parents b8d76f6 + ce39ac4
commit 9945421
Show file tree

Hide file tree

Showing 20 changed files with 3,878 additions and 3,751 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -39,8 +39,6 @@ matrix:
   - python: 3.6
     env: TEST_TARGET=docs
   allow_failures:
-  - python: 2.7
-    env: TEST_TARGET=coding_standards
   - python: 3.6
     env: TEST_TARGET=default
 

diff --git a/README.md b/README.md
@@ -38,17 +38,17 @@ source activate myenv  # On MacOSX or Linux
 but they haven't been tested thoroughly.
 
 
-### Latest release, from ODM2 anaconda.org channel
+### Latest release, from conda-forge anaconda.org channel
 
 The
 [latest `odm2api` release](https://github.com/ODM2/ODM2PythonAPI/releases)
 is available on the
-[ODM2 anaconda.org channel](https://anaconda.org/odm2/odm2api)
+[conda-forge anaconda.org channel](https://anaconda.org/conda-forge/odm2api)
 for all major OS paltforms (linux, OSX, win32/win64).
 To install it on an existing conda environment:
 
 ```
-conda install -c odm2 odm2api
+conda install -c conda-forge odm2api
 ```
 
 All dependencies are installed,
@@ -57,33 +57,38 @@ including Pandas and its dependencies (numpy, etc).
 To create a new environment "myenv" with the `odm2api` package:
 
 ```
-conda create -n myenv -c odm2 python=2.7 odm2api
+conda create -n myenv -c conda-forge python=2.7 odm2api
 ```
 
-### Installing the development version from the `master` branch on github
-
-**Note from 4/26/2016:** These instructions may be slightly outdated.
-Follow these directions for installing the bleeding edge GitHub master branch,
-mainly for development and testing purposes.
-
-To create a new environment "myenv" with `odm2api`,
-first download the conda environment file
-[condaenvironment_1.yml](https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/condaenvironment_1.yml).
-Go to the directory where `condaenvironment_1.yml` was downloaded.
-Then, on a terminal shell:
-
-```bash
-conda env create -n myenv --file py2_conda_environment.yml
-```
-
-Activate the new environment, then install `odm2api` into the environment:
-
-```bash
-activate myenv  # On Windows
-source activate myenv  # On MacOSX or Linux
-
-pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI.git
-```
+### Installing the development version from the `development` branch on github
+
+Note: We follow the [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for development.
+
+1. Download both `requirements.txt` and `requirements-dev.txt`.
+    ``` bash
+    wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements.txt
+    wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements-dev.txt
+    ```
+
+2. Create conda environment `odm2api_dev` from the two `requirements*` text files.
+    ```bash
+    conda create -n odm2api_dev -c conda-forge python=2.7 --file requirements.txt --file requirements-dev.txt
+    ```
+
+3. Activate conda environment.
+   - MacOSX/Linux:
+   ```bash
+   source activate odm2api_dev
+   ```
+   - Windows:
+   ```
+   activate odm2api_dev
+   ```
+    
+4. Install the latest commit from the development branch
+    ```bash
+    pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development#egg=odm2api
+    ```
 
 ## Credits
 

diff --git a/docs/source/installing.rst b/docs/source/installing.rst
@@ -12,7 +12,7 @@ OS X and Linux, it's something like
 
 To activate a conda environment, say, "myenv":
 
-.. code:: bash
+.. code-block:: bash
 
     activate myenv  # On Windows
     source activate myenv  # On MacOSX or Linux
@@ -21,17 +21,17 @@ To activate a conda environment, say, "myenv":
 changes have been made to support Python 3.x, but they haven't been
 tested thoroughly.
 
-Latest release, from ODM2 anaconda.org channel
+Latest release, from conda-forge anaconda.org channel
 ----------------------------------------------
 
-The `latest release <https://github.com/ODM2/ODM2PythonAPI/releases>`__ is available
-on the `ODM2 anaconda.org channel <https://anaconda.org/odm2/odm2api>`__
+The `latest release <https://github.com/ODM2/ODM2PythonAPI/releases>`_ is available
+on the `conda-forge anaconda.org channel <https://anaconda.org/conda-forge/odm2api>`_
 for all major OS platforms (linux, OS X, win32/win64). To install it on
 an existing conda environment:
 
 ::
 
-    conda install odm2api --channel odm2
+    conda install -c conda-forge odm2api
 
 All dependencies are installed, including Pandas and its dependencies
 (numpy, etc).
@@ -40,23 +40,42 @@ To create a new environment "myenv" with the ``odm2api`` package:
 
 ::
 
-    conda create -n myenv -c odm2 python=2.7 odm2api
+    conda create -n myenv -c conda-forge python=2.7 odm2api
 
 
-Installing the development version
+Installing the development version from the ``development`` branch on github
 ----------------------------------
 
-To create a new environment "myenv" with ``odm2api``, first clone the repository.
-Then, on a terminal shell:
-
-.. code:: bash
-
-    conda create --name myenv python=2.7 --file requirements.txt --file requirements-dev.txt -c odm2
-
-Activate the new environment, then install ``odm2api`` into the
-environment:
-
-.. code:: bash
-
-    activate myenv  # On Windows
-    source activate myenv  # On OS X or Linux
+Note: We follow the `Gitflow workflow <https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow>`__ for development.
+
+1. Download both ``requirements.txt`` and ``requirements-dev.txt``.
+
+   .. code-block:: bash
+   
+       wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements.txt
+       wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements-dev.txt
+
+2. Create conda environment ``odm2api_dev`` from the two ``requirements*`` text files.
+
+   .. code-block:: bash
+  
+       conda create -n odm2api_dev -c conda-forge python=2.7 --file requirements.txt --file requirements-dev.txt
+
+3. Activate conda environment.
+   - MacOSX/Linux:
+
+   .. code-block:: bash
+       
+       source activate odm2api_dev
+   
+   - Windows:
+
+   .. code-block:: bash
+      
+       activate odm2api_dev
+    
+4. Install the latest commit from the development branch
+
+   .. code-block:: bash
+      
+       pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development#egg=odm2api
diff --git a/docs/source/models.rst b/docs/source/models.rst
@@ -12,16 +12,16 @@ The following are entities in the `ODM2 Core Schema <http://odm2.github.io/ODM2/
 
 .. autosummary::
 
-   odm2api.ODM2.models.Actions
-   odm2api.ODM2.models.DataSets
-   odm2api.ODM2.models.FeatureActions
-   odm2api.ODM2.models.Methods
-   odm2api.ODM2.models.Organizations
-   odm2api.ODM2.models.People
-   odm2api.ODM2.models.ProcessingLevels
-   odm2api.ODM2.models.RelatedActions
-   odm2api.ODM2.models.Results
-   odm2api.ODM2.models.SamplingFeatures
-   odm2api.ODM2.models.TaxonomicClassifiers
-   odm2api.ODM2.models.Units
-   odm2api.ODM2.models.Variables
+   odm2api.models.Actions
+   odm2api.models.DataSets
+   odm2api.models.FeatureActions
+   odm2api.models.Methods
+   odm2api.models.Organizations
+   odm2api.models.People
+   odm2api.models.ProcessingLevels
+   odm2api.models.RelatedActions
+   odm2api.models.Results
+   odm2api.models.SamplingFeatures
+   odm2api.models.TaxonomicClassifiers
+   odm2api.models.Units
+   odm2api.models.Variables
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -21,31 +21,31 @@ This part of the documentation covers all the interfaces of ODM2PythonAPI.
 :mod:`Read Services`
 ---------------------
 
-.. automodule:: odm2api.ODM2.services.readService
+.. automodule:: odm2api.services.readService
    :members:
    :undoc-members:
    :show-inheritance:
 
 :mod:`Create Services`
 -----------------------
 
-.. automodule:: odm2api.ODM2.services.createService
+.. automodule:: odm2api.services.createService
    :members:
    :undoc-members:
    :show-inheritance:
 
 :mod:`Delete Services`
 -----------------------
 
-.. automodule:: odm2api.ODM2.services.deleteService
+.. automodule:: odm2api.services.deleteService
    :members:
    :undoc-members:
    :show-inheritance:
 
 :mod:`Update Services`
 -----------------------
 
-.. automodule:: odm2api.ODM2.services.updateService
+.. automodule:: odm2api.services.updateService
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/odm2models.rst b/docs/source/odm2models.rst
@@ -1,7 +1,7 @@
 ODM2 Models
 ===========
 
-.. automodule:: odm2api.ODM2.models
+.. automodule:: odm2api.models
    :members:
    :undoc-members:
    :show-inheritance: