Skip to main content

Pluggable user accounts and profiles

Project description

Pluggable user accounts and profiles

django-uaccounts is a pluggable Django app that provides user registration, login/logout and a “forgot password” feature. Email verification is required for account activation and resetting password. The app also supports simple user profiles, with multiple email addresses that can be verified as well.

Installation

  • Download and install from PyPI:

pip install django-uaccounts
  • Add it to your INSTALLED_APPS, as well as ‘django.contrib.sites’:

INSTALLED_APPS = (
    ...
    'django.contrib.sites',
    ...
    'uaccounts',
    ...
)
  • Make sure you have a django.contrib.sites.models.Site instance saved in your database as django-uaccounts needs it to get the name and the domain of your site to include them in the verification emails.

  • Configure the email settings of your project as they are needed for sending the verification emails.

  • Include the urlconf of the app in your project’s urls.py:

from django.conf.urls import url, include

urlpatterns = [
    ...
    url(r'accounts/', include('uaccounts.urls', namespace='uaccounts')),
    ...
]

Of course, you can put it under any url you want, like r’’ or r’^mysite/myaccounts/’.

Usage

django-uaccounts can be a very simple standalone app, but its main purpose is to offer user account capabilities to your project, complementing your other apps. To test its usage on its own, you should be ready to go by now. However you probably want to let it know its “parent url”. This is a url to redirect to after a successful login, and provide a link for in the “profile” page, so the user can return to the main aspect of your website. This url can be set through the UACCOUNTS_HOME_URL setting.

Settings

All of the app settings are optional but you may want to modify them to customize to your needs, and most probably UACCOUNTS_HOME_URL to connect this app with the rest of your project.

  • UACCOUNTS_HOME_URL: The “parent url”. Can be an str or a call to django.core.urlresolvers.reverse_lazy.

    Default: django.core.urlresolvers.reverse_lazy(‘uaccounts:index’)

  • UACCOUNTS_USERNAME_MIN_LENGTH: Minimum allowed characters for username.

    Default: 4

  • UACCOUNTS_PASSWORD_MIN_LENGTH: Minimum allowed characters for password.

    Default: 6

  • UACCOUNTS_STATUS_MAX_LENGTH: Maximum allowed characters for status.

    Default: 200

  • UACCOUNTS_ACTIVATION_EXPIRES: Expiration time of an account activation request, in seconds. Can be an int or None for limitless time.

    Default: 24 * 60 * 60

  • UACCOUNTS_CHANGE_PASSWORD_EXPIRES: Expiration time of a “forgot password” request, in seconds. Can be an int or None for limitless time.

    Default: 60 * 60

  • UACCOUNTS_VERIFICATION_EXPIRES: Expiration time of an email verification request, in seconds. Can be an int or None for limitless time.

    Default: None

  • UACCOUNTS_AVATAR_DIR: Directory for uploading user avatars. It gets appended to your MEDIA_ROOT.

    Default: ‘avatars/’

  • UACCOUNTS_AVATAR_MAX_HEIGHT: Maximum allowed height for user avatars, in pixels. Avatars get resized (kept in scale) if this is exceeded.

    Default: 200

  • UACCOUNTS_AVATAR_MAX_WIDTH: Maximum allowed width for user avatars, in pixels. Avatars get resized (kept in scale) if this is exceeded.

    Default: 200

License

BSD

Author

Aristotelis Mikropoulos <amikrop@gmail.com>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-uaccounts-0.1.7.zip (61.4 kB view details)

Uploaded Source

Built Distributions

django_uaccounts-0.1.7-py2-none-any.whl (57.8 kB view details)

Uploaded Python 2

django-uaccounts-0.1.7.win32.exe (255.3 kB view details)

Uploaded Source

File details

Details for the file django-uaccounts-0.1.7.zip.

File metadata

File hashes

Hashes for django-uaccounts-0.1.7.zip
Algorithm Hash digest
SHA256 bc6b0231eaaeacd03fd7fe5a986013097d9509f81e6fdf98614f16c9a62c8255
MD5 4cc6c06786d1ec01cd718b0232a26dd3
BLAKE2b-256 9b92bee223906185439553ba627d694b3ad69459f69c4163ce81ba5b599a9a66

See more details on using hashes here.

Provenance

File details

Details for the file django_uaccounts-0.1.7-py2-none-any.whl.

File metadata

File hashes

Hashes for django_uaccounts-0.1.7-py2-none-any.whl
Algorithm Hash digest
SHA256 f01932305e8e21189a5284a59f2cc88d85d4e2c7df6a9e32b7fdd9ec4a2f93f9
MD5 f50c79a7b8591995c9be162140e0eea0
BLAKE2b-256 b0f3c897cf2b00788f7014757e6cbb25ac1bc89f5b902423086127fb2be83d30

See more details on using hashes here.

Provenance

File details

Details for the file django-uaccounts-0.1.7.win32.exe.

File metadata

File hashes

Hashes for django-uaccounts-0.1.7.win32.exe
Algorithm Hash digest
SHA256 b8588202006587f73d30996db1ea4113720c13800061fafb7c8f2b77c66514a3
MD5 479a0536e0c9ded8b3e84ff80e1f5c61
BLAKE2b-256 3d06612cf5abc5d2e2f14b24cdcd9557d6617c66a915dfc9865edd49ab7bc9de

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page