ngits-users 2.1.0__py3-none-any.whl

ngits_users-2.1.0.dist-info/METADATA

@@ -0,0 +1,396 @@
+Metadata-Version: 2.4
+Name: ngits-users
+Version: 2.1.0
+Summary: Base users application for Django projects
+Author: NGITs
+License: BSD-3-Clause
+Project-URL: Homepage, https://ngits.dev
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+Requires-Dist: Django==5.*
+Requires-Dist: djangorestframework==3.*
+Requires-Dist: drf-spectacular==0.27.*
+Requires-Dist: requests==2.*
+Requires-Dist: celery==5.*
+Requires-Dist: redis==5.*
+Requires-Dist: django-phonenumber-field[phonenumberslite]==8.*
+Requires-Dist: Pillow==10.*
+Requires-Dist: pillow-heif==0.18.*
+
+ngits-users
+============
+
+Base ‘users’ application for Django projects. It provides following endpoints:
+
+    - Registration
+    - Background registration
+    - Login
+    - Change password
+    - Change email
+    - Remind password
+    - Delete account
+    - Google authentication
+    - Facebook authentication
+
+... and following template views:
+
+    - Verify account
+    - Confirm password remind
+
+
+Setup
+-----
+
+1. Install using pip:
+~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+       pip install ngits-users
+
+2. Change your ``settings`` file:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+       import os
+
+       ...
+
+       INSTALLED_APPS = [
+           ...
+           "rest_framework",
+           "rest_framework.authtoken",
+           "users"
+       ]
+
+       ...
+
+       AUTH_USER_MODEL = "users.User"
+
+       CELERY_BROKER_URL = "<redis_url>"
+       CELERY_RESULT_BACKEND = "<redis_url>"
+
+       DEFAULT_FROM_EMAIL = os.environ.get("DEFAULT_FROM_EMAIL", "<your_email>")
+
+       REST_FRAMEWORK = {
+           "DEFAULT_AUTHENTICATION_CLASSES": [
+               "rest_framework.authentication.TokenAuthentication",
+           ],
+           # Optional
+           "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
+       }
+
+       REGISTRATION_EMAIL_SUBJECT = "<email subject>"
+       REMIND_EMAIL_SUBJECT = "<email subject>"
+
+       # debugging
+       EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
+
+3. Add paths to your ``urls.py`` file:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+       from django.urls import path, include
+
+       urlpatterns = [
+           ...
+           path("users/", include("users.urls"))
+       ]
+
+4. Run migrations:
+~~~~~~~~~~~~~~~~~~
+
+::
+
+       py manage.py migrate
+
+5. Add following variables to your ``.env`` file:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      # smpt config
+      DEFAULT_FROM_EMAIL=no-reply@ngits.dev
+
+      EMAIL_HOST=
+      EMAIL_HOST_PASSWORD=
+      EMAIL_HOST_USER=
+      EMAIL_PORT=
+
+      # celery
+      CELERY_BROKER_URL=
+      CELERY_RESULT_BACKEND=
+
+6. Celery configuration:
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+``../<django_project>/<proj_name>/celery.py``
+
+::
+
+
+       import os
+
+       from celery import Celery
+
+       os.environ.setdefault("DJANGO_SETTINGS_MODULE", "<proj_name>.settings")
+
+       app = Celery("<proj_name>")
+       app.config_from_object("django.conf:settings", namespace="CELERY")
+       app.autodiscover_tasks()
+
+``../<django_project>/<proj_name>/__init__.py``
+
+::
+
+      from .celery import app as celery_app
+
+      __all__ = ("celery_app",)
+
+7. Optional ``redoc`` configuration:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+       pip install drf-spectacular==0.23.*
+
+``settings.py``:
+
+::
+
+       INSTALLED_APPS = [
+           ...
+           "drf_spectacular"
+       ]
+
+       SPECTACULAR_SETTINGS = {
+           "TITLE": "<proj_name> API",
+           "VERSION": "1.0.0",
+       }
+
+       TEMPLATES = [
+           ...
+           'DIRS': [ BASE_DIR / "templates"],
+           ...
+       ]
+
+``urls.py``:
+
+::
+
+        from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView
+
+        ...
+
+        urlpatterns = [
+            ...
+            path(
+                "docs/schema/",
+                SpectacularAPIView.as_view(),
+                name="schema"
+            ),
+            path(
+                "docs/redoc/",
+                SpectacularRedocView.as_view(url_name="schema"),
+                name="redoc",
+            ),
+        ]
+
+``../<django_project>/templates/redoc.html``:
+
+::
+
+       <!DOCTYPE html>
+       <html>
+           <head>
+               <title>ReDoc</title>
+               <!-- needed for adaptive design -->
+               <meta charset="utf-8"/>
+               <meta name="viewport" content="width=device-width, initial-scale=1">
+               <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+               <!-- ReDoc doesn't change outer page styles -->
+               <style>
+                   body {
+                       margin: 0;
+                       padding: 0;
+                   }
+               </style>
+           </head>
+           <body>
+               <redoc spec-url='{% url schema_url %}'></redoc>
+               <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+           </body>
+       </html>
+
+Finally generate YAML schema of documentation:
+
+::
+
+    py manage.py spectacular --file schema.yml
+
+
+8. Optional ``templates`` override:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In order to override the default templates you have to create new files in your configured templates directory named:
+    - Email templates: **these should contain {{ url|safe }}**
+        - ``change_password_email.html``
+        - ``change_password_email.txt``
+        - ``registration_email.html``
+        - ``registration_email.txt``
+    - View templates:
+        - ``change_password.html`` - **this have to contain {{ form }} !**
+        - ``verify_ok.html``
+        - ``verify_error.html``
+
+There's also additional :code:`{{ email }}` context param you can use in your email templates.
+
+e.g.:
+
+::
+
+    /repo
+        /manage.py
+        /templates
+            /change_password_email.html
+            /change_password_email.txt
+            /change_password.html
+
+*For fore details check out library default templates*
+
+9. Optional ``TokenSerializer`` override:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can override ``TokenSerializer`` - the default response serializer on ``LoginView`` `(/login)`.
+
+In order to use your own serializer, you need to follow these steps:
+
+1. Create your custom serializer:
+
+e.g.:
+
+::
+
+    from rest_framework import serializers
+    from rest_framework.authtoken.models import Token
+
+    ...
+
+    class TestSerializer(serializers.ModelSerializer):
+        foo = serializers.SerializerMethodField()
+
+        class Meta:
+            model = Token
+            fields = ("key", "user_id", "foo")
+
+        def get_foo(self, obj):
+            return "bar"
+
+**Warning!** Your custom serializer must handle incoming DRF ``Token`` object!
+
+2. Set serializer path in your ``settings`` file
+
+e.g.:
+
+::
+
+    LOGIN_RESPONSE_SERIALIZER_PATH = "app.serializers.TestSerializer"
+
+3. Take it for a spin!
+
+::
+
+    HTTP 200 OK
+    Allow: POST, OPTIONS
+    Content-Type: application/json
+    Vary: Accept
+
+    {
+        "key": "a5851e7359d1d04cd99a26014e47fcbedaa0beea",
+        "user_id": 1,
+        "foo": "bar"
+    }
+
+10. Optional ``AvatarDownloadView`` access checker:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can override access verification for ``AvatarDownloadView`` `(/<user_id>/avatar/)`.
+
+By default, every authenticated user can download another user's avatar. If you need custom rules
+(e.g. tenant isolation, organization membership, ownership), define your own checker and point to it
+from settings.
+
+In the checker:
+
+- ``request.user`` is the authenticated user making the request
+- ``target_user`` is the user selected by ``<user_id>`` in the URL, whose avatar is being downloaded
+
+1. Create your custom checker:
+
+e.g.:
+
+::
+
+    def check_same_tenant(request, target_user):
+        return request.user.tenant_id == target_user.tenant_id
+
+The checker must accept ``(request, target_user)`` and return ``True`` when access should be allowed.
+
+2. Set checker path in your ``settings`` file
+
+e.g.:
+
+::
+
+    AVATAR_ACCESS_CHECKER_PATH = "app.permissions.check_same_tenant"
+
+3. Take it for a spin!
+
+::
+
+    GET /users/12/avatar/
+    Authorization: Token <your_token>
+
+If the checker returns ``False``, the endpoint responds with:
+
+::
+
+    HTTP 403 Forbidden
+    Allow: GET, HEAD, OPTIONS
+    Content-Type: application/json
+    Vary: Accept
+
+    {
+        "detail": "Access denied."
+    }
+
+Login response codes
+--------------------
+
+400 response:
+
++---------------+--------------------+
+| error_code    | error_msg          |
++===============+====================+
+| 00            | Login failed       |
++---------------+--------------------+
+| 01            | User not found     |
++---------------+--------------------+
+| 02            | User not active    |
++---------------+--------------------+
+
+Additional information
+----------------------
+
+This package also support *django tranlations*.

