Skip to content

Commit 9945421

Browse files
authored
Merge pull request #154 from ODM2/release/0.7.1
Release/0.7.1
2 parents b8d76f6 + ce39ac4 commit 9945421

20 files changed

+3878
-3751
lines changed

.travis.yml

-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ matrix:
3939
- python: 3.6
4040
env: TEST_TARGET=docs
4141
allow_failures:
42-
- python: 2.7
43-
env: TEST_TARGET=coding_standards
4442
- python: 3.6
4543
env: TEST_TARGET=default
4644

README.md

+33-28
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@ source activate myenv # On MacOSX or Linux
3838
but they haven't been tested thoroughly.
3939

4040

41-
### Latest release, from ODM2 anaconda.org channel
41+
### Latest release, from conda-forge anaconda.org channel
4242

4343
The
4444
[latest `odm2api` release](https://github.com/ODM2/ODM2PythonAPI/releases)
4545
is available on the
46-
[ODM2 anaconda.org channel](https://anaconda.org/odm2/odm2api)
46+
[conda-forge anaconda.org channel](https://anaconda.org/conda-forge/odm2api)
4747
for all major OS paltforms (linux, OSX, win32/win64).
4848
To install it on an existing conda environment:
4949

5050
```
51-
conda install -c odm2 odm2api
51+
conda install -c conda-forge odm2api
5252
```
5353

5454
All dependencies are installed,
@@ -57,33 +57,38 @@ including Pandas and its dependencies (numpy, etc).
5757
To create a new environment "myenv" with the `odm2api` package:
5858

5959
```
60-
conda create -n myenv -c odm2 python=2.7 odm2api
60+
conda create -n myenv -c conda-forge python=2.7 odm2api
6161
```
6262

63-
### Installing the development version from the `master` branch on github
64-
65-
**Note from 4/26/2016:** These instructions may be slightly outdated.
66-
Follow these directions for installing the bleeding edge GitHub master branch,
67-
mainly for development and testing purposes.
68-
69-
To create a new environment "myenv" with `odm2api`,
70-
first download the conda environment file
71-
[condaenvironment_1.yml](https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/condaenvironment_1.yml).
72-
Go to the directory where `condaenvironment_1.yml` was downloaded.
73-
Then, on a terminal shell:
74-
75-
```bash
76-
conda env create -n myenv --file py2_conda_environment.yml
77-
```
78-
79-
Activate the new environment, then install `odm2api` into the environment:
80-
81-
```bash
82-
activate myenv # On Windows
83-
source activate myenv # On MacOSX or Linux
84-
85-
pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI.git
86-
```
63+
### Installing the development version from the `development` branch on github
64+
65+
Note: We follow the [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for development.
66+
67+
1. Download both `requirements.txt` and `requirements-dev.txt`.
68+
``` bash
69+
wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements.txt
70+
wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements-dev.txt
71+
```
72+
73+
2. Create conda environment `odm2api_dev` from the two `requirements*` text files.
74+
```bash
75+
conda create -n odm2api_dev -c conda-forge python=2.7 --file requirements.txt --file requirements-dev.txt
76+
```
77+
78+
3. Activate conda environment.
79+
- MacOSX/Linux:
80+
```bash
81+
source activate odm2api_dev
82+
```
83+
- Windows:
84+
```
85+
activate odm2api_dev
86+
```
87+
88+
4. Install the latest commit from the development branch
89+
```bash
90+
pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development#egg=odm2api
91+
```
8792
8893
## Credits
8994

docs/source/installing.rst

+40-21
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ OS X and Linux, it's something like
1212

1313
To activate a conda environment, say, "myenv":
1414

15-
.. code:: bash
15+
.. code-block:: bash
1616
1717
activate myenv # On Windows
1818
source activate myenv # On MacOSX or Linux
@@ -21,17 +21,17 @@ To activate a conda environment, say, "myenv":
2121
changes have been made to support Python 3.x, but they haven't been
2222
tested thoroughly.
2323

24-
Latest release, from ODM2 anaconda.org channel
24+
Latest release, from conda-forge anaconda.org channel
2525
----------------------------------------------
2626

27-
The `latest release <https://github.com/ODM2/ODM2PythonAPI/releases>`__ is available
28-
on the `ODM2 anaconda.org channel <https://anaconda.org/odm2/odm2api>`__
27+
The `latest release <https://github.com/ODM2/ODM2PythonAPI/releases>`_ is available
28+
on the `conda-forge anaconda.org channel <https://anaconda.org/conda-forge/odm2api>`_
2929
for all major OS platforms (linux, OS X, win32/win64). To install it on
3030
an existing conda environment:
3131

3232
::
3333

34-
conda install odm2api --channel odm2
34+
conda install -c conda-forge odm2api
3535

3636
All dependencies are installed, including Pandas and its dependencies
3737
(numpy, etc).
@@ -40,23 +40,42 @@ To create a new environment "myenv" with the ``odm2api`` package:
4040

4141
::
4242

43-
conda create -n myenv -c odm2 python=2.7 odm2api
43+
conda create -n myenv -c conda-forge python=2.7 odm2api
4444

4545

46-
Installing the development version
46+
Installing the development version from the ``development`` branch on github
4747
----------------------------------
4848

49-
To create a new environment "myenv" with ``odm2api``, first clone the repository.
50-
Then, on a terminal shell:
51-
52-
.. code:: bash
53-
54-
conda create --name myenv python=2.7 --file requirements.txt --file requirements-dev.txt -c odm2
55-
56-
Activate the new environment, then install ``odm2api`` into the
57-
environment:
58-
59-
.. code:: bash
60-
61-
activate myenv # On Windows
62-
source activate myenv # On OS X or Linux
49+
Note: We follow the `Gitflow workflow <https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow>`__ for development.
50+
51+
1. Download both ``requirements.txt`` and ``requirements-dev.txt``.
52+
53+
.. code-block:: bash
54+
55+
wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements.txt
56+
wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements-dev.txt
57+
58+
2. Create conda environment ``odm2api_dev`` from the two ``requirements*`` text files.
59+
60+
.. code-block:: bash
61+
62+
conda create -n odm2api_dev -c conda-forge python=2.7 --file requirements.txt --file requirements-dev.txt
63+
64+
3. Activate conda environment.
65+
- MacOSX/Linux:
66+
67+
.. code-block:: bash
68+
69+
source activate odm2api_dev
70+
71+
- Windows:
72+
73+
.. code-block:: bash
74+
75+
activate odm2api_dev
76+
77+
4. Install the latest commit from the development branch
78+
79+
.. code-block:: bash
80+
81+
pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development#egg=odm2api

docs/source/models.rst

+13-13
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ The following are entities in the `ODM2 Core Schema <http://odm2.github.io/ODM2/
1212

1313
.. autosummary::
1414

15-
odm2api.ODM2.models.Actions
16-
odm2api.ODM2.models.DataSets
17-
odm2api.ODM2.models.FeatureActions
18-
odm2api.ODM2.models.Methods
19-
odm2api.ODM2.models.Organizations
20-
odm2api.ODM2.models.People
21-
odm2api.ODM2.models.ProcessingLevels
22-
odm2api.ODM2.models.RelatedActions
23-
odm2api.ODM2.models.Results
24-
odm2api.ODM2.models.SamplingFeatures
25-
odm2api.ODM2.models.TaxonomicClassifiers
26-
odm2api.ODM2.models.Units
27-
odm2api.ODM2.models.Variables
15+
odm2api.models.Actions
16+
odm2api.models.DataSets
17+
odm2api.models.FeatureActions
18+
odm2api.models.Methods
19+
odm2api.models.Organizations
20+
odm2api.models.People
21+
odm2api.models.ProcessingLevels
22+
odm2api.models.RelatedActions
23+
odm2api.models.Results
24+
odm2api.models.SamplingFeatures
25+
odm2api.models.TaxonomicClassifiers
26+
odm2api.models.Units
27+
odm2api.models.Variables

docs/source/modules.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,31 @@ This part of the documentation covers all the interfaces of ODM2PythonAPI.
2121
:mod:`Read Services`
2222
---------------------
2323

24-
.. automodule:: odm2api.ODM2.services.readService
24+
.. automodule:: odm2api.services.readService
2525
:members:
2626
:undoc-members:
2727
:show-inheritance:
2828

2929
:mod:`Create Services`
3030
-----------------------
3131

32-
.. automodule:: odm2api.ODM2.services.createService
32+
.. automodule:: odm2api.services.createService
3333
:members:
3434
:undoc-members:
3535
:show-inheritance:
3636

3737
:mod:`Delete Services`
3838
-----------------------
3939

40-
.. automodule:: odm2api.ODM2.services.deleteService
40+
.. automodule:: odm2api.services.deleteService
4141
:members:
4242
:undoc-members:
4343
:show-inheritance:
4444

4545
:mod:`Update Services`
4646
-----------------------
4747

48-
.. automodule:: odm2api.ODM2.services.updateService
48+
.. automodule:: odm2api.services.updateService
4949
:members:
5050
:undoc-members:
5151
:show-inheritance:

docs/source/odm2models.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ODM2 Models
22
===========
33

4-
.. automodule:: odm2api.ODM2.models
4+
.. automodule:: odm2api.models
55
:members:
66
:undoc-members:
77
:show-inheritance:

0 commit comments

Comments
 (0)