Mailing-List: contact dev-help@ariatosca.incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@ariatosca.incubator.apache.org
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: mxmrlv@apache.org
To: dev@ariatosca.incubator.apache.org
Date: Thu, 22 Jun 2017 11:22:00 -0000
Message-Id: <01ede4b081dc402b852ec793572e687e@git.apache.org>
In-Reply-To: <926fadf4946449f3a8bd34fa4451091a@git.apache.org>
References: <926fadf4946449f3a8bd34fa4451091a@git.apache.org>
Subject: [2/3] incubator-ariatosca git commit: ARIA-283 Update readme
 installation instructions
archived-at: Thu, 22 Jun 2017 11:22:08 -0000

ARIA-283 Update readme installation instructions


Project: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/commit/a7519349
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/tree/a7519349
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/diff/a7519349

Branch: refs/heads/ARIA-236-Resumable-workflow-executions
Commit: a7519349c07a20a04c1b8acda656daa8679f5135
Parents: 105971f
Author: Ran Ziv <ran@gigaspaces.com>
Authored: Wed Jun 21 18:05:05 2017 +0300
Committer: Ran Ziv <ran@gigaspaces.com>
Committed: Thu Jun 22 12:37:08 2017 +0300

----------------------------------------------------------------------
 README.rst | 66 +++++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 45 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/a7519349/README.rst
----------------------------------------------------------------------
diff --git a/README.rst b/README.rst
index 8af13a5..dc53d47 100644
--- a/README.rst
+++ b/README.rst
@@ -26,37 +26,61 @@ ARIA is an incubation project under the `Apache Software Foundation <https://www
 Installation
 ------------
 
-ARIA is `available on PyPI <https://pypi.python.org/pypi/ariatosca>`__.
+ARIA is `available on PyPI <https://pypi.python.org/pypi/apache-ariatosca>`__.
+
+ARIA requires Python 2.6/2.7. Python 3 is currently not supported.
 
 To install ARIA directly from PyPI (using a ``wheel``), use::
 
-    pip install aria
+    pip install --upgrade pip setuptools
+    pip install apache-ariatosca
 
 To install ARIA from source, download the source tarball from
-`PyPI <https://pypi.python.org/pypi/ariatosca>`__, extract it, and then when inside the extracted
-directory, use::
+`PyPI <https://pypi.python.org/pypi/apache-ariatosca>`__, extract it, and run::
+
+    pip install --upgrade pip setuptools
+    pip install incubator-ariatosca
+
+| The source package comes along with relevant examples, documentation, ``requirements.txt`` (for installing specifically the frozen dependencies' versions with which ARIA was tested) and more.
+|
+|
+| ARIA has additional optional dependencies. These are required for running operations over SSH.
+| Below are instructions on how to install these dependencies, including required system dependencies per OS.
+|
+| Note: These dependencies may have varying licenses which may not be compatible with Apache license 2.0.
+|
+
+**Ubuntu/Debian** (tested on Ubuntu14.04, Ubuntu16.04)::
+
+    apt-get install -y python-dev gcc libffi-dev libssl-dev
+    pip install aria[ssh]
+
+**Centos** (tested on Centos6.6, Centos7)::
+
+    yum install -y python-devel gcc libffi-devel openssl-devel
+    pip install aria[ssh]
+
+**Archlinux**::
+
+    pacman -Syu --noconfirm python2 gcc libffi openssl
+    pip2 install aria[ssh]
 
-    pip install .
+**Windows** (tested on Win10)::
 
-The source package comes along with relevant examples, documentation, ``requirements.txt`` (for
-installing specifically the frozen dependencies' versions with which ARIA was tested) and more.
+    # no additional system requirements are needed
+    pip install aria[ssh]
 
-Note that for the ``pip install`` commands mentioned above, you must use a privileged user, or use
-virtualenv.
+**MacOS**::
 
-ARIA itself is in a ``wheel`` format compatible with all platforms. Some dependencies, however,
-might require compilation (based on a given platform), and therefore possibly some system
-dependencies are required as well.
+    # TODO
 
-On Ubuntu or other Debian-based systems::
 
-    sudo apt install python-setuptools python-dev build-essential libssl-dev libffi-dev
 
-On Archlinux::
+To install ``pip``, either use your distro's package management system, or run::
 
-    sudo pacman -S python-setuptools
+    wget http://bootstrap.pypa.io/get-pip.py
+    python get-pip.py
 
-ARIA requires Python 2.6/2.7. Python 3+ is currently not supported.
 
 
 Getting Started
@@ -129,10 +153,10 @@ ARIA is licensed under the
    :target: https://ci.appveyor.com/project/ApacheSoftwareFoundation/incubator-ariatosca/history
 .. |License| image:: https://img.shields.io/github/license/apache/incubator-ariatosca.svg
    :target: http://www.apache.org/licenses/LICENSE-2.0
-.. |PyPI release| image:: https://img.shields.io/pypi/v/ariatosca.svg
-   :target: https://pypi.python.org/pypi/ariatosca
-.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/ariatosca.svg
-.. |Wheel| image:: https://img.shields.io/pypi/wheel/ariatosca.svg
+.. |PyPI release| image:: https://img.shields.io/pypi/v/apache-ariatosca.svg
+   :target: https://pypi.python.org/pypi/apache-ariatosca
+.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/apache-ariatosca.svg
+.. |Wheel| image:: https://img.shields.io/pypi/wheel/apache-ariatosca.svg
 .. |Contributors| image:: https://img.shields.io/github/contributors/apache/incubator-ariatosca.svg
 .. |Open Pull Requests| image:: https://img.shields.io/github/issues-pr/apache/incubator-ariatosca.svg
    :target: https://github.com/apache/incubator-ariatosca/pulls