django-project-base 0.1.37.1__tar.gz

django_project_base-0.1.37.1/LICENSE

@@ -0,0 +1,22 @@
+Proprietary license
+
+Copyright Scantron A/S & Scantron d.o.o. & Velis d.o.o. & Jure Erznožnik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+and associated documentation files (the "Software"), to deal in the Software, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to
+do so, subject to the following conditions and restrictions:
+
+- Condition: The above copyright notice and permission notice shall be included in all
+  copies or substantial portions of the Software.
+- Restriction: Use of this Software, whether in original or modified form, is **expressly
+  prohibited** for purposes related to access control systems and/or intercom
+  (doorphone) technologies, including but not limited to development, deployment, or
+  integration by any person or entity operating in or serving such domains.
+
+The software is provided "as is", without warranty of any kind, express or implied, including
+but not limited to the warranties of merchantability, fitness for a particular purpose and
+noninfringement. In no event shall the authors or copyright holders be liable for any claim,
+damages or other liability, whether in an action of contract, tort or otherwise, arising from, out
+of or in connection with the software or the use or other dealings in the software.

django_project_base-0.1.37.1/MANIFEST.in

@@ -0,0 +1,5 @@
+include requirements.txt
+incluide LICENSE
+recursive-include django_project_base *
+global-exclude __pycache__
+global-exclude *.py[co]

django_project_base-0.1.37.1/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: django-project-base
+Version: 0.1.37.1
+Summary: Everything revolves around it: users, roles, permissions, tags, etc.
+Home-page: https://github.com/velis74/django-project-base
+Author: velis74
+Author-email: support@velis.si
+License: Proprietary
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: Django
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django
+Requires-Dist: djangorestframework
+Requires-Dist: dynamicforms>=0.77.17
+Requires-Dist: swapper
+Requires-Dist: django-rest-registration
+Requires-Dist: drf-spectacular<0.26.0,>=0.17.2
+Requires-Dist: django-taggit
+Requires-Dist: svgwrite
+Requires-Dist: django-hijack<3
+Requires-Dist: pytz
+Requires-Dist: tox
+Requires-Dist: social-auth-app-django
+Requires-Dist: django-permissions-policy
+Requires-Dist: django-csp
+Requires-Dist: requests
+Requires-Dist: boto3
+Requires-Dist: natural
+Requires-Dist: celery>=5.2
+Requires-Dist: pandas
+Requires-Dist: click>=8.1
+Requires-Dist: ruff
+Requires-Dist: ruff-lsp
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Notice to users of this library
+
+## This library is no longer free software.
+
+With 0.80.0 the library has gained a development partner that will doubtless raise it to new heights.
+
+The LICENSE has been modified to a proprietary one with restrictions, so please be mindful of conditions.
+
+The library is thus deprecated and in maintenance mode only.
+
+# Django project base
+
+A collection of functionalities that are common to most projects we do.
+
+- account management
+- project management
+- notifications (both to users and to apps)
+- tagging
+- background job processing
+- roles & permissions
+- profiling
+
+This project is in VERY early development stage. Some of the functionalities are not even developed yet, some need 
+major rework, but some, surprisingly, should work pretty well already. An example of pretty well functioning ones is 
+account management.
+
+## Example project
+
+For running example django project prepare python environment and run (run in repository root):
+
+```bash 
+$ pip install -r requirements.txt
+$ python manage.py runserver
+```
+
+## Documentation
+
+Run command in repository root:
+
+```bash 
+$ npm run docs:dev
+```
+
+The dev server should be running at http://localhost:5173. Visit the URL in your browser to read documentation!
+
+To generate pdf file. Run:
+
+```bash 
+$ npm run export-pdf  
+```
+
+Pdf file is located in docs/pdf folder.

django_project_base-0.1.37.1/README.md

@@ -0,0 +1,52 @@
+# Notice to users of this library
+
+## This library is no longer free software.
+
+With 0.80.0 the library has gained a development partner that will doubtless raise it to new heights.
+
+The LICENSE has been modified to a proprietary one with restrictions, so please be mindful of conditions.
+
+The library is thus deprecated and in maintenance mode only.
+
+# Django project base
+
+A collection of functionalities that are common to most projects we do.
+
+- account management
+- project management
+- notifications (both to users and to apps)
+- tagging
+- background job processing
+- roles & permissions
+- profiling
+
+This project is in VERY early development stage. Some of the functionalities are not even developed yet, some need 
+major rework, but some, surprisingly, should work pretty well already. An example of pretty well functioning ones is 
+account management.
+
+## Example project
+
+For running example django project prepare python environment and run (run in repository root):
+
+```bash 
+$ pip install -r requirements.txt
+$ python manage.py runserver
+```
+
+## Documentation
+
+Run command in repository root:
+
+```bash 
+$ npm run docs:dev
+```
+
+The dev server should be running at http://localhost:5173. Visit the URL in your browser to read documentation!
+
+To generate pdf file. Run:
+
+```bash 
+$ npm run export-pdf  
+```
+
+Pdf file is located in docs/pdf folder.

