1
=== modified file 'src/mailman/database/alembic/env.py'
2
--- src/mailman/database/alembic/env.py	2015-01-05 01:22:39 +0000
3
+++ src/mailman/database/alembic/env.py	2015-01-17 17:53:23 +0000
4
@@ -25,11 +25,18 @@
5
25
25
6
26
from alembic import context
26
from alembic import context
7
27
from contextlib import closing
27
from contextlib import closing
8
28
from mailman.core.initialize import initialize_1
9
28
from mailman.config import config
29
from mailman.config import config
10
29
from mailman.database.model import Model
30
from mailman.database.model import Model
11
30
from mailman.utilities.string import expand
31
from mailman.utilities.string import expand
12
31
from sqlalchemy import create_engine
32
from sqlalchemy import create_engine
13
32
33
14
34
try:
15
35
    url = expand(config.database.url, config.paths)
16
36
except AttributeError:
17
37
    # Initialize config object for external alembic calls
18
38
    initialize_1()
19
39
    url = expand(config.database.url, config.paths)
20
33
40
21
34
41
22
35
42
23
36
def run_migrations_offline():
43
def run_migrations_offline():
24
@@ -42,7 +49,6 @@
25
42
    Calls to context.execute() here emit the given string to the script
49
    Calls to context.execute() here emit the given string to the script
26
43
    output.
50
    output.
27
44
    """
51
    """
28
45
    url = expand(config.database.url, config.paths)
29
46
    context.configure(url=url, target_metadata=Model.metadata)
52
    context.configure(url=url, target_metadata=Model.metadata)
30
47
    with context.begin_transaction():
53
    with context.begin_transaction():
31
48
        context.run_migrations()
54
        context.run_migrations()
32
@@ -54,7 +60,6 @@
33
54
    In this scenario we need to create an Engine and associate a
60
    In this scenario we need to create an Engine and associate a
34
55
    connection with the context.
61
    connection with the context.
35
56
    """
62
    """
36
57
    url = expand(config.database.url, config.paths)
37
58
    engine = create_engine(url)
63
    engine = create_engine(url)
38
59
64
39
60
    connection = engine.connect()
65
    connection = engine.connect()
40
61
66
41
=== modified file 'src/mailman/docs/DATABASE.rst'
42
--- src/mailman/docs/DATABASE.rst	2014-11-09 12:52:58 +0000
43
+++ src/mailman/docs/DATABASE.rst	2015-01-17 17:53:23 +0000
44
@@ -59,8 +59,31 @@
45
59
My thanks to Stephen A. Goss for his contribution of PostgreSQL support.
59
My thanks to Stephen A. Goss for his contribution of PostgreSQL support.
46
60
60
47
61
61
48
62
Database Migrations
49
63
===================
50
64
51
65
Mailman uses `Alembic`_ to manage database migrations. Lets say you change
52
66
something in the models, what steps are needed to reflect that change in
53
67
the database schema? All you need to do is run this command::
54
68
55
69
    alembic -c src/mailman/config/alembic.cfg revision --autogenerate
56
70
57
71
This would create a new migration which would automatically be migrated to the
58
72
database on the next run of mailman. Note that the database needs to be in the
59
73
older state so that alembic can track the changes in the schema and autogenerate
60
74
a migration. If you don't have the database in the older state you can remove
61
75
the `--autogenerate` flag in the above command. It would then create a new empty
62
76
revision which you can edit manually to reflect your changes in the database
63
77
schema.
64
78
65
79
People upgrading Mailman from previous versions need not do anything manually,
66
80
as soon as a new migration is added in the sources, it will be automatically
67
81
reflected in the schema on first-run post-update.
68
82
69
83
70
62
.. _SQLAlchemy: http://www.sqlalchemy.org/
84
.. _SQLAlchemy: http://www.sqlalchemy.org/
71
63
.. _SQLite3: http://docs.python.org/library/sqlite3.html
85
.. _SQLite3: http://docs.python.org/library/sqlite3.html
72
64
.. _PostgreSQL: http://www.postgresql.org/
86
.. _PostgreSQL: http://www.postgresql.org/
73
65
.. _MySQL: http://dev.mysql.com/
87
.. _MySQL: http://dev.mysql.com/
74
66
.. _`Ubuntu article`: https://help.ubuntu.com/community/PostgreSQL
88
.. _`Ubuntu article`: https://help.ubuntu.com/community/PostgreSQL
75
89
.. _`Alembic`: https://alembic.readthedocs.org/en/latest/
76
67
90
77
=== modified file 'src/mailman/docs/WebUIin5.rst'
78
--- src/mailman/docs/WebUIin5.rst	2012-10-31 16:31:12 +0000
79
+++ src/mailman/docs/WebUIin5.rst	2015-01-17 17:53:23 +0000
80
@@ -7,11 +7,13 @@
81
7
done within 5 minutes.  This has been tested on Ubuntu 11.04.
7
done within 5 minutes.  This has been tested on Ubuntu 11.04.
82
8
8
83
9
In order to download the components necessary you need to have the `Bazaar`_
9
In order to download the components necessary you need to have the `Bazaar`_
85
10
version control system installed on your system.  Mailman requires Python 2.7,
10
version control system installed on your system.  Mailman requires Python 3.4,
86
11
while mailman.client needs at least Python version 2.6.
11
while mailman.client needs at least Python version 2.6.
87
12
12
88
13
It's probably a good idea to set up a virtual Python environment using
13
It's probably a good idea to set up a virtual Python environment using
90
14
`virtualenv`_.  `Here is a brief HOWTO`_.
14
`virtualenv`_.  `Here is a brief HOWTO`_. You would need two separate virtual
91
15
environment one using Python version 2.6 (for Postorius and mailman.client)
92
16
and other using Python version 3.4 (for Mailman core).
93
15
17
94
16
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
18
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
95
17
.. _`Here is a brief HOWTO`: ./ArchiveUIin5.html#get-it-running-under-virtualenv
19
.. _`Here is a brief HOWTO`: ./ArchiveUIin5.html#get-it-running-under-virtualenv
96
@@ -24,19 +26,17 @@
97
24
First download the latest revision of Mailman 3 from Launchpad.
26
First download the latest revision of Mailman 3 from Launchpad.
98
25
::
27
::
99
26
28
108
27
  $ bzr branch lp:mailman
