Skip to content

Commit

Permalink
Version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
bennylope committed Jun 6, 2014
1 parent 8ffebb4 commit 1000fb1
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ django-organizations
====================

:Info: Groups and multi-user account management
:Version: 0.3.0
:Version: 0.4.0
:Author: Ben Lopatin (http://benlopatin.com)

.. image:: https://secure.travis-ci.org/wellfire/django-organizations.png?branch=master
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@
# built documents.
#
# The short X.Y version.
version = '0.3'
version = '0.4'
# The full version, including alpha/beta/rc tags.
release = '0.3.0'
release = '0.4.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
34 changes: 33 additions & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ You can specify a different model in your settings using the
You can use this setting to configure a custom user model or to refer to a
profile model if your project is using Django 1.4.

URLs
----

If you plan on using the default URLs, hook the application URLs into your main
application URL configuration in `urls.py`. If you plan on using the
invitation/registration system, set your backend URLs, too::
Expand All @@ -64,11 +67,40 @@ invitation/registration system, set your backend URLs, too::
url(r'^invitations/', include(invitation_backend().get_urls())),
)

Registration & invitation
-------------------------

You can specify a different :ref:`invitation backend <invitation-backend>` in
your project settings, and the `invitation_backend` function will provide the
URLs defined by that backend::
URLs defined by that backend. You can do the same with the
:ref:`registration backend <registration-backend>`::

ORGS_INVITATION_BACKEND = 'myapp.backends.MyInvitationBackend'
ORGS_REGISTRATION_BACKEND = 'myapp.backends.MyRegistrationBackend'

Timestamp model and slug field
------------------------------

Historically Django-Organizations relied on `django-extensions
<http://django-extensions.readthedocs.org/en/latest/>`_ for the base
`TimeStampedModel
<http://django-extensions.readthedocs.org/en/latest/model_extensions.html>`_
and `AutoSlugField
<http://django-extensions.readthedocs.org/en/latest/field_extensions.html>`_.
While these work great, this does require that every project install
django-extensions for two small features.

If you decide to use the default django-organization models by adding
`organizations` to your INSTALLED_APPS, you can choose a different
TimeStampedModel base and AutoSlugField. Just specify the full dotted path like so::

ORGS_SLUGFIELD = 'django_extensions.db.fields.AutoSlugField'
ORGS_TIMESTAMPED_MODEL = 'django_extensions.db.models.TimeStampedModel'

While you can specify the source of these classes, **their interfaces must be
consistent.** The TimeStampedModel should have two timestamp fields
(`DateTimeField`) named `created` and `modified`, respectively. The SlugField
must accept the `populate_from` keyword argument.

Users and multi-account membership
==================================
Expand Down
3 changes: 3 additions & 0 deletions requirements-test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ coverage
mock>=1.0.1
nose>=1.3.0
django-nose>=1.2

# Required to test default models
django-extensions>=0.9
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
],
install_requires=[
'Django>=1.4.2,<1.8',
'django-extensions>=0.9',
],
test_suite='tests',
include_package_data=True,
Expand Down

0 comments on commit 1000fb1

Please sign in to comment.