1
=== added directory 'src/mailman/doc'
2
=== added file 'src/mailman/doc/START.rst'
3
--- src/mailman/doc/START.rst	1970-01-01 00:00:00 +0000
4
+++ src/mailman/doc/START.rst	2015-03-08 22:52:52 +0000
5
@@ -0,0 +1,128 @@
6
1
---------------------------------------------------------------------INSTALLATION GUIDE---------------------------------------------------------------
7
2
8
3
9
4
This is a quick guide to setup a development environment to work on Postorius, Mailman 3's web UI (and, in the process, install the core Mailman engine and Mailman.client as well). If all goes as planned, you should be done within ~5 minutes. This has been tested on Ubuntu 11.04 and OS X 10.8.1.  Please note that the Python provided by apple for OSX will not work; you need to install your own version of python (e.g. using fink or macports). The Mac Mailman development setup guide has instructions using homebrew if you need additional instructions.
10
5
11
6
Packages to be installed
12
7
13
8
bzr python-dev python-virtualenv build-essential postfix
14
9
 
15
10
For Ubuntu users: sudo apt-get install bzr python-dev python-virtualenv build-essential postfix
16
11
17
12
For Mac user: Go to http://wiki.list.org/DEV/Mac%20Mailman%20development%20setup%20guide
18
13
19
14
-----------------------------------------------------------------------------------------------------------------------------------------------------
20
15
21
16
Virtual Environment
22
17
23
18
Install virtualenv via pip:
24
19
25
20
$ pip install virtualenv
26
21
27
22
Basic Usage
28
23
29
24
Create a virtual environment for a project:
30
25
$ cd my_project_folder
31
26
$ virtualenv venv
32
27
33
28
virtualenv venv will create a folder in the current directory which will contain the Python executable files, and a copy of the pip library which you can use to install other packages. The name of the virtual environment (in this case, it was venv) can be anything; omitting the name will place the files in the current directory instead.
34
29
35
30
This creates a copy of Python in whichever directory you ran the command in, placing it in a folder named venv.
36
31
37
32
You can also use a Python interpreter of your choice.
38
33
39
34
$ virtualenv -p /usr/bin/python2.7 venv
40
35
41
36
This will use the Python interpreter in /usr/bin/python2.7
42
37
43
38
To begin using the virtual environment, it needs to be activated:
44
39
45
40
$ source venv/bin/activate
46
41
47
42
The name of the current virtual environment will now appear on the left of the prompt (e.g. (venv)Your-Computer:your_project UserName$) to let you know that it’s active. From now on, any package that you install using pip will be placed in the venv folder, isolated from the global Python installation.
48
43
49
44
Install packages as usual, for example:
50
45
51
46
$ pip install requests
52
47
53
48
If you are done working in the virtual environment for the moment, you can deactivate it:
54
49
$ deactivate
55
50
This puts you back to the system’s default Python interpreter with all its installed libraries.
56
51
57
52
To delete a virtual environment, just delete its folder. (In this case, it would be rm -rf venv.)
58
53
59
54
For more info go to: http://docs.python-guide.org/en/latest/dev/virtualenvs/
60
55
61
56
-------------------------------------------------------------------------------------------------------------------------------------------------------
62
57
63
58
Get the sources
64
59
65
60
(venv)$ bzr branch lp:mailman
66
61
(venv)$ bzr branch lp:mailman.client
67
62
(venv)$ bzr branch lp:postorius
68
63
(venv)$ bzr branch lp:~mailman-coders/postorius/postorius_standalone
69
64
70
65
If you get permission errors on this step, your ssh key is probably not in sync with what is on launchpad.net.
71
66
72
67
------------------------------------------------------------------------------------------------------------------------------------------------------
73
68
74
69
GNU Mailman 3
75
70
76
71
Mailman 3 sould be installed using python 3.4
77
72
78
73
$virtualenv -p /usr/bin/python3.4 venv #for using python 3.4
79
74
80
75
(venv)$ cd mailman 
81
76
(venv)$ python setup.py install
82
77
83
78
If you get no errors you can now start Mailman:
84
79
85
80
(venv)$ mailman start
86
81
(venv)$ cd ..
87
82
88
83
At this point Mailman will not send nor receive any real emails. But that's fine as long as you only want to work on the components related to the ReST client or the web ui.
89
84
90
85
------------------------------------------------------------------------------------------------------------------------------------------------------
91
86
92
87
mailman.client (the Python bindings for Mailman's ReST API)
93
88
94
89
mailman.client sould be installed using python 2.7
95
90
96
91
$virtualenv -p /usr/bin/python2.7 venv #for using python 2.7
97
92
98
93
(venv)$ cd mailman.client
99
94
(venv)$ python setup.py develop
100
95
(venv)$ cd ..
101
96
102
97
-------------------------------------------------------------------------------------------------------------------------------------------------------
103
98
104
99
Postorius
105
100
106
101
Postorius sould be installed using python 2.7
107
102
108
103
$virtualenv -p /usr/bin/python2.7 venv #for using python 2.7
109
104
110
105
(venv)$ cd postorius
111
106
(venv)$ python setup.py develop
112
107
(venv)$ cd ..
113
108
114
109
------------------------------------------------------------------------------------------------------------------------------------------------------
115
110
116
111
Start the development server
117
112
118
113
Postorius sould be installed using python 2.7
119
114
120
115
$virtualenv -p /usr/bin/python2.7 venv #for using python 2.7
121
116
122
117
(venv)$ cd postorius_standalone
123
118
(venv)$ python manage.py syncdb
124
119
(venv)$ python manage.py runserver
125
120
126
121
------------------------------------------------------------------------------------------------------------------------------------------------------
127
122
Profit!
128
123
129
124
Now go to http://localhost:8000 to see the web UI for mailman!
130
125
131
126
For hyperkitty installation: https://fedorahosted.org/hyperkitty/wiki/DevelopmentSetupGuide
132
127
133
128
------------------------------------------------------------------------------------------------------------------------------------------------------
Reviewer	Review Type	Date Requested	Status
Barry Warsaw		2015-03-08	Needs Fixing on 2015-03-09
Review via email: mp+252230@code.launchpad.net