Commits

Andrew Godwin  committed f22b820

Version bump to 1.0.

  • Participants
  • Parent commits 6d90a8e

Comments (0)

Files changed (5)

File docs/conf.py

 # built documents.
 #
 # The short X.Y version.
-version = '0.8'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.8.4'
+release = '1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

File docs/installation.rst

 Installation
 ============
 
-South's current release is :ref:`0.8.4 <0-8-4-release-notes>`.
+South's current release is :ref:`1.0 <1-0-release-notes>`.
 
 There are a few different ways to install South:
 
- - :ref:`Using easy_install <installation-easy-install>` (or pip), which is recommended if you want stable releases.
+ - :ref:`Using pip or easy_install <installation-easy-install>`, which is recommended if you want stable releases.
  - :ref:`Using a Mercurial checkout <installation-mercurial>`, recommended if you want cutting-edge features.
- - :ref:`Using our downloadable archives <installation-archives>`, useful if you don't have easy_install or Mercurial.
  
 Some Linux distributions are also starting to include South in their package
 repositories; if you're running unstable Debian you can
 
 .. _installation-easy-install:
  
-Using easy_install
-------------------
+Using pip or easy_install
+-------------------------
 
-If you have easy_install available on your system, just type::
+If you have pip or easy_install available on your system, just type::
+
+ pip install South
+
+ # or
 
  easy_install South
  
 If you've already got an old version of South, and want to upgrade, use::
 
+ pip install -U South
+
+ # or
+
  easy_install -U South
  
 That's all that's needed to install the package; you'll now want to
 Once you have this directory, move onto :ref:`installation-from-directory`.
 
 
-.. _installation-archives:
-
-Using downloadable archives
----------------------------
-
-If you're averse to using Mercurial, and don't have easy_install available, then
-you can install from one of our ``.tar.gz`` files.
-
-First, download the archive of your choice from
-`our releases page <http://aeracode.org/releases/south>`_, and extract it to
-create a ``south`` folder. Then, proceed with our instructions for
-:ref:`installation-from-directory`.
-
-
-
 .. _installation-from-directory:
 
 Installing from a directory

File docs/releasenotes/1.0.rst

+
+.. _1-0-release-notes:
+
+=========
+South 1.0
+=========
+
+This is the last major release of South, as migrations have been
+`rolled into Django itself <https://docs.djangoproject.com/en/dev/topics/migrations/>`_
+as part of the 1.7 release, and my efforts are now concentrated there. South
+will continue to receive security updates but no feature updates will be
+provided.
+
+An upgrade path is provided for those moving from South to the new-style
+migrations; more details are available
+`in the Django documentation <https://docs.djangoproject.com/en/dev/topics/migrations/#upgrading-from-south>`_.
+The migrations framework in 1.7 is based on South but with significant
+design and stability improvements that were only possible after modifying
+Django itself; the result is a world-class schema migration system.
+
+I'd like to thank all the contributors to South over the years for their
+work in helping me keep everything together, and all the South users for
+making a small side project I started in 2007 (eight years ago at the time
+of writing) into one of the most popular Django apps of all time.
+
+
+Backwards incompatible changes
+==============================
+
+None (it would be a really nasty time to introduce these)
+
+
+Library migration path
+======================
+
+As part of providing a migration path for authors of third-party apps
+and libraries for Django, South will now first look for migrations in the
+``south_migrations`` directory, and then fall back to the ``migrations``
+directory if this is not found.
+
+This is intended to alleviate the namespace clash between South and Django
+migrations; prior to this, both were looking for a directory called
+``migrations``, and so it was impossible to ship a third-party app with support
+for both South and Django 1.7.
+
+The recommendation is that you move your South migrations into the
+``south_migrations`` directory (existing users will not notice the change
+if they upgrade South first), and then start a new set of Django 1.7
+migrations in a ``migrations`` directory (the default).
+
+If your users are stubborn and refuse to upgrade South, they may instead
+change the ``SOUTH_MIGRATION_MODULES`` setting for your app to point to
+the new ``south_migrations`` directory.
+
+This does obviously entail keeping two sets of migrations around, but
+the two systems have some fundamental differences that mean it was impossible
+to have one solution that would work across both codebases. At the end
+of the day, this allows you to interact with each migrations system on its
+own level, rather than some third abstraction layer that would probably be
+the worst of both worlds.

File docs/releasenotes/index.rst

    0.8.2
    0.8.3
    0.8.4
+   1.0

File south/__init__.py

 South - Useable migrations for Django apps
 """
 
-__version__ = "0.8.4"
+__version__ = "1.0"
 __authors__ = [
     "Andrew Godwin <andrew@aeracode.org>",
     "Andy McCurdy <andy@andymccurdy.com>"