ariatosca-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject incubator-ariatosca git commit: ARIA-283 Update readme installation instructions [Forced Update!]
Date Wed, 21 Jun 2017 15:07:53 GMT
Repository: incubator-ariatosca
Updated Branches:
  refs/heads/ARIA-283-update-readme-installation-instructions e7ab90d10 -> e339960ef (forced

ARIA-283 Update readme installation instructions


Branch: refs/heads/ARIA-283-update-readme-installation-instructions
Commit: e339960ef92663560c68cf049e824853f91cf74b
Parents: 9907520
Author: Ran Ziv <>
Authored: Wed Jun 21 18:05:05 2017 +0300
Committer: Ran Ziv <>
Committed: Wed Jun 21 18:07:48 2017 +0300

 README.rst | 63 ++++++++++++++++++++++++++++++++++++++++-----------------
 1 file changed, 44 insertions(+), 19 deletions(-)
diff --git a/README.rst b/README.rst
index 8af13a5..3aa62fe 100644
--- a/README.rst
+++ b/README.rst
@@ -26,37 +26,62 @@ ARIA is an incubation project under the `Apache Software Foundation <https://www
-ARIA is `available on PyPI <>`__.
+ARIA is `available on PyPI <>`__.
+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 <>`__, extract it, and then when inside
the extracted
-directory, use::
+`PyPI <>`__, extract it, and run::
-    pip install .
+    pip install --upgrade pip setuptools
+    pip install incubator-ariatosca
 The source package comes along with relevant examples, documentation, ``requirements.txt``
 installing specifically the frozen dependencies' versions with which ARIA was tested) and
-Note that for the ``pip install`` commands mentioned above, you must use a privileged user,
or use
-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.
+ARIA has additional optional dependencies. These are required for running operations over
+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]
+    pacman -Syu --noconfirm python2 gcc libffi openssl
+    pip2 install aria[ssh]
+Windows (tested on Win10)::
+    # no additional system requirements are needed
+    pip install aria[ssh]
-On Ubuntu or other Debian-based systems::
+    # TODO
-    sudo apt install python-setuptools python-dev build-essential libssl-dev libffi-dev
-On Archlinux::
-    sudo pacman -S python-setuptools
+To install ``pip``, either use your distro's package management system, or run:
-ARIA requires Python 2.6/2.7. Python 3+ is currently not supported.
+    wget
+    python
 Getting Started
@@ -129,10 +154,10 @@ ARIA is licensed under the
 .. |License| image::
-.. |PyPI release| image::
-   :target:
-.. |Python Versions| image::
-.. |Wheel| image::
+.. |PyPI release| image::
+   :target:
+.. |Python Versions| image::
+.. |Wheel| image::
 .. |Contributors| image::
 .. |Open Pull Requests| image::

View raw message