| [16] | 1 | Mailjam - installation instructions
|
|---|
| [12] | 2 | ===================================
|
|---|
| 3 |
|
|---|
| 4 | .. contents::
|
|---|
| 5 |
|
|---|
| 6 | First, install dependencies
|
|---|
| 7 | ---------------------------
|
|---|
| 8 |
|
|---|
| [16] | 9 | So far, the only dependency you will need in order to run mailjam is Python [1]_
|
|---|
| [12] | 10 |
|
|---|
| [16] | 11 | Mailjam has been tested with python *2.7.x*, but it should work with versions
|
|---|
| [13] | 12 | *2.6.x* too.
|
|---|
| [12] | 13 |
|
|---|
| 14 | Please, refer to your operating system package system documentation to learn
|
|---|
| 15 | more about how to install python.
|
|---|
| 16 |
|
|---|
| [16] | 17 | Second, install Mailjam
|
|---|
| [12] | 18 | -----------------------
|
|---|
| 19 |
|
|---|
| 20 | Installing using pip
|
|---|
| 21 | ++++++++++++++++++++
|
|---|
| 22 |
|
|---|
| [16] | 23 | You can install Mailjam using pip [2]_::
|
|---|
| [12] | 24 |
|
|---|
| [16] | 25 | pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
|
|---|
| [12] | 26 |
|
|---|
| 27 | .. note::
|
|---|
| 28 |
|
|---|
| [16] | 29 | Mailjam has not been recorded/uploaded to pypi [3]_ yet, so, in order
|
|---|
| [12] | 30 | to install it using pip you will have to provide the URL for the public
|
|---|
| [16] | 31 | Mailjam repo.
|
|---|
| [12] | 32 |
|
|---|
| 33 | Installing using easy_install
|
|---|
| 34 | +++++++++++++++++++++++++++++
|
|---|
| 35 |
|
|---|
| [16] | 36 | You can not install Mailjam using easy_install [4]_ yet (until we do
|
|---|
| [12] | 37 | record/upload it to pypi)
|
|---|
| 38 |
|
|---|
| 39 | Installing inside a virtualenv
|
|---|
| 40 | ++++++++++++++++++++++++++++++
|
|---|
| 41 |
|
|---|
| [16] | 42 | You can install Mailjam inside a virtualenv [5]_. Just create a virtualenv::
|
|---|
| [12] | 43 |
|
|---|
| 44 | virtualenv /path/to/your/env
|
|---|
| 45 |
|
|---|
| 46 | Then activate it::
|
|---|
| 47 |
|
|---|
| 48 | source /path/to/your/env/bin/activate
|
|---|
| 49 |
|
|---|
| 50 | .. note::
|
|---|
| 51 |
|
|---|
| 52 | If your shell is **csh**/**tcsh** remember you have to activate the
|
|---|
| 53 | environment this way::
|
|---|
| 54 |
|
|---|
| 55 | source /path/to/your/env/bin/activate.csh
|
|---|
| 56 |
|
|---|
| [16] | 57 | And, once the environment has been activated, use pip to install Mailjam::
|
|---|
| [12] | 58 |
|
|---|
| [16] | 59 | env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
|
|---|
| [12] | 60 |
|
|---|
| 61 | Installing from sources
|
|---|
| 62 | +++++++++++++++++++++++
|
|---|
| 63 |
|
|---|
| 64 | Releases
|
|---|
| 65 | ********
|
|---|
| 66 |
|
|---|
| 67 | There are no releases yet. You will have to install it from the repository.
|
|---|
| 68 |
|
|---|
| 69 | From repository
|
|---|
| 70 | ***************
|
|---|
| 71 |
|
|---|
| [16] | 72 | The source code of Mailjam is hosted in bitbucket [6]_. In order to grab
|
|---|
| [12] | 73 | the latest sources you need Mercurial [7]_.
|
|---|
| 74 |
|
|---|
| 75 | To get a copy of the sources, just *clone* the repository::
|
|---|
| 76 |
|
|---|
| [16] | 77 | hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo
|
|---|
| [12] | 78 |
|
|---|
| [16] | 79 | Then, go inside the *mailjam-repo* directory and run::
|
|---|
| [12] | 80 |
|
|---|
| 81 | python setup.py install
|
|---|
| 82 |
|
|---|
| 83 | .. warning::
|
|---|
| 84 |
|
|---|
| 85 | If you want to install it *system-wide*, probably you will need *root*
|
|---|
| 86 | privileges (check your OS documentation to learn more about how to get
|
|---|
| 87 | *root* privileges - for example using sudo [8]_)
|
|---|
| 88 |
|
|---|
| [16] | 89 | Setting up Mailjam
|
|---|
| [12] | 90 | ------------------
|
|---|
| 91 |
|
|---|
| 92 | TBW
|
|---|
| 93 |
|
|---|
| [16] | 94 | Running Mailjam
|
|---|
| [12] | 95 | ---------------
|
|---|
| 96 |
|
|---|
| 97 | TBW
|
|---|
| 98 |
|
|---|
| 99 | Running tests (developers only)
|
|---|
| 100 | -------------------------------
|
|---|
| 101 |
|
|---|
| 102 | TBW
|
|---|
| 103 |
|
|---|
| 104 | .. [1] http://python.org
|
|---|
| 105 | .. [2] http://www.pip-installer.org/en/latest/index.html
|
|---|
| 106 | .. [3] http://pypi.python.org/pypi
|
|---|
| 107 | .. [4] http://peak.telecommunity.com/DevCenter/EasyInstall
|
|---|
| 108 | .. [5] http://www.virtualenv.org/en/latest/index.html
|
|---|
| [16] | 109 | .. [6] https://bitbucket.org/codigo23/mailjam
|
|---|
| [12] | 110 | .. [7] http://mercurial.selenic.com
|
|---|
| 111 | .. [8] http://sudo.ws
|
|---|
