summaryrefslogtreecommitdiffstats
path: root/docs/setup/index.rst
blob: 50d951319b1b981fd1fd6eb486048c8dc03ef1f4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
=====
setup
=====

.. highlight:: bash

gnu/linux
=========

Install ``python-pip`` package.

On Debian_ or Ubuntu_::

  $ sudo aptitude install python-pip

On Fedora_::

  $ sudo yum install python-pip

On Arch_::

  $ pacman -S python2-pip

.. _Debian: https://www.debian.org
.. _Ubuntu: http://www.ubuntu.com
.. _Fedora: https://getfedora.org
.. _Arch: https://www.archlinux.org

Install ``combox`` using the ``pip`` installer::

  $ pip install combox


os x
====

If Hombrew_ is not already installed, install it first::

    $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

.. _Hombrew:  http://brew.sh/

Next, install ``python`` from Hombrew_::

  $ brew install python

This will also install ``pip``.

Install ``combox`` using the ``pip`` installer::

  $ pip install combox


windows
=======

.. highlight:: powershell

At the moment, ``combox`` is not compatible with Windows. The following
sections describe how to set up the development environment on
Windows.


setup python, pip and virtualenv
--------------------------------

Install python v2.7.x first: `python.org/downloads/windows`__

.. _pywindows: https://www.python.org/downloads/windows
.. __: pywindows_

Add python to ``PATH``:

.. code-block:: none

   %PATH%;C:\Python27

Make sure python works from Windows Powershell

Get a copy of `get-pip.py`_.

.. _get-pip.py: https://raw.githubusercontent.com/pypa/pip/master/contrib/get-pip.py

From Windows Powershell, ``cd`` to the directory containing
``get-pip.py`` file and do::

  python get-pip.y

That should install ``pip`` and ``setuptools``.

Next, add pip to ``PATH``:

.. code-block:: none

    %PATH%;C:\Python27;C:\Python27\Scripts

Make sure ``pip`` works from Windows Powershell by doing::

  pip --version

Lastly, install ``virtualenv``::

  pip install virtualenv


install git
-----------

Get a copy of ``git`` from `git-scm.com/download/win`__

.. _gitwin: http://git-scm.com/download/win
.. __: gitwin_

In the "Adjusting your PATH environment" screen in the ``git``
installation wizard, choose the "Use Git from the Windows Command
Prompt"

Make sure ``git`` works from Windows Powershell by doing::

  git --version


setup combox
------------

install v. c++ compiler
_______________________

From `aka.ms/vcpython27`__ (this is required for installing
``pycrypto`` package from ``pip``).

.. _vcpython27: http://aka.ms/vcpython27
.. __: vcpython27_


setup combox
____________

From the Windows Powershell, do::

  git clone git://ricketyspace.net/combox.git


setup virtual environment
.........................

``cd`` to the ``combox`` directory and do::

  virtualenv .


activate virtual environment
............................

``cd`` to the ``combox`` directory and do::

  .\Scripts\activate


install combox
..............

in ``develop`` mode::

  python setup.py develop