ngits_users-2.1.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+users/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+users/admin.py,sha256=oTBfVcN6A33DqFQaaI0Kot-5KoTuUhJZ_xoofur8fBE,368
+users/apps.py,sha256=Ir-G4cq3zwq5nb9Fv5wDi01xUJECboxjEoAVavE5DPQ,193
+users/forms.py,sha256=yoSV9r43l0jVZfmJdGxxUvvtQBpxHPIBs8oKqCUoXQc,1997
+users/models.py,sha256=4Nk-Qk79FAG11GUHaobF65SGSiB2w8D_PvCxqs-gjuQ,703
+users/schemas.py,sha256=sYDKKH8Ztvv5vH4QE--N9V1DCCb4YI0PAwAjJgAfor4,3657
+users/serializers.py,sha256=VwewejEwy8smWtB9zpe_4ueHcHDeegaUWT0WNBOzef8,3740
+users/signals.py,sha256=GiEBkxcrTuIm-LBsL_bVX7qHcytb3OdJEeYJE3J5gbs,357
+users/tasks.py,sha256=_cJTy-Tx7UjX4uD3Pez6D6sZke3ets0gW4iqElrSWGQ,603
+users/urls.py,sha256=0ayeEk3Jk13yuPcb2XLVp3TOaPpt6EULJt4A1Xnj3n0,1643
+users/utils.py,sha256=sIbiEmKX2Yk_C1D6g218Oi88G91eaPONyyPhfO8kBiw,3068
+users/views.py,sha256=5WkYRgKQPjD1JXAoNgQrXye8xvg3LE3Wvi9Sx8Dsz6E,18170
+users/migrations/0001_initial.py,sha256=RyHfGIdsEBEdKFnASw3p8Gi65hEwuvWnpxIsFfkNWqs,3021
+users/migrations/0002_user_auto_logout_minutes_user_avatar_and_more.py,sha256=gBxMR1_gQ64M0Cz9AqLUY582jHDKbERZIypIk05zTcI,1035
+users/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+users/static/users/css/style.css,sha256=G061dGTiqVfDP-9pgX7aVRBm2hiihF8FIh_RkiS12SI,2333
+users/static/users/img/fail.svg,sha256=sh8jXNIqASerPlUCrROgEvXoixB8eC0qpVY73-TTwYU,11327
+users/static/users/img/success.svg,sha256=LFYa1J4-I0sHZ5wDfXshTdzKJy6UN7I95-zdW58WnzM,20062
+users/templates/change_password.html,sha256=6P_FaKiKGeLKmxxEP1IcMNyBzvcVttKSLp0mXWG--qg,538
+users/templates/change_password_email.html,sha256=ZknMOFKacNWKaJdfc8eFn8BYOOCPwdW6iWcUjUi7_oM,118
+users/templates/change_password_email.txt,sha256=Fcdtgvwj-egdv55y3x4L6Fx-QuqM4Z78_fpfFuBAmRU,71
+users/templates/form_site.html,sha256=3hMd_Z1WcoNiJ4o-EI4vZ6oVHhPYvOlAfOtgd2U1PCg,602
+users/templates/info_site.html,sha256=Z3teqPFyx-8yB-0111WY0b-X6T6eYL1XkVqLnep0R8U,575
+users/templates/password_changed.html,sha256=BzrlMjaN02gI2tQyWc7fmM2xDrahf4qAZIp7-1IZk0o,395
+users/templates/registration_email.html,sha256=5QAAD5VVghhzI-VGtNnn74c1lJTUaaPsenN3-7Hg9zE,117
+users/templates/registration_email.txt,sha256=u_zr-vK1f4FOhvJ48D0acxx70pV7UqlUuA97wCy3Xis,70
+users/templates/verify_error.html,sha256=dDMLQyjBsItacQ451GLqEgDFBUrWUGCFmBFAyk2uUbc,384
+users/templates/verify_ok.html,sha256=r98L7wUJZcmV6Qjl_jey9WRRKM3ihfuLOL5pi28Qb5Y,389
+ngits_users-2.1.0.dist-info/METADATA,sha256=FqwNP4KnrSxAjwZ51Glrju8-vXpG6PWuVfcvhrTexXg,9247
+ngits_users-2.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+ngits_users-2.1.0.dist-info/top_level.txt,sha256=tWT24ZcWau2wrlbpU_h3mP2jRukyLaVYiyHBuOezpLQ,6
+ngits_users-2.1.0.dist-info/RECORD,,