29
  $(py3) bzr branch lp:mailman
109
28
30
110
29
Install and test::
31
Install the Core::
111
30
32
112
31
  $ cd mailman
33
  $(py3) cd mailman
113
32
  $ python bootstrap.py
34
  $(py3) python setup.py develop
106
33
  $ bin/buildout
107
34
  $ bin/test
114
35
35
115
36
If you get no errors you can now start Mailman::
36
If you get no errors you can now start Mailman::
116
37
37
119
38
  $ bin/mailman start
38
  $(py3) mailman start
120
39
  $ cd ..
39
  $(py3) cd ..
121
40
40
122
41
At this point Mailman will not send nor receive any real emails.  But that's
41
At this point Mailman will not send nor receive any real emails.  But that's
123
42
fine as long as you only want to work on the components related to the REST
42
fine as long as you only want to work on the components related to the REST
124
@@ -46,31 +46,18 @@
125
46
mailman.client (the Python bindings for Mailman's REST API)
46
mailman.client (the Python bindings for Mailman's REST API)
126
47
===========================================================
47
===========================================================
127
48
48
128
49
Now you should switch to the virtual environment running Python version 2.6
129
49
Download from Launchpad::
50
Download from Launchpad::
130
50
51
132
51
  $ bzr branch lp:mailman.client
52
  $(py2) bzr branch lp:mailman.client
133
52
53
134
53
Install in development mode to be able to change the code without working
54
Install in development mode to be able to change the code without working
135
54
directly on the PYTHONPATH.
55
directly on the PYTHONPATH.
136
55
::
56
::
137
56
57
155
57
  $ cd mailman.client
58
  $(py2) cd mailman.client
156
58
  $ sudo python setup.py develop
59
  $(py2) sudo python setup.py develop
157
59
  $ cd ..
60
  $(py2) cd ..
141
60
142
61
143
62
Django >= 1.3
144
63
=============
145
64
146
65
Postorius is a pluggable Django application.  Therefore you need to have
147
66
Django (at least version 1.3) installed.
148
67
::
149
68
150
69
  $ wget http://www.djangoproject.com/download/1.3.1/tarball/ -O Django-1.3.1.tar.gz
151
70
  $ tar xzf Django-1.3.1.tar.gz
152
71
  $ cd Django-1.3.1
153
72
  $ sudo python setup.py install
154
73
  $ cd ..
158
74
61
159
75
62
160
76
Postorius
63
Postorius
161
@@ -78,19 +65,21 @@
162
78
65
163
79
::
66
::
164
80
67
168
81
  $ bzr branch lp:postorius
68
  $(py2) bzr branch lp:postorius
169
82
  $ cd postorius
69
  $(py2) cd postorius
170
83
  $ sudo python setup.py develop
70
  $(py2) sudo python setup.py develop
171
84
71
172
85
72
173
86
Start the development server
73
Start the development server
174
87
============================
74
============================
175
88
75
177
89
::
76
Since postorius is a django app which can be used with any django project. We
178
77
have an project already developed which you can setup like this::
179
90
78
183
91
  $ cd dev_setup
79
  $(py2) bzr branch lp:~mailman-coders/postorius/postorius_standalone
184
92
  $ python manage.py syncdb
80
  $(py2) cd postorius_standalone
185
93
  $ python manage.py runserver
81
  $(py2) python manage.py syncdb
186
82
  $(py2) python manage.py runserver
187
94
83
188
95
The last command will start the dev server on http://localhost:8000.
84
The last command will start the dev server on http://localhost:8000.
189
96
85
Status:	Merged
Approved by:	Barry Warsaw on 2015-01-20
Approved revision:	no longer in the source branch.
Merged at revision:	7291
Proposed branch:	lp:~raj-abhilash1/mailman/docs
Merge into:	lp:mailman
Diff against target:	187 lines (+56/-39) 3 files modified src/mailman/database/alembic/env.py (+7/-2) src/mailman/docs/DATABASE.rst (+23/-0) src/mailman/docs/WebUIin5.rst (+26/-37)
To merge this branch:	bzr merge lp:~raj-abhilash1/mailman/docs
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Barry Warsaw		2015-01-17	Approve on 2015-01-20
Review via email: mp+246822@code.launchpad.net