django_project_base-0.1.37.1/django_project_base/__init__.py

@@ -0,0 +1,6 @@
+__title__ = "django project base"
+# __version__ = "{version-string}"  #TODO: Switch back to version string when merging to main
+__version__ = "0.1.37.1"
+default_app_config = "django_project_base.apps.DjangoProjectBaseConfig"
+
+VERSION = __version__

django_project_base-0.1.37.1/django_project_base/account/__init__.py

@@ -0,0 +1,4 @@
+from .constants import ACCOUNT_APP_ID
+from .middleware import SessionMiddleware  #noqa
+
+default_app_config = "%s.apps.DjangoProjectBaseAccountsConfig" % ACCOUNT_APP_ID

django_project_base-0.1.37.1/django_project_base/account/apps.py

@@ -0,0 +1,13 @@
+from django.apps import AppConfig
+
+from django_project_base.account import ACCOUNT_APP_ID
+from django_project_base.account.settings import ACCOUNT_SETTINGS
+from django_project_base.settings_parser import parse_settings
+
+
+class DjangoProjectBaseAccountsConfig(AppConfig):
+    name = ACCOUNT_APP_ID
+    verbose_name = "Django Project Base Account management"
+
+    def ready(self):
+        parse_settings(ACCOUNT_SETTINGS)

django_project_base-0.1.37.1/django_project_base/account/authentication.py

@@ -0,0 +1,28 @@
+from rest_framework.authentication import SessionAuthentication
+
+
+# noinspection PyRedeclaration
+class SessionAuthentication(SessionAuthentication):
+    """
+    This is needed because original SessionAuthentication doesn't return anything is authenticate_header. And this means
+    that if user is not logged in, status of response would be 403 and not 401.
+    If authenticate_header returns some string, status of response will be 401.
+
+    This is only relevant for authentication class that if listed first in
+    REST_FRAMEWORK / DEFAULT_AUTHENTICATION_CLASSES setting.
+    Also see code in rest_framework.views.APIView.handle_exception and inside this function see call of function
+    self.get_authenticate_header
+
+    If you use this SessionAuthentication class instad of original one
+    (rest_framework.authentication.SessionAuthentication) you must also set
+    REST_REGISTRATION["LOGIN_AUTHENTICATE_SESSION"] to True in settings.py.
+    Without it, user won't be logged in.
+    See code in rest_registration.api.views.login.LoginView.post. Here is call to perform_login function. Inside that,
+    there is call of should_authenticate_session() that returns True if there is original SessionAuthentication class
+    listed in REST_FRAMEWORK / DEFAULT_AUTHENTICATION_CLASSES setting. If you are using inherited one,
+    it will return False by default. Except you set REST_REGISTRATION["LOGIN_AUTHENTICATE_SESSION"] setting to True in
+    settings.py.
+    """
+
+    def authenticate_header(self, request):
+        return "sessionid"

django_project_base-0.1.37.1/django_project_base/account/constants.py

@@ -0,0 +1,3 @@
+ACCOUNT_APP_ID = "django_project_base.account"
+MERGE_USERS_QS_CK = f"merge-users-list-%d"  # noqa: F541
+RESET_USER_PASSWORD_VERIFICATION_CODE = "reset-user-password-ver-identifier-"

django_project_base-0.1.37.1/django_project_base/account/management/commands/allauth_to_social_core.py

@@ -0,0 +1,46 @@
+import json
+
+from typing import Optional
+
+import social_core.backends.facebook
+import social_core.backends.google
+import social_core.backends.microsoft
+
+from django.db import connection
+from social_django.models import UserSocialAuth
+
+from django_project_base.profiling.performance_base_command import PerformanceCommand
+
+
+# This is not tested because there is no socialaccount model anymore
+class Command(PerformanceCommand):  # pragma: no cover
+    help = "Migrate social login data from allauth to social_core"
+
+    provider_mapping: dict = {
+        "google": social_core.backends.google.GoogleOAuth2.name,
+        "facebook": social_core.backends.facebook.FacebookOAuth2.name,
+        "azure": social_core.backends.microsoft.MicrosoftOAuth2.name,
+    }
+
+    def handle(self, *args, **options):
+        with connection.cursor() as cursor:
+            cursor.execute("select user_id, provider, extra_data from socialaccount_socialaccount;")
+            rows: list = cursor.fetchall()
+            for row in rows:
+                user_id: int = row[0]
+                provider: str = row[1]
+                extra_data: dict = json.loads(row[2]) if row[2] else {}
+                user_email: Optional[str] = extra_data.get("email") or extra_data.get("mail")
+                if user_email:
+                    new_provider: str = self.provider_mapping.get(provider)
+                    assert new_provider, "New social auth provider for %s is not defined" % provider
+                    payload = {
+                        "user_id": user_id,
+                        "provider": new_provider,
+                    }
+                    social_auth_records_exists: bool = UserSocialAuth.objects.filter(**payload).exists()
+                    if not social_auth_records_exists:
+                        payload["uid"] = user_email
+                        payload["extra_data"] = None
+                        UserSocialAuth.objects.create(**payload)
+        return "ok"

