Revision 6539c700

b/docs/installation.rst
6 6

  
7 7
* Kamaki repository: `http://code.grnet.gr/git/kamaki <http://code.grnet.gr/git/kamaki>`_
8 8

  
9
* Kamaki at pypi: `http://pypi.python.org/pypi/kamaki <https://pypi.python.org/pypi/kamaki>`_
10

  
9 11
* Synnefo Linux packages: `http://apt2.dev.grnet.gr <http://apt2.dev.grnet.gr>`_
10 12

  
11 13
Linux and Unix-like enviroments
......
64 66

  
65 67
        $ sudo apt-get install kamaki
66 68

  
67
.. _installing-from-source-ref:
69
Install ansicolors and/or progress (Optional but recommended)
70
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
71

  
72
.. code-block:: console
73

  
74
    $ sudo apt-get install python-ansicolors
75
    $ sudo apt-get install python-progress
76

  
77
.. _installing-from-pypi-ref:
68 78

  
69
Installing from source (git repos.)
70
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
79
Installing from pypi
80
^^^^^^^^^^^^^^^^^^^^
71 81

  
72 82
Requirements
73 83
""""""""""""
......
93 103

  
94 104
A more detailed example of using virtual env can be found at the `snf-image-creator setup guide <http://docs.dev.grnet.gr/snf-image-creator/latest/install.html#python-virtual-environment>`_
95 105

  
96
Install objpool (was: snf-common)
97
"""""""""""""""""""""""""""""""""
98

  
99
Kamaki is based on python-objpool. The objpool package is easy to install from source, even on windows platforms:
100

  
101
.. code-block:: console
102

  
103
    $ git clone http://code.grnet.gr/git/objpool
104
    $ cd objpool
105
    $ ./setup build install
106
    $ cd -
107

  
108 106
Install kamaki
109 107
""""""""""""""
110 108

  
111
Kamaki can be downloaded from `this location <https://code.grnet.gr/projects/kamaki/files>`_, where users can pick the version they prefer and unzip it locally:
112

  
113
.. code-block:: console
114

  
115
    $ tar xvfz kamaki-0.7.tar.gz
116

  
117
or it can be downloaded directly from the git repository:
118

  
119
.. code-block:: console
120

  
121
    $ git clone http://code.grnet.gr/git/kamaki
122

  
123
and then installed by the setup script:
124

  
125 109
.. code-block:: console
126 110

  
127
    $ cd kamaki
128
    $ ./setup build install
111
    $ pip install kamaki
129 112

  
130 113
Install ansicolors / progress
131 114
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
......
165 148
Mac OS X
166 149
--------
167 150

  
168
Kamaki can be installed on Mac OS X systems from source, by following the steps at :ref:`installing-from-source-ref`.
151
Kamaki can be installed on Mac OS X systems from source, by following the steps at :ref:`installing-from-pypi-ref`.
169 152

  
170 153
Windows
171 154
-------
172 155

  
173
Kamaki can run on Windows, either on standard Windows console, or inside an improved command line shell. The present guide presents a tested method for setting up kamaki in windows
156
Kamaki can be installed on Windows by following the pypi method. Installing the requirements is a bit different than in other systems. 
157

  
158
The full process is detailed in the following:
174 159

  
175 160
Requirements
176 161
^^^^^^^^^^^^
177 162

  
178 163
* Python 2.7 or better (`Official versions <http://www.python.org/getit>`_)
179 164

  
180
* Git (download `windows version <http://git-scm.com/download/win>`_)
181

  
182 165
* Setuptools (`Official versions and workarounds <http://pypi.python.org/pypi/setuptools>`_)
183 166

  
184
Installation from source
185
^^^^^^^^^^^^^^^^^^^^^^^^
167
Users who have already set up python and setuptools (e.g. for another project) may skip python and / or setup tools installation.
186 168

  
187 169
Install python
188
""""""""""""""
170
^^^^^^^^^^^^^^
189 171

  
190 172
Download and run the Windows installer from `here <http://www.python.org/getit>`_
191 173

  
192 174
Users should pick the installer that fits their windows version and architecture.
193 175

  
194 176
Add python to windows path
195
""""""""""""""""""""""""""
177
^^^^^^^^^^^^^^^^^^^^^^^^^^
196 178

  
197 179
The following will allow users to run python and python scripts from command line.
198 180

  
......
207 189
.. warning:: C:\\Python should be replaced with the actual python path in the system, e.g. C:\\Python27
208 190

  
209 191
Install setuptools
210
""""""""""""""""""
192
^^^^^^^^^^^^^^^^^^
211 193

  
212 194
According to the corresponding `python org page <http://pypi.python.org/pypi/setuptools>`_, the setuptools installer doesn't currently work on 64bit machines.
213 195

  
......
221 203
    Installation finished
222 204
    C:\Downloads\>
223 205

  
224
Install GIT
225
"""""""""""
226

  
227
`Download GIT <http://git-scm.com/download/win>`_ and run the graphic installer. During the installation, users will be able to modify some installation options. The present guide is tested with the default selections.
228

  
229
After the installation is completed, a GIT standalone shell will be installed (a desktop shortcut is created, by default). Users are advised to run kamaki through this shell.
230

  
231 206
Install kamaki
232
""""""""""""""
207
^^^^^^^^^^^^^^
233 208

  
234
* Run the GIT standalone shell
235

  
236
* Enter the location where kamaki will be installed, e.g. **C:\\**
237

  
238
    .. code-block:: console
239

  
240
        $ cd /c/
241

  
242
* Download source from GRNET repository
209
.. code-block:: console
243 210

  
244
    .. code-block:: console
211
    $ easy_setup kamaki
245 212

  
246
        $ git clone http://code.grnet.gr/git/kamaki
247
        Cloning into 'kamaki'...
248
        Receiving objects: ...
249
        Resolving Deltas: ...
213
Install progress (optional)
214
^^^^^^^^^^^^^^^^^^^^^^^^^^^
250 215

  
251
* Enter source and install kamaki
216
progress: command-line progress bars (in some commands)
252 217

  
253
    .. code-block:: console
218
.. code-block:: console
254 219

  
255
        $ cd kamaki
256
        $ python setup.py install
257
        running install
258
        ...
259
        Finished processing dependencies for kamaki==0.7
220
    $ easy_setup progress
260 221

  
261
    $ kamaki --version

Also available in: Unified diff