| [13] | 1 | Installation instructions
|
|---|
| 2 | =========================
|
|---|
| 3 |
|
|---|
| 4 | .. contents::
|
|---|
| 5 |
|
|---|
| 6 | .. _install_dependencies:
|
|---|
| 7 |
|
|---|
| 8 | First, install dependencies
|
|---|
| 9 | ---------------------------
|
|---|
| 10 |
|
|---|
| [16] | 11 | So far, the only dependency you will need in order to run mailjam is Python_
|
|---|
| [13] | 12 |
|
|---|
| [16] | 13 | Mailjam has been tested with python *2.7.x*, but it should work with versions
|
|---|
| [13] | 14 | *2.6.x* too.
|
|---|
| 15 |
|
|---|
| 16 | Please, refer to your operating system package system documentation to learn
|
|---|
| 17 | more about how to install python.
|
|---|
| 18 |
|
|---|
| [16] | 19 | .. _install_mailjam:
|
|---|
| [13] | 20 |
|
|---|
| [16] | 21 | Second, install Mailjam
|
|---|
| [13] | 22 | -----------------------
|
|---|
| 23 |
|
|---|
| 24 | .. _install_with_pip:
|
|---|
| 25 |
|
|---|
| 26 | Installing using pip
|
|---|
| 27 | ++++++++++++++++++++
|
|---|
| 28 |
|
|---|
| [16] | 29 | You can install Mailjam using pip_::
|
|---|
| [13] | 30 |
|
|---|
| [16] | 31 | pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
|
|---|
| [13] | 32 |
|
|---|
| 33 | .. note::
|
|---|
| 34 |
|
|---|
| [16] | 35 | Mailjam has not been recorded/uploaded to pypi_ yet, so, in order to install
|
|---|
| 36 | it using pip you will have to provide the URL for the public Mailjam repo.
|
|---|
| [13] | 37 |
|
|---|
| 38 | .. _install_with_easy_install:
|
|---|
| 39 |
|
|---|
| 40 | Installing using easy_install
|
|---|
| 41 | +++++++++++++++++++++++++++++
|
|---|
| 42 |
|
|---|
| [16] | 43 | You can not install Mailjam using easy_install_ yet (until we do record/upload
|
|---|
| [13] | 44 | it to pypi)
|
|---|
| 45 |
|
|---|
| 46 | .. _install_inside_virtualenv:
|
|---|
| 47 |
|
|---|
| 48 | Installing inside a virtualenv
|
|---|
| 49 | ++++++++++++++++++++++++++++++
|
|---|
| 50 |
|
|---|
| [16] | 51 | You can install Mailjam inside a virtualenv_. Just create a virtualenv::
|
|---|
| [13] | 52 |
|
|---|
| 53 | virtualenv /path/to/your/env
|
|---|
| 54 |
|
|---|
| 55 | Then activate it::
|
|---|
| 56 |
|
|---|
| 57 | source /path/to/your/env/bin/activate
|
|---|
| 58 |
|
|---|
| 59 | .. note::
|
|---|
| 60 |
|
|---|
| 61 | If your shell is **csh**/**tcsh** remember you have to activate the
|
|---|
| 62 | environment this way::
|
|---|
| 63 |
|
|---|
| 64 | source /path/to/your/env/bin/activate.csh
|
|---|
| 65 |
|
|---|
| [16] | 66 | And, once the environment has been activated, use pip to install Mailjam::
|
|---|
| [13] | 67 |
|
|---|
| [16] | 68 | env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
|
|---|
| [13] | 69 |
|
|---|
| 70 | .. _install_from_sources:
|
|---|
| 71 |
|
|---|
| 72 | Installing from sources
|
|---|
| 73 | +++++++++++++++++++++++
|
|---|
| 74 |
|
|---|
| 75 | When installing from sources, you can download one of the official releases
|
|---|
| 76 | or you can go with the *bleeding edge* and get a copy of the official source
|
|---|
| 77 | code repository.
|
|---|
| 78 |
|
|---|
| 79 | .. _install_from_release:
|
|---|
| 80 |
|
|---|
| 81 | Releases
|
|---|
| 82 | ********
|
|---|
| 83 |
|
|---|
| 84 | **There are no releases yet**. You will have to install it from the repository.
|
|---|
| 85 |
|
|---|
| 86 | .. _install_from_repository:
|
|---|
| 87 |
|
|---|
| 88 | From repository
|
|---|
| 89 | ***************
|
|---|
| 90 |
|
|---|
| [16] | 91 | The source code of Mailjam is hosted in bitbucket_ [1]_. In order to grab
|
|---|
| [13] | 92 | the latest sources you need Mercurial_.
|
|---|
| 93 |
|
|---|
| 94 | To get a copy of the sources, just *clone* the repository::
|
|---|
| 95 |
|
|---|
| [16] | 96 | hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo
|
|---|
| [13] | 97 |
|
|---|
| [16] | 98 | Then, go inside the *mailjam-repo* directory and run::
|
|---|
| [13] | 99 |
|
|---|
| 100 | python setup.py install
|
|---|
| 101 |
|
|---|
| 102 | .. warning::
|
|---|
| 103 |
|
|---|
| 104 | If you want to install it *system-wide*, probably you will need *root*
|
|---|
| 105 | privileges (check your OS documentation to learn more about how to get
|
|---|
| 106 | *root* privileges - for example using sudo_)
|
|---|
| 107 |
|
|---|
| 108 | .. note::
|
|---|
| 109 |
|
|---|
| 110 | This process will work inside a virtualenv_ too.
|
|---|
| 111 |
|
|---|
| [16] | 112 | .. _install_setting_up_mailjam:
|
|---|
| [13] | 113 |
|
|---|
| [16] | 114 | Setting up Mailjam
|
|---|
| [13] | 115 | ------------------
|
|---|
| 116 |
|
|---|
| 117 | TBW
|
|---|
| 118 |
|
|---|
| [16] | 119 | .. _install_running_mailjam:
|
|---|
| [13] | 120 |
|
|---|
| [16] | 121 | Running Mailjam
|
|---|
| [13] | 122 | ---------------
|
|---|
| 123 |
|
|---|
| 124 | TBW
|
|---|
| 125 |
|
|---|
| 126 | .. _install_running_tests:
|
|---|
| 127 |
|
|---|
| 128 | Running tests (developers only)
|
|---|
| 129 | -------------------------------
|
|---|
| 130 |
|
|---|
| 131 | TBW
|
|---|
| 132 |
|
|---|
| 133 | .. _Python: http://python.org
|
|---|
| 134 | .. _pip: http://www.pip-installer.org/en/latest/index.html
|
|---|
| 135 | .. _pypi: http://pypi.python.org/pypi
|
|---|
| 136 | .. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall
|
|---|
| 137 | .. _virtualenv: http://www.virtualenv.org/en/latest/index.html
|
|---|
| 138 | .. _bitbucket: https://bitbucket.org
|
|---|
| 139 | .. _Mercurial: http://mercurial.selenic.com
|
|---|
| 140 | .. _sudo: http://sudo.ws
|
|---|
| 141 |
|
|---|
| [16] | 142 | .. [1] https://bitbucket.org/codigo23/mailjam
|
|---|
