Skip to content
Newer
Older
100644 50 lines (35 sloc) 1.59 KB
ebbc566 Changed documentation section styles to be consistent (and to the sec…
ojii authored
1 ###########################
6364e81 @kezabelle Standardising references to the CMS as 'django CMS' where they're inc…
kezabelle authored
2 Using South with django CMS
ebbc566 Changed documentation section styles to be consistent (and to the sec…
ojii authored
3 ###########################
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
4
86c993f Some minor fixes in the using south documentation
ojii authored
5 South is an incredible piece of software that lets you handle database
6 migrations. This document is by no means meant to replace the
7 excellent `documentation`_ available online, but rather to give a quick primer
b17d235 @stephenmuss Documentation cleanup: fixed typos, grammar, etc.
stephenmuss authored
8 on why you should use South and how to get started quickly.
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
9
10
ebbc566 Changed documentation section styles to be consistent (and to the sec…
ojii authored
11 ************
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
12 Installation
ebbc566 Changed documentation section styles to be consistent (and to the sec…
ojii authored
13 ************
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
14
b17d235 @stephenmuss Documentation cleanup: fixed typos, grammar, etc.
stephenmuss authored
15 As always using Django and Python is a joy. Installing South is
16 as simple as typing::
3e4ab3b @chrisglass - Beautified using_south a little
chrisglass authored
17
4a37654 @jsma Replaced tabs => 4-spaces in docs for consistency as alternating tabs…
jsma authored
18 pip install South
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
19
9d45d86 @piquadrat added "django" namespace to all Django settings
piquadrat authored
20 Then, simply add ``south`` to the list of :setting:`django:INSTALLED_APPS` in your
86c993f Some minor fixes in the using south documentation
ojii authored
21 ``settings.py`` file.
22
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
23
ebbc566 Changed documentation section styles to be consistent (and to the sec…
ojii authored
24 ***********
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
25 Basic usage
ebbc566 Changed documentation section styles to be consistent (and to the sec…
ojii authored
26 ***********
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
27
3e4ab3b @chrisglass - Beautified using_south a little
chrisglass authored
28 For a very short crash course:
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
29
6768cea @piquadrat added more sphinx refs, fixed a couple of typos, enabled intersphinx …
piquadrat authored
30 #. Instead of the initial ``manage.py syncdb`` command, simply run
86c993f Some minor fixes in the using south documentation
ojii authored
31 ``manage.py schemamigration --initial <app name>``. This will create a new
32 migrations package, along with a new migration file (in the form of a python
33 script).
b17d235 @stephenmuss Documentation cleanup: fixed typos, grammar, etc.
stephenmuss authored
34 #. Run the migration using ``manage.py migrate``. Your tables will be created
35 in the database and Django will work as usual.
86c993f Some minor fixes in the using south documentation
ojii authored
36 #. Whenever you make changes to your models.py file, run
37 ``manage.py schemamigration --auto <app name>`` to create a new migration
b17d235 @stephenmuss Documentation cleanup: fixed typos, grammar, etc.
stephenmuss authored
38 file. Next run ``manage.py migrate`` to apply the newly created migration.
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
39
40
ebbc566 Changed documentation section styles to be consistent (and to the sec…
ojii authored
41 ****************************
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
42 More information about South
ebbc566 Changed documentation section styles to be consistent (and to the sec…
ojii authored
43 ****************************
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
44
86c993f Some minor fixes in the using south documentation
ojii authored
45 Obviously, South is a very powerful tool and this simple crash course is only
46 the very tip of the iceberg. Readers are highly encouraged to have a quick
47 glance at the excellent official South `documentation`_.
7d94d5b @chrisglass - Initial braindump of "using South" crash course
chrisglass authored
48
b17d235 @stephenmuss Documentation cleanup: fixed typos, grammar, etc.
stephenmuss authored
49 .. _documentation: http://south.aeracode.org/docs/index.html
Something went wrong with that request. Please try again.