ngits_users-2.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ngits_users-2.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+users

users/admin.py

@@ -0,0 +1,13 @@
+from django.contrib import admin
+from django.contrib.auth import get_user_model
+from django.contrib.auth.admin import UserAdmin
+
+User = get_user_model()
+
+
+class UserAdmin(UserAdmin):
+    list_display = ("username", "email", "is_active", "account_type")
+    list_filter = ("account_type", "is_active", "is_superuser", "is_staff")
+
+
+admin.site.register(User, UserAdmin)

users/apps.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+
+
+class UsersConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "users"
+
+    def ready(self):
+        import users.signals

users/forms.py

@@ -0,0 +1,65 @@
+from django.contrib.auth import get_user_model
+from django.contrib.auth.password_validation import validate_password
+from django.core.exceptions import ValidationError
+from django.forms import (
+    CharField,
+    Form,
+    HiddenInput,
+    IntegerField,
+    PasswordInput,
+)
+from django.utils.translation import gettext as _
+
+from users.utils import get_hash
+
+User = get_user_model()
+
+
+class PasswordChangeForm(Form):
+    password = CharField(label=_("New password"), widget=PasswordInput())
+    repeat_password = CharField(
+        label=_("Repeat password"), widget=PasswordInput()
+    )
+    user = IntegerField(widget=HiddenInput(), required=False)
+    key = CharField(widget=HiddenInput(), required=False)
+
+    def clean_password(self):
+        try:
+            validate_password(self.cleaned_data["password"])
+        except ValidationError as e:
+            raise e
+
+        return self.cleaned_data["password"]
+
+    def clean(self):
+        cleaned_data = super().clean()
+
+        password = cleaned_data.get("password")
+        repeat_password = cleaned_data.get("repeat_password")
+        user_pk = cleaned_data.get("user")
+        key = cleaned_data.get("key")
+
+        if user_pk and key:
+            user = User.objects.filter(pk=user_pk).first()
+            if user:
+                hash = get_hash(user)
+
+                if not user.is_active:
+                    raise ValidationError("User's account is not activated!")
+
+                if hash != key:
+                    raise ValidationError("Data verification failed!")
+
+                cleaned_data["user"] = user
+            else:
+                raise ValidationError("User does not exists!")
+        else:
+            raise ValidationError("User/key not provided!")
+
+        if password and repeat_password:
+            if password != repeat_password:
+                raise ValidationError("Passwords are not equal!")
+        else:
+            raise ValidationError("Passwords not provided!")
+
+        return cleaned_data

