Commits

James Bennett committed 2efa46f

Documentation improvements and updates in anticipation of 0.7 release

Comments (0)

Files changed (5)

 django-registration changelog
 =============================
 
+
+Version 0.7, 6 November 2008:
+-----------------------------
+
+* Project hosting moved from Google Code to Bitbucket, and from a
+  Subversion repository to Mercurial.
+
+* Added test suite.
+
+* Full Django 1.0 compatibility.
+
+* Registration and activation views now accept an ``extra_context``
+  argument, identical to the way that argument works in Django's
+  generic views.
+
+* Added a custom management command for cleaning up expired
+  registrations; you can now run ``manage.py cleanupregistration`` to
+  handle this.
+
+* BACKWARDS-INCOMPATIBLE CHANGE: The "username" field in
+  ``RegistrationForm`` is now a ``RegexField``.
+
+* BACKWARDS-INCOMPATIBLE CHANGE: Removed the standalone script for
+  deleting expired user registrations; use the new management command
+  instead.
+
+
 Version 0.6, 29 July 2008:
 --------------------------
 
     
     To disable the email, call with ``send_email=False``.
     
+    The activation email will make use of two templates:
+
+    ``registration/activation_email_subject.txt``
+        This template will be used for the subject line of the
+        email. It receives one context variable, ``site``, which is
+        the currently-active ``django.contrib.sites.models.Site``
+        instance. Because it is used as the subject line of an email,
+        this template's output **must** be only a single line of text;
+        output longer than one line will be forcibly joined into only
+        a single line.
+
+    ``registration/activation_email.txt``
+        This template will be used for the body of the email. It will
+        receive three context variables: ``activation_key`` will be
+        the user's activation key (for use in constructing a URL to
+        activate the account), ``expiration_days`` will be the number
+        of days for which the key will be valid and ``site`` will be
+        the currently-active ``django.contrib.sites.models.Site``
+        instance.
+        
     To enable creation of a custom user profile along with the
     ``User`` (e.g., the model specified in the ``AUTH_PROFILE_MODULE``
     setting), define a function which knows how to create and save an

docs/overview.txt

 to stabilize Django's APIs prior to the 1.0 release,
 django-registration will not work with older releases of Django.
 
-Also, if you haven't downloaded a copy of django-registration already,
-you'll need to do so. You can download a packaged version of the
-latest release here::
+There are three basic ways to install django-registration:
+automatically installing a package using Python's package-management
+tools, manually installing a package, and installing from a Mercurial
 
-    http://django-registration.googlecode.com/files/django-registration-0.6.tar.gz
 
-Open up the package (on most operating systems you can double-click,
-or you can use the command ``tar zxvf registration-0.6.tar.gz`` to
-manually unpack it), and, at a command line, navigate to the directory
-``registration-0.6``, then type:
+Using a package-management tool
+-------------------------------
+
+The easiest way by far to install django-registration 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-registration
+
+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-registration
+
+And you'll be done.
+
+
+Manually installing the 0.7 package
+-----------------------------------
+
+If you'd prefer to do things the old-fashioned way, you can manually
+download the `django-registration 0.7 package`_ from the Python
+Package Index. This will get you a file named
+"django-registration-0.7.tar.gz" which you can unpack (double-click on
+the file on most operating systems) to create a directory named
+"django-registration-0.7". Inside will be a script named "setup.py";
+running::
 
     python setup.py install
 
-This will install django-registration into a directory on your Python
-import path. For system-wide installation on Linux/Unix and Mac OS,
-you can use ``sudo``::
+will install django-registration (though keep in mind that this
+defaults to a system-wide installation, and so may require
+administrative privileges on your computer).
 
-    sudo python setup.py install
 
-Alternatively, you do a Subversion checkout to get the latest
-development code (though this may also include bugs which have not yet
-been fixed)::
+Installing from a Mercurial checkout
+------------------------------------
 
-    svn co http://django-registration.googlecode.com/svn/trunk/registration/
+If you have `Mercurial`_ installed on your computer, you can also
+obtain a complete copy of django-registration by typing::
 
-For best results, do this in a directory that's on your Python path.
+    hg clone http://bitbucket.org/ubernostrum/django-registration/
+
+Inside the resulting "django-registration" directory will be a
+directory named "registration", 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 setup.py script in the
+"django-registration" directory to perform a normal installation, but
+using a symlink offers easy upgrades: simply running ``hg pull -u``
+inside the django-registration directory will fetch updates from the
+main repository and apply them to your local copy.
+
+
+.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall
+.. _pip: http://pypi.python.org/pypi/pip/
+.. _django-registration 0.7 package: http://pypi.python.org/pypi/django-registration/0.7
+.. _Mercurial: http://www.selenic.com/mercurial/wiki/
 
 
 Basic use
 means that errors from mismatched passwords will now show up in
 ``non_field_errors()`` instead of ``errors["password2"]``.
 
+Between version 0.6 and version 0.7, the script
+``registration/bin/delete_expired_users.py`` was removed, and replaced
+with a custom management command; you can now simply run ``manage.py
+cleanupregistration`` from any project which has django-registration
+installed.
+
 
 Dependencies
 ============

registration/models.py

         ``User``, returning the new ``User``.
         
         To disable the email, call with ``send_email=False``.
+
+        The activation email will make use of two templates:
+
+        ``registration/activation_email_subject.txt``
+            This template will be used for the subject line of the
+            email. It receives one context variable, ``site``, which
+            is the currently-active
+            ``django.contrib.sites.models.Site`` instance. Because it
+            is used as the subject line of an email, this template's
+            output **must** be only a single line of text; output
+            longer than one line will be forcibly joined into only a
+            single line.
+
+        ``registration/activation_email.txt``
+            This template will be used for the body of the email. It
+            will receive three context variables: ``activation_key``
+            will be the user's activation key (for use in constructing
+            a URL to activate the account), ``expiration_days`` will
+            be the number of days for which the key will be valid and
+            ``site`` will be the currently-active
+            ``django.contrib.sites.models.Site`` instance.
         
         To enable creation of a custom user profile along with the
         ``User`` (e.g., the model specified in the
       description='An extensible user-registration application for Django',
       author='James Bennett',
       author_email='james@b-list.org',
-      url='http://code.google.com/p/django-registration/',
+      url='http://www.bitbucket.org/ubernostrum/django-registration/wiki/',
+      download_url='http://www.bitbucket.org/ubernostrum/django-registration/get/v0.6.gz',
       package_dir={'registration': 'registration'},
       packages=packages,
       package_data={'registration': data_files},
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.