Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed #19216 - Switched to user level installation in apps tutorial.

Thanks Nick Coghlan for the suggestion.
  • Loading branch information...
commit dd0d2c0be56a28f868d501b06975984c138f4830 1 parent 7f75460
Tim Graham authored October 31, 2012

Showing 1 changed file with 17 additions and 15 deletions. Show diff stats Hide diff stats

  1. 32  docs/intro/reusable-apps.txt
32  docs/intro/reusable-apps.txt
@@ -291,16 +291,19 @@ Using your own package
291 291
 Since we moved the ``polls`` directory out of the project, it's no longer
292 292
 working. We'll now fix this by installing our new ``django-polls`` package.
293 293
 
294  
-.. admonition:: Installing as a system library
  294
+.. admonition:: Installing as a user library
295 295
 
296  
-   The following steps install ``django-polls`` as a system library. In
297  
-   general, it's best to avoid messing with your system libraries to avoid
298  
-   breaking things. For this simple example though, the risk is low and it will
299  
-   help with understanding packaging. We'll explain how to uninstall in
300  
-   step 4.
  296
+   The following steps install ``django-polls`` as a user library. Per-user
  297
+   installs have a lot of advantages over installing the package system-wide,
  298
+   such as being usable on systems where you don't have administrator access
  299
+   as well as preventing the package from affecting system services and other
  300
+   users of the machine. Python 2.6 added support for user libraries, so if
  301
+   you are using an older version this won't work, but Django 1.5 requires
  302
+   Python 2.6 or newer anyway.
301 303
 
302  
-   For experienced users, a neater way to manage your packages is to use
303  
-   "virtualenv" (see below).
  304
+   Note that per-user installations can still affect the behavior of system
  305
+   tools that run as that user, so ``virtualenv`` is a more robust solution
  306
+   (see below).
304 307
 
305 308
 1. Inside ``django-polls/dist``, untar the new package
306 309
    ``django-polls-0.1.tar.gz`` (e.g. ``tar xzvf django-polls-0.1.tar.gz``). If
@@ -310,9 +313,9 @@ working. We'll now fix this by installing our new ``django-polls`` package.
310 313
 2. Change into the directory created in step 1 (e.g. ``cd django-polls-0.1``).
311 314
 
312 315
 3. If you're using GNU/Linux, Mac OS X or some other flavor of Unix, enter the
313  
-   command ``sudo python setup.py install`` at the shell prompt.  If you're
314  
-   using Windows, start up a command shell with administrator privileges and
315  
-   run the command ``setup.py install``.
  316
+   command ``python setup.py install --user`` at the shell prompt.  If you're
  317
+   using Windows, start up a command shell and run the command
  318
+   ``setup.py install --user``.
316 319
 
317 320
    With luck, your Django project should now work correctly again. Run the
318 321
    server again to confirm this.
@@ -320,7 +323,7 @@ working. We'll now fix this by installing our new ``django-polls`` package.
320 323
 4. To uninstall the package, use pip (you already :ref:`installed it
321 324
    <installing-reusable-apps-prerequisites>`, right?)::
322 325
 
323  
-    sudo pip uninstall django-polls
  326
+    pip uninstall django-polls
324 327
 
325 328
 .. _bsdtar: http://gnuwin32.sourceforge.net/packages/bsdtar.htm
326 329
 .. _7-zip: http://www.7-zip.org/
@@ -347,11 +350,10 @@ is choosing the license under which your code is distributed.
347 350
 Installing Python packages with virtualenv
348 351
 ==========================================
349 352
 
350  
-Earlier, we installed the polls app as a system library. This has some
  353
+Earlier, we installed the polls app as a user library. This has some
351 354
 disadvantages:
352 355
 
353  
-* Modifying the system libraries can affect other Python software on your
354  
-  system.
  356
+* Modifying the user libraries can affect other Python software on your system.
355 357
 
356 358
 * You won't be able to run multiple versions of this package (or others with
357 359
   the same name).

0 notes on commit dd0d2c0

Please sign in to comment.
Something went wrong with that request. Please try again.