Merge pull request #70 from HDI-Project/issue_39_fix_install_document…

…ation

Fix installation instructions. Also add contributor credits

.gitignore

@@ -67,6 +67,7 @@ docs/_build/
 docs/mlprimitives.rst
 docs/mlprimitives.*.rst
 docs/modules.rst
+docs/api
 
 # PyBuilder
 target/

AUTHORS.rst

@@ -2,7 +2,16 @@
 Credits
 =======
 
+Development Lead
+----------------
+
+* Kalyan Veeramachaneni <[email protected]>
+* Carles Sala <[email protected]>
+
 Contributors
 ------------
 
-* Carles Sala <[email protected]>
+* Plamen Valentinov <[email protected]>
+* Ihssan Tinawi <[email protected]>
+* Max Kanter <[email protected]>
+* Sze Nga Wong <[email protected]>

CONTRIBUTING.rst

@@ -123,8 +123,7 @@ Ready to contribute? Here's how to set up `MLPrimitives` for local development.
 
     $ mkvirtualenv MLPrimitives
     $ cd MLPrimitives/
-    $ pip install -e .
-    $ pip install -r requirements_dev.txt
+    $ make install-develop
 
 4. Create a branch for local development::
 
@@ -142,11 +141,11 @@ Ready to contribute? Here's how to set up `MLPrimitives` for local development.
 6. When you're done making changes, check that your changes pass flake8 and the
    tests, including testing other Python versions with tox::
 
-    $ make test-all
+    $ make lint       # Check code styling
+    $ make test-all   # Execute tests on all python versions
 
 7. Make also sure to include the necessary documentation in the code as docstrings following
-   the [google](https://google.github.io/styleguide/pyguide.html?showone=Comments#Comments)
-   or the [numpy](https://numpydoc.readthedocs.io/en/latest/format.html) docstring style.
+   the `google docstring`_ style.
    If you want to view how your documentation will look like when it is published, you can
    generate and view the docs with this command::
 
@@ -160,6 +159,8 @@ Ready to contribute? Here's how to set up `MLPrimitives` for local development.
 
 9. Submit a pull request through the GitHub website.
 
+.. _google docstring: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
+
 Pull Request Guidelines
 =======================
 
@@ -231,18 +232,10 @@ The process of releasing a new version involves several steps combining both ``g
    development interation.
 
 **Note:** Before starting the process, make sure that ``HISTORY.md`` has a section titled
-**Unreleased** with the list of changes that will be included in the new version, and that
-these changes are committed and available in ``master`` branch.
-Normally this is just a list of the Pull Requests that have been merged since the latest version.
-
-Once this is done, just run the following commands::
-
-    git checkout stable
-    git merge --no-ff master    # This creates a merge commit
-    bumpversion release   # This creates a new commit and a TAG
-    git push --tags origin stable
-    make release
-    git checkout master
-    git merge stable
-    bumpversion --no-tag patch
-    git push
+after thew new version that is about to be released with the list of changes that will be
+included in the new version, and that these changes are all committed and available in the
+``master`` branch.
+Normally this is just a list of the Issues that have been closed since the latest version.
+
+Once this is done, just run the commands ``make release`` and insert the PyPi username and
+password when required.

LICENSE

@@ -19,4 +19,3 @@ 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.
-

docs/installation.rst

@@ -14,7 +14,8 @@ To install MLPrimitives, run this command in your terminal:
 
     $ pip install mlprimitives
 
-This is the preferred method to install MLPrimitives, as it will always install the most recent stable release.
+This is the preferred method to install MLPrimitives, as it will always install the most recent
+stable release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.
@@ -44,7 +45,7 @@ Once you have a copy of the source, you can install it with:
 
 .. code-block:: console
 
-    $ python setup.py install
+    $ make install-develop
 
 
 .. _Github repo: https://github.com/HDI-Project/MLPrimitives