Fixed #18115 - added warning about overlaid install.

you will need to uninstall the old Django version before installing the

new version.

If you installed Django using ``setup.py install``, uninstalling

is as simple as deleting the ``django`` directory from your Python

``site-packages``.

If you installed Django using pip_ or ``easy_install`` previously, installing

with pip_ or ``easy_install`` again will automatically take care of the old

version, so you don't need to do it yourself.

If you installed Django from a Python egg, remove the Django ``.egg`` file,

and remove the reference to the egg in the file named ``easy-install.pth``.

This file should also be located in your ``site-packages`` directory.

.. _finding-site-packages:

.. admonition:: Where are my ``site-packages`` stored?

    The location of the ``site-packages`` directory depends on the operating

    system, and the location in which Python was installed. To find out your

    system's ``site-packages`` location, execute the following:

If you previously installed Django using ``python setup.py install``,

uninstalling is as simple as deleting the ``django`` directory from your Python

``site-packages``. To find the directory you need to remove, you can run the

following at your shell prompt (not the interactive Python prompt):

.. code-block:: bash

        python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"

    python -c "import sys; sys.path = sys.path[1:]; import django; print django.__path__"

    (Note that this should be run from a shell prompt, not a Python interactive

    prompt.)

    Some Debian-based Linux distributions have separate ``site-packages``

    directories for user-installed packages, such as when installing Django

    from a downloaded tarball. The command  listed above will give you the

    system's ``site-packages``, the user's directory can be found in

    ``/usr/local/lib/`` instead of ``/usr/lib/``.

.. _install-django-code:

   run the command ``python setup.py install``. This will install Django in

   your Python installation's ``site-packages`` directory.

   .. admonition:: Removing an old version

       If you use this installation technique, it is particularly important

       that you :ref:`remove any existing

       installations<removing-old-versions-of-django>` of Django

       first. Otherwise, you can end up with a broken installation that

       includes files from previous versions that have since been removed from

       Django.

.. _download page: https://www.djangoproject.com/download/

.. _bsdtar: http://gnuwin32.sourceforge.net/packages/bsdtar.htm

.. _7-zip: http://www.7-zip.org/

   This will create a directory ``django-trunk`` in your current directory.

3. Next, make sure that the Python interpreter can load Django's code. The most

   convenient way to do this is to `modify Python's search path`_. Add a ``.pth``

   file containing the full path to the ``django-trunk`` directory to your

   system's ``site-packages`` directory. For example, on a Unix-like system:

3. Make sure that the Python interpreter can load Django's code. The most

   convenient way to do this is via pip_. Run the following command:

   .. code-block:: bash

       sudo pip install -e django-trunk/

   (If using a virtualenv_ you can omit ``sudo``.)

   This will make Django's code importable, and will also make the

   ``django-admin.py`` utility command available. In other words, you're all

   set!

   If you don't have pip_ available, see the alternative instructions for

   `installing the development version without pip`_.

.. warning::

    Don't run ``sudo python setup.py install``, because you've already

    carried out the equivalent actions in step 3.

When you want to update your copy of the Django source code, just run the

command ``git pull`` from within the ``django-trunk`` directory. When you do

this, Git will automatically download any changes.

.. _Git: http://git-scm.com/

.. _`modify Python's search path`: http://docs.python.org/install/index.html#modifying-python-s-search-path

.. _installing-the-development-version-without-pip:

Installing the development version without pip

----------------------------------------------

If you don't have pip_, you can instead manually `modify Python's search

path`_.

First follow steps 1 and 2 above, so that you have a ``django-trunk`` directory

with a checkout of Django's latest code in it. Then add a ``.pth`` file

containing the full path to the ``django-trunk`` directory to your system's

``site-packages`` directory. For example, on a Unix-like system:

.. code-block:: bash

    echo WORKING-DIR/django-trunk > SITE-PACKAGES-DIR/django.pth

   (In the above line, change ``SITE-PACKAGES-DIR`` to match the location of

   your system's ``site-packages`` directory, as explained in the

   :ref:`Where are my site-packages stored? <finding-site-packages>` section

   above. Change ``WORKING-DIR/django-trunk`` to match the full path to your

   new ``django-trunk`` directory.)

In the above line, change ``WORKING-DIR/django-trunk`` to match the full path

to your new ``django-trunk`` directory, and change ``SITE-PACKAGES-DIR`` to

match the location of your system's ``site-packages`` directory.

The location of the ``site-packages`` directory depends on the operating

system, and the location in which Python was installed. To find your system's

``site-packages`` location, execute the following:

.. code-block:: bash

    python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()"

(Note that this should be run from a shell prompt, not a Python interactive

prompt.)

Some Debian-based Linux distributions have separate ``site-packages``

directories for user-installed packages, such as when installing Django from

a downloaded tarball. The command listed above will give you the system's

``site-packages``, the user's directory can be found in ``/usr/local/lib/``

instead of ``/usr/lib/``.

Next you need to make the ``django-admin.py`` utility available in your

shell PATH.

4. On Unix-like systems, create a symbolic link to the file

On Unix-like systems, create a symbolic link to the file

``django-trunk/django/bin/django-admin.py`` in a directory on your system

path, such as ``/usr/local/bin``. For example:

On Windows systems, the same result can be achieved by copying the file

``django-trunk/django/bin/django-admin.py`` to somewhere on your system

path, for example ``C:\Python27\Scripts``.

.. warning::

    Don't run ``sudo python setup.py install``, because you've already

    carried out the equivalent actions in steps 3 and 4. Furthermore, this is

    known to cause problems when updating to a more recent version of Django.

When you want to update your copy of the Django source code, just run the

command ``git pull`` from within the ``django-trunk`` directory. When you do

this, Git will automatically download any changes.

.. _Git: http://git-scm.com/

.. _`modify Python's search path`: http://docs.python.org/install/index.html#modifying-python-s-search-path

from distutils.core import setup

from distutils.command.install_data import install_data

from distutils.command.install import INSTALL_SCHEMES

from distutils.sysconfig import get_python_lib

import os

import sys

# Warn if we are installing over top of an existing installation. This can

# cause issues where files that were deleted from a more recent Django are

# still present in site-packages. See #18115.

overlay_warning = False

if "install" in sys.argv:

    # We have to try also with an explicit prefix of /usr/local in order to

    # catch Debian's custom user site-packages directory.

    for lib_path in get_python_lib(), get_python_lib(prefix="/usr/local"):

        existing_path = os.path.abspath(os.path.join(lib_path, "django"))

        if os.path.exists(existing_path):

            # We note the need for the warning here, but present it after the

            # command is run, so it's more likely to be seen.

            overlay_warning = True

            break

class osx_install_data(install_data):

    # On MacOS, the platform-specific lib dir is /System/Library/Framework/Python/.../

    # which is wrong. Python 2.5 supplied with MacOS 10.5 has an Apple-specific fix

        'Topic :: Software Development :: Libraries :: Python Modules',

   ],

)

if overlay_warning:

    sys.stderr.write("""

========

WARNING!

========

You have just installed Django over top of an existing

installation, without removing it first. Because of this,

your install may now include extraneous files from a

previous version that have since been removed from

Django. This is known to cause a variety of problems. You

should manually remove the

%(existing_path)s

directory and re-install Django.

""" % { "existing_path": existing_path })