add: improved installation instructions

add: executable name depending if python 2 or 3
This commit is contained in:
cr0hn
2016-03-03 11:17:52 +01:00
parent 07e2cec738
commit c7134e109f
5 changed files with 91 additions and 69 deletions

View File

@@ -14,11 +14,13 @@ Enteletaor is a message Queue & Broker Injection tool.
+----------------+------------------------------------+
|Project site | http://github.com/cr0hn/enteletaor |
+----------------+------------------------------------+
|Documentation | http://enteletaor.readthedocs.org |
+----------------+------------------------------------+
|Author | Daniel Garcia (cr0hn) - @ggdaniel |
+----------------+------------------------------------+
|Last Version | 1.0.0 |
+----------------+------------------------------------+
|Python versions | 2.x 3.x |
|Python versions | 2.7.x % 3.x |
+----------------+------------------------------------+
Quick project description
@@ -26,7 +28,7 @@ Quick project description
Enteleteaor is a tool that can handle information from open brokers.
Some of the actions you can do are:
Some of the actions you can do:
- Listing remote tasks.
- Read remote task content.

View File

@@ -1,14 +1,51 @@
Installation
============
Using PIP
---------
Dependencies
------------
The easiest way to install enteleteaor is from Pypi. To do this, only run:
First you be sure you have installed this packages:
Python 2 & 3
++++++++++++
.. code-block:: bash
# pip install enteletaor
# sudo apt-get install -y libzmq3 libzmq3-dev
Python 3 only (recommended)
+++++++++++++++++++++++++++
.. code-block:: bash
# sudo apt-get install -y python3-pip
Python 2 only
+++++++++++++
.. code-block:: bash
# sudo apt-get install -y python2.7-dev
Installation from PIP (recommended)
-----------------------------------
The easiest way to install enteleteaor is from Pypi. To do this, only run:
Python 2
++++++++
.. code-block:: bash
# python -m pip install enteletaor
Python 3
++++++++
.. code-block:: bash
# python3 -m pip install enteletaor
Then run enteleteaor writing:
@@ -16,8 +53,20 @@ Then run enteleteaor writing:
# enteleteaor -h
From source
-----------
or, in Python 3:
.. code-block:: bash
# enteleteaor3 -h
.. note::
Remember that, if you install enteleteaor in **Python 3** executable will be called **enteletaor3** -> ending in **3**.
If you install in **Python 2** executable will be **enteletaor**, without 3.
Installation from source
------------------------
Also, you can download source code from github using git:
@@ -34,7 +83,7 @@ Next you need to install dependencies from ``requirements.txt``:
.. note::
If you're not running enteleteaor in a virtualenv, probably you need tu be root to install requirements. So, you can use ``sudo`` command.
If you're not running enteleteaor in a virtualenv, probably you need to be root to install requirements. So, you can use ``sudo`` command.
Finally you can run enteleteaor: