Clone wiki

django-profiles / Home


This is a simple application which provides basic features for working with custom user profiles in Django projects. It implements the following:

  • Profile creation
  • Profile editing
  • Profile viewing, with controls on which profiles are publicly viewable

This application assumes that you are already have a working installation of Django 1.0 or newer, and that you are comfortable enough with Django to be able to, for example, create templates based on a description of what context variables are available to them, set up your own URL configuration and work with Django's forms system.

A useful companion to this application is django-registration, which implements user-registration functionality.

How to install

There are three basic ways to install: automatically installing a package using Python's package-management tools, manually installing a package, and installing from a Mercurial checkout.

Using a package-management tool

The easiest way by far to install django-profiles and most other interesting Python software is by using an automated package-management tool, so if you're not already familiar with the available tools for Python, now's as good a time as any to get started.

The most popular option currently is easy_install; refer to its documentation to see how to get it set up. Once you've got it, you'll be able to simply type

easy_install django-profiles

And it will handle the rest.

Another option that's currently gaining steam (and which I personally prefer for Python package management) is pip. Once again, you'll want to refer to its documentation to get up and running, but once you have you'll be able to type

pip install django-profiles

And you'll be done.

Manually installing the 0.2 package

If you'd prefer to do things the old-fashioned way, you can manually download the django-profiles 0.2 package from the Python Package Index. This will get you a file named "django-profiles-0.2.tar.gz" which you can unpack (double-click on the file on most operating systems) to create a directory named "django-profiles-0.2". Inside will be a script named ""; running

python install

will install django-profiles (though keep in mind that this defaults to a system-wide installation, and so may require administrative privileges on your computer).

Installing from a Mercurial checkout

If you have Mercurial installed on your computer, you can also obtain a complete copy of django-profiles by typing

hg clone

Inside the resulting "django-profiles" directory will be a directory named "profiles", which is the actual Python module for this application; you can symlink it from somewhere on your Python path. If you prefer, you can use the script in the "django-profiles" directory to perform a normal installation, but using a symlink offers easy upgrades: simply running "hg pull -u" inside the django-profiles directory will fetch updates from the main repository and apply them to your local copy.

After you've installed

Have a look at the documentation (included in the "docs/" directory of the package, or browsable online) to see the next steps. The overview document will tell you what you need to know to get started, and from there you can read the rest of the documentation to see all of the available options and features.