https://github.com/lig/regme

User registration and management library using MongoEngine
https://github.com/lig/regme

Last synced: 2 days ago
JSON representation

User registration and management library using MongoEngine

• Host: GitHub
• URL: https://github.com/lig/regme
• Owner: lig
• License: apache-2.0
• Created: 2014-03-11T16:15:56.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-04-24T10:27:10.000Z (over 10 years ago)
• Last Synced: 2024-09-20T01:07:23.988Z (14 days ago)
• Language: Python
• Size: 371 KB
• Stars: 11
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Registration for MongoEngine

============================

User registration and management library using MongoEngine

Features

--------

* Create inactive user

* Generate activation token

* Try to activate user via activation token

* Set user password

* Check is activation token expired

* Integrate with django.contrib.auth

* Registration form

* Activation form

* Sample/default registration templates

TODO

----

* Django command to prune users that were not activated.

Installation

------------

`pip install regme`

Configuration

-------------

In addition to [MongoEngine Django support settings](http://docs.mongoengine.org/django.html) Regme requires following settings:

    # The number of days activation token will be valid

    ACCOUNT_ACTIVATION_DAYS = 7

    

    # Regme custom user document for MongoEngine

    # You should not change it unless you know what are you doing

    MONGOENGINE_USER_DOCUMENT = 'regme.documents.User'

    

    # Include regme into installed apps list 

    INSTALLED_APPS = (

        # …

        'django.contrib.auth',

        # …

        'mongoengine.django.mongo_auth',

        # …

        'regme',

        # …

    )

    

    # Site information (domain and name) for use in activation mail messages

    SITE = {'domain': 'domain.tld', 'name': 'Site Name'}

Usage

-----

### Simple

* Include `regme.urls` into your `urlconf`.

* Use tag `{% url 'register' %}` to point to the regme registration view.

* (Optional) Override default templates placed in `regme/templates` folder.

### Advanced

* Use or subclass `regme.forms.UserCreationForm` and `regme.forms.UserActivationForm` manually.

* Subclass `regme.documents.User` and perform whatever magic you want.

Contribute

----------

Feel free to report any issue or fork this project on [Regme Github page](https://github.com/lig/regme).

Authors

-------

[Serge Matveenko](https://github.com/lig)

License

-------

Apache License. See `LICENSE` file.