Skip to main content

User registration and management library using MongoEngine

Project description

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',
# …
)


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.

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

regme-0.2.5.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file regme-0.2.5.tar.gz.

File metadata

  • Download URL: regme-0.2.5.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for regme-0.2.5.tar.gz
Algorithm Hash digest
SHA256 6b32e7fbad90590b20044725022131ffc5cb5c3d7eb905d64953936efd29f050
MD5 35cdfa3c8284ee2f6e5777dafa71f0d9
BLAKE2b-256 49e7f6fca827615df27ed1fd934082347770243e580beae8b86525fa60681292

See more details on using hashes here.

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