django_project_base-0.1.37.1/django_project_base/account/management/commands/delete_users.py

@@ -0,0 +1,23 @@
+import datetime
+import logging
+
+import swapper
+
+from django.db import transaction
+
+from django_project_base.profiling.performance_base_command import PerformanceCommand
+
+
+class Command(PerformanceCommand):
+    help = "Deletes users marked for deletion"
+
+    def handle(self, *args, **options):
+        for profile in swapper.load_model("django_project_base", "Profile").objects.filter(
+            delete_at__isnull=False, delete_at__lt=datetime.datetime.now()
+        ):
+            with transaction.atomic():
+                try:
+                    profile.delete()
+                except Exception as e:  # pragma: no cover
+                    logging.getLogger(__name__).error(e)
+        return "Finished deleting users"

django_project_base-0.1.37.1/django_project_base/account/middleware.py

@@ -0,0 +1,91 @@
+import json
+
+import swapper
+
+from django.conf import settings
+from django.contrib.sessions.middleware import SessionMiddleware as SessionMiddlewareBase
+from django.utils.functional import SimpleLazyObject
+from rest_framework.authentication import get_authorization_header
+
+
+class ProjectNotSelectedError(NotImplementedError):
+    def __init__(self, message: str, *args: object) -> None:
+        super().__init__(message, *args)
+        self.message = message
+
+
+def selected_project_not_setup():
+    raise ProjectNotSelectedError(
+        """The functionality called requires settings variables that establish currently selected project.
+        Check docs for DJANGO_PROJECT_BASE_BASE_REQUEST_URL_VARIABLES and its "project" setting.
+        The setting needs to be declared and currently selected project passed at least once from the front-end
+        """
+    )
+
+
+def load_selected_project(slug: str):
+    def load():
+        ProjectModel = swapper.load_model("django_project_base", "Project")
+        try:
+            return ProjectModel.objects.prefetch_related("owner").get(slug=slug)
+        except ProjectModel.DoesNotExist:
+            selected_project_not_setup()
+
+    return load
+
+
+class SessionMiddleware(SessionMiddlewareBase):
+    def get_request_params(self, request):
+        if request.method in ["POST", "PUT", "PATCH", "DELETE"]:
+            body_data = json.loads(request.body.decode("utf-8"))
+            if isinstance(body_data, list):
+                return body_data[0]
+            return body_data
+        else:
+            return getattr(request, request.method)
+
+    def process_request(self, request):
+        auth = get_authorization_header(request).split()
+        if auth and auth[0].lower() == b"sessionid":
+            session_key = auth[1].decode("utf-8")
+            setattr(request, "_dont_enforce_csrf_checks", True)
+        else:
+            session_key = request.COOKIES.get(settings.SESSION_COOKIE_NAME)
+
+        request.session = self.SessionStore(session_key)
+
+        # determine if currently selected project has been passed with the request and set it to session if so
+        # this requires UrlVarsMiddleware to have been installed before this middleware
+        current_project_attr = (
+            getattr(settings, "DJANGO_PROJECT_BASE_BASE_REQUEST_URL_VARIABLES", {})
+            .get("project", {})
+            .get("value_name", None)
+        )
+
+        # also set request.selected_project variables or throw errors on access if conditions not satisfied
+        if current_project_attr:
+            if curr_project_slug := getattr(request, current_project_attr, None):
+                request.session[current_project_attr] = curr_project_slug
+            else:
+                curr_project_slug = request.session.get(current_project_attr, None)
+
+            request.selected_project_slug = curr_project_slug
+            request.selected_project = SimpleLazyObject(load_selected_project(curr_project_slug))
+        else:
+            request.selected_project_slug = SimpleLazyObject(selected_project_not_setup)
+            request.selected_project = SimpleLazyObject(selected_project_not_setup)
+
+    def process_response(self, request, response):
+        process_response = super().process_response(request, response)
+        if getattr(response, "returntype", None) == "json" or "/dynamicforms/progress" in request.path:
+            # sometimes (i.e. at new user login) dynamicforms progress is called before user login...
+            # and it can happen, that responses come back after login. But response have request session id,
+            # that is not valid anymore (because login happened in the meantime).
+            # And when such response come back to frontend it starts using this session data for further requests.
+            # Which actually means that user is not logged in anymore.
+            # So we can just remove session data from dynamicforms/progress response. It shouldn't be needed anyway.
+            process_response.cookies.pop("sessionid", None)
+            process_response.cookies.pop("csrftoken", None)
+            process_response.csrf_cookie_set = False
+
+        return process_response