<commit_before>.. Userena documentation master file, created by
   sphinx-quickstart on Fri Jul  2 09:28:08 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Userena Introduction
====================

This documentation covers the first release of django-userena application. A
Django application that takes care off all your account needs. These were
selected by looking at web applications and picking those that every modern web
application needs. A few examples of these are the following: 

* After signup a user get's a activation email. A user can make use of the
  application ``USERENA_ACTIVATION_DAYS`` days before having to activate their
  account.  The user also get's a notification if their account is still not
  activated ``USERENA_ACTIVATION_NOTIFY_DAYS`` days before the activation
  key get's invalid.

* A user can signin with their e-mail address or username (as seen at Github).
  Django-userena will define which one is used and try to sign the user in with
  supplied credentials.

* At signin the user can choose to be remembered for
  ``USERENA_REMEMBER_ME_DAYS`` of time.

* Usernames defined in ``USERENA_FORBIDDEN_USERNAMES`` list are not allowed at
  signup.

* Changing your e-mail address also needs verification. Only after the URI
  inside the verification e-mail is clicked will the new e-mail address become
  active.

* Each account has their own detail page, for ex. ``/accounts/jane/`` and each
  account also has it's own settings page accessible by the owner. For ex.
  ``/accounts/me/``.

Contents
========

.. toctree::
   :maxdepth: 2
   
   installation
   settings
   commands
   todo

**API**

.. toctree::
   :maxdepth: 2<commit_msg>Changed intro documentation<commit_after>.. Userena documentation master file, created by
   sphinx-quickstart on Fri Jul  2 09:28:08 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Userena Introduction
====================

This documentation covers the first release of django-userena application. A
Django application that takes care off all your account needs.

Want to experience it first? Go to django-userena.org and create an account for
yourself.

Why userena?
================

Because we have done the hard work for you. Userena supplies you with signup,
signin, account editing, privacy settings for your users and more. Everything
is tested with unit-tests, with a 100% code coverage as requirement. All you
have to do is plug it into your project and you will have all of this for free.

The following things are build into userena:

    - User has to **activate** their account by clicking on a activation link
      in an email send to them.

    - **Permissions** for viewing, changing and deleting accounts is
      implemented on an user and object basis with the help of django-guardian.

    - Optionally **secure** userena by using https. If you change the settings
      to use https, userena will switch to the secure protocol on it's views
      and emails.

    - All **templates** are already supplied for you. Only override those that
      don't fit with your needs!

    - Mugshots supplied by **Gravatar** or uploaded by the user. The default
      mugshot can be set in the settings.

    - *TODO*: Optional **Messaging** system between users and a notification
      system for administrators.

    - *TODO*: Optional **Friends** system which let's users become friends.
      Special permissions can be granted to users that are friends.

Please help us out!
===================

Found a bug in userena? File an issue at Github. Have an improvement? Fork it
and add it, or if you can't code it, contact us to do it.

Contents
========

.. toctree::
   :maxdepth: 2
   
   installation
   settings
   commands
   todo

**API**

.. toctree::
   :maxdepth: 2
{'fraction_non_alphanumeric': 0.07698190160591384, 'fraction_numerical': 0.007392301809839409, 'mean_word_length': 3.6328217237308147, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5345063', 'n_tokens_mistral': 1076, 'n_tokens_neox': 1028, 'n_words': 550}