users/migrations/0001_initial.py

@@ -0,0 +1,45 @@
+# Generated by Django 4.0.5 on 2022-09-12 07:25
+
+import django.contrib.auth.models
+import django.contrib.auth.validators
+from django.db import migrations, models
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='User',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('password', models.CharField(max_length=128, verbose_name='password')),
+                ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
+                ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
+                ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')),
+                ('first_name', models.CharField(blank=True, max_length=150, verbose_name='first name')),
+                ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')),
+                ('email', models.EmailField(blank=True, max_length=254, verbose_name='email address')),
+                ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
+                ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
+                ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')),
+                ('account_type', models.SmallIntegerField(choices=[(0, 'Anonymous'), (1, 'Standard'), (2, 'Google'), (3, 'Facebook')], default=1)),
+                ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.group', verbose_name='groups')),
+                ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.permission', verbose_name='user permissions')),
+            ],
+            options={
+                'verbose_name': 'user',
+                'verbose_name_plural': 'users',
+                'abstract': False,
+            },
+            managers=[
+                ('objects', django.contrib.auth.models.UserManager()),
+            ],
+        ),
+    ]

users/migrations/0002_user_auto_logout_minutes_user_avatar_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.2.14 on 2026-05-20 18:59
+
+import phonenumber_field.modelfields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("users", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="user",
+            name="auto_logout_minutes",
+            field=models.PositiveSmallIntegerField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="user",
+            name="avatar",
+            field=models.BinaryField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="user",
+            name="avatar_content_type",
+            field=models.CharField(blank=True, default="", max_length=50),
+        ),
+        migrations.AddField(
+            model_name="user",
+            name="phone",
+            field=phonenumber_field.modelfields.PhoneNumberField(
+                blank=True, default="", max_length=128, region=None
+            ),
+        ),
+    ]

users/models.py

@@ -0,0 +1,24 @@
+from django.contrib.auth.models import AbstractUser
+from django.db import models
+from phonenumber_field.modelfields import PhoneNumberField
+
+
+class User(AbstractUser):
+    class Type(models.IntegerChoices):
+        anonymous = 0
+        standard = 1
+        google = 2
+        facebook = 3
+
+    account_type = models.SmallIntegerField(
+        choices=Type.choices,
+        default=Type.standard,
+    )
+    phone = PhoneNumberField(blank=True, default="")
+    avatar = models.BinaryField(null=True, blank=True)
+    avatar_content_type = models.CharField(
+        max_length=50, blank=True, default=""
+    )
+    auto_logout_minutes = models.PositiveSmallIntegerField(
+        null=True, blank=True
+    )