summaryrefslogtreecommitdiffstats
path: root/group_messaging/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'group_messaging/__init__.py')
-rw-r--r--group_messaging/__init__.py14
1 files changed, 14 insertions, 0 deletions
diff --git a/group_messaging/__init__.py b/group_messaging/__init__.py
new file mode 100644
index 00000000..642ad5c8
--- /dev/null
+++ b/group_messaging/__init__.py
@@ -0,0 +1,14 @@
+"""`group_messages` is a django application
+which allows users send messages to other users
+and groups (instances of :class:`django.contrib.auth.models.Group`)
+
+The same methods are used are used to send messages
+to users as to groups - achieved via special "personal groups".
+
+By convention - personal groups have names formatted as follows:
+_personal_<user id>, for example for the user whose `id == 1`,
+the group should be named `'_personal_1'`.
+
+Only one person must be a member of a personal group and
+each user must have such group.
+"""