Skip to content

Release/0.7.1 #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Mar 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
8a0deb4
Implemented Eager Loading for samplingfeaturedataset query.
Elijahwalkerwest Jan 18, 2018
16b6794
Removed commented old code.
Elijahwalkerwest Jan 19, 2018
93c2427
Had a stray character, removed it as well as some useless imports
Elijahwalkerwest Jan 19, 2018
0613a39
Merge branch 'development' into samplingfeaturedataset_dev
Elijahwalkerwest Jan 19, 2018
441890e
Remove allow flake8 failure for python 2.7
lsetiawan Jan 19, 2018
9c1a7dc
Cleaup code to meet PEP8
lsetiawan Jan 22, 2018
f5498a6
Merge pull request #143 from ODM2/samplingfeaturedataset_dev
lsetiawan Jan 23, 2018
08b8c07
Refactor ODM2
lsetiawan Feb 16, 2018
67f208c
Make new ODM2 to use the refractored ODM2
lsetiawan Feb 16, 2018
23891b2
Fix import flake8 error
lsetiawan Feb 16, 2018
d4e4425
Merge branch 'master' of https://github.com/ODM2/ODM2PythonAPI into d…
lsetiawan Feb 26, 2018
42679df
Merge pull request #150 from lsetiawan/update_dev
lsetiawan Feb 26, 2018
74d2028
Update README DOCS
lsetiawan Feb 26, 2018
abca232
Remove flake-print
lsetiawan Feb 27, 2018
8501ad8
Update README.md
lsetiawan Feb 27, 2018
50d0db4
Update README change number.
lsetiawan Feb 27, 2018
981f4c6
Merge pull request #147 from lsetiawan/deprecate_odm2
lsetiawan Feb 27, 2018
59115f5
Update installing.rst
lsetiawan Feb 27, 2018
88bc642
Merge pull request #151 from lsetiawan/update_readme
lsetiawan Feb 27, 2018
56e25ec
Update sphinx docs about models, modules, and odm2models
lsetiawan Feb 28, 2018
ce39ac4
Merge pull request #153 from lsetiawan/update_sphinx
lsetiawan Feb 28, 2018
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
61 changes: 33 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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

Expand Down
61 changes: 40 additions & 21 deletions docs/source/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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).
Expand All @@ -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
26 changes: 13 additions & 13 deletions docs/source/models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 4 additions & 4 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
2 changes: 1 addition & 1 deletion docs/source/odm2models.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ODM2 Models
===========

.. automodule:: odm2api.ODM2.models
.. automodule:: odm2api.models
:members:
:undoc-members:
:show-inheritance:
Loading