wbcore 2.2.1__tar.gz

wbcore-2.2.1/.gitignore

@@ -0,0 +1,181 @@
+~
+
+# Docker volumes
+volumes/
+
+# Poetry auth file
+auth.toml
+
+media/*
+media/
+mediafiles/
+mediafiles/*
+test/*
+staticfiles/*
+staticfiles/
+#
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+info/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+.dccache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+report.xml
+*/report.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+*.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*.ipynb
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.vscode/
+.idea/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+crm/
+# Cython debug symbols
+cython_debug/
+
+# Gitlab Runner
+builds
+builds/
+
+# Integrator Office 365 : reverse proxy tunnel for outlook365
+ngrok
+*/ngrok
+/modules/**/system/
+
+/modules/wbmailing/files/*
+/modules/wbmailing/mailing/*
+
+/projects/*/requirements.txt
+public
+
+# Ignore archive localization generated folder
+backend/modules/**/archive/*
+**/**/requirements.txt
+CHANGELOG-*

wbcore-2.2.1/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.3
+Name: wbcore
+Version: 2.2.1
+Author-email: Christopher Wittlinger <c.wittlinger@stainly.com>
+Requires-Dist: boto3==1.*
+Requires-Dist: celery[redis]==5.*
+Requires-Dist: croniter==2.*
+Requires-Dist: cryptography<=42
+Requires-Dist: django-admin-inline-paginator==0.4.0
+Requires-Dist: django-anymail==12.*
+Requires-Dist: django-better-admin-arrayfield==1.4.*
+Requires-Dist: django-celery-beat==2.*
+Requires-Dist: django-colorfield==0.11.*
+Requires-Dist: django-configurations[database]==2.5.*
+Requires-Dist: django-cors-headers==4.6.*
+Requires-Dist: django-dynamic-preferences==1.16.*
+Requires-Dist: django-extensions==3.2.*
+Requires-Dist: django-filter==24.*
+Requires-Dist: django-fsm==3.*
+Requires-Dist: django-guardian==2.4.*
+Requires-Dist: django-import-export==4.*
+Requires-Dist: django-maintenance-mode==0.21.*
+Requires-Dist: django-mptt==0.*
+Requires-Dist: django-ordered-model==3.7.*
+Requires-Dist: django-picklefield==3.*
+Requires-Dist: django-rest-fuzzysearch==0.5.*
+Requires-Dist: django-reversion-compare==0.18.*
+Requires-Dist: django-reversion==5.1.*
+Requires-Dist: django-storages[boto3]==1.14.*
+Requires-Dist: django==5.0.*
+Requires-Dist: djangorestframework-guardian==0.3.*
+Requires-Dist: djangorestframework-simplejwt==5.*
+Requires-Dist: djangorestframework==3.*
+Requires-Dist: faker==25.*
+Requires-Dist: firebase-admin==6.*
+Requires-Dist: graphviz==0.*
+Requires-Dist: ics==0.*
+Requires-Dist: igraph==0.*
+Requires-Dist: inscriptis==1.*
+Requires-Dist: langchain-openai==0.2.*
+Requires-Dist: langchain>=0.3
+Requires-Dist: markdown-blockdiag==0.*
+Requires-Dist: markdown==3.*
+Requires-Dist: numpy==1.*
+Requires-Dist: openpyxl==3.*
+Requires-Dist: pandas==2.2.*
+Requires-Dist: phonenumbers==8.*
+Requires-Dist: plotly==5.*
+Requires-Dist: prettytable==0.*
+Requires-Dist: psycopg[binary]==3.*
+Requires-Dist: pycountry==23.*
+Requires-Dist: pyjwt==2.*
+Requires-Dist: pysftp==0.*
+Requires-Dist: pytest-sftpserver==1.*
+Requires-Dist: python-magic==0.*
+Requires-Dist: python-slugify==8.*
+Requires-Dist: redis==4.*
+Requires-Dist: requests==2.*
+Requires-Dist: rstr==3.2.*
+Requires-Dist: schwifty==2024.*
+Requires-Dist: tatsu==5.*
+Requires-Dist: tqdm==4.*

wbcore-2.2.1/pyproject.toml

@@ -0,0 +1,112 @@
+[project]
+name = "wbcore"
+description = ""
+authors = [{ name = "Christopher Wittlinger", email = "c.wittlinger@stainly.com"}]
+dynamic = ["version"]
+
+dependencies = [
+  # Database Depenendencies
+  "redis == 4.*",
+  "psycopg[binary] == 3.*",
+
+  # Generic Python Dependencies
+  "python-slugify == 8.*",
+  "requests == 2.*",
+  "inscriptis == 1.*",   # TODO: Discuss if really needed
+
+  # Django Dependencies
+  "django == 5.0.*",
+  "django-configurations[database] == 2.5.*",
+  "django-dynamic-preferences == 1.16.*",
+  "django-filter == 24.*",
+  "django-extensions == 3.2.*",
+  "django-cors-headers == 4.6.*",
+  "django-storages[boto3] == 1.14.*",
+  "django-fsm == 3.*",  # TODO: Remove after viewflow
+  "django-ordered-model == 3.7.*",
+
+  # Django Rest Framework Dependencies
+  "djangorestframework == 3.*",
+  "djangorestframework-simplejwt == 5.*",
+  "pyjwt == 2.*",
+  "django-rest-fuzzysearch == 0.5.*",
+
+  # Background and Periodic Tasks
+  "celery[redis] == 5.*",
+  "django-celery-beat == 2.*",
+
+  # Model Object Permissions
+  "django-guardian == 2.4.*",
+  "djangorestframework-guardian == 0.3.*",
+
+  # Revision System
+  "django-reversion == 5.1.*",
+  "django-reversion-compare == 0.18.*",
+
+  # Datascience
+  "numpy == 1.*",
+  "pandas == 2.2.*",
+
+  # Visualization
+  "plotly == 5.*",
+
+  # Markdown
+  "markdown == 3.*",
+  "markdown-blockdiag == 0.*",
+
+  # Terminal Formatting and Utils
+  "tqdm == 4.*",
+  "prettytable == 0.*",
+  "igraph == 0.*",
+  "openpyxl == 3.*",
+
+  "django-colorfield == 0.11.*",
+  "django-better-admin-arrayfield == 1.4.*",
+  "django-picklefield == 3.*",
+
+  "firebase-admin == 6.*",
+  # Pinned to 42 to silence deprecation warning (TripleDES)
+  # We need to substitute pysftp with paramiko/fabric
+  # Issue: https://gitlab.com/stainly/workbench/-/issues/5402
+  # Ref: https://github.com/paramiko/paramiko/issues/2419#issuecomment-2250013087
+  "cryptography <= 42",
+  "pysftp == 0.*",
+
+  "croniter == 2.*",
+  "python-magic == 0.*",
+  "django-import-export == 4.*",
+  "django-admin-inline-paginator == 0.4.0",
+  "django-anymail == 12.*",
+  "pytest-sftpserver == 1.*",
+  "django-mptt == 0.*",
+  "pycountry == 23.*",
+  "phonenumbers == 8.*",
+  "schwifty == 2024.*",
+  "ics == 0.*",
+  "tatsu == 5.*",
+  "boto3 == 1.*",
+
+  "faker == 25.*",       # We add exlicitly faker because it's used in production
+  "graphviz == 0.*",
+  "django-maintenance-mode == 0.21.*",
+  "rstr == 3.2.*", # We add exlicitly faker because it's used in production
+  "langchain >= 0.3",
+  "langchain-openai == 0.2.*",
+]
+
+[tool.uv]
+package = true
+
+[tool.hatch.version]
+path = "../../pyproject.toml"
+
+[tool.hatch.build.targets.sdist]
+include = ["wbcore/*"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["wbcore"]
+only-packages = true
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

wbcore-2.2.1/wbcore/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

wbcore-2.2.1/wbcore/admin.py

@@ -0,0 +1,197 @@
+import csv
+from functools import partial
+from io import StringIO
+
+import pandas as pd
+from django import forms
+from django.contrib import admin
+from django.contrib.admin.checks import InlineModelAdminChecks
+from django.contrib.admin.options import flatten_fieldsets
+from django.forms import ALL_FIELDS
+from django.forms.models import modelform_defines_fields
+from django.http import HttpResponse
+from django.shortcuts import redirect, render
+from django.urls import path
+from django.utils.translation import gettext_lazy as _
+
+from .content_type.admin import ContentTypeModelAdmin  # noqa: F401
+from .forms import NonrelatedInlineFormSet, nonrelated_inlineformset_factory
+from .markdown.admin import AssetModelAdmin  # noqa: F401
+from .models import AppliedPreset, FrontendUserConfiguration, Preset
+from .release_notes.admin import ReleaseNoteModelAdmin  # noqa: F401
+
+admin.site.register(AppliedPreset)
+admin.site.register(Preset)
+
+
+class FrontendUserConfigurationInline(admin.TabularInline):
+    model = FrontendUserConfiguration
+    extra = 0
+    fields = ["id", "user", "config"]
+    readonly_fields = ["id", "user", "config"]
+
+
+@admin.register(FrontendUserConfiguration)
+class FrontendUserConfigurationModelAdmin(admin.ModelAdmin):
+    list_display = ["id", "user"]
+    search_fields = ["user__email", "user__username", "id"]
+    fieldsets = ((_("Main Information"), {"fields": ("user", "parent_configuration", "config")}),)
+    inlines = [FrontendUserConfigurationInline]
+    list_filter = ["user"]
+
+
+class CsvImportForm(forms.Form):
+    csv_file = forms.FileField()
+
+
+class ExportCsvMixin:
+    def export_as_csv(self, admin, request, queryset, *args, **kwargs):
+        meta = queryset.model._meta
+        field_names = [field.name for field in meta.fields]
+
+        response = HttpResponse(content_type="text/csv")
+        response["Content-Disposition"] = "attachment; filename={}.csv".format(meta)
+        writer = csv.writer(response)
+
+        writer.writerow(field_names)
+        for obj in queryset:
+            writer.writerow([getattr(obj, field) for field in field_names])
+
+        return response
+
+    def get_actions(self, request):
+        actions = super().get_actions(request)
+        actions["export_as_csv"] = (self.export_as_csv, "export_as_csv", "Export Selected")
+        return actions
+
+
+class ImportCsvMixin:
+    change_list_template = "wbcore/admin/change_list.html"
+
+    def get_urls(self):
+        urls = super().get_urls()
+        my_urls = [path("import-csv/", self._import_csv)]
+        return my_urls + urls
+
+    def manipulate_df(self, df):
+        return df
+
+    def process_model(self, model):
+        self.model.create(**model)
+
+    def get_import_fields(self):
+        return [f.name for f in self.model._meta.get_fields()]
+
+    def _import_csv(self, request):
+        if request.method == "POST":
+            csv_file = request.FILES["csv_file"]
+
+            str_text = ""
+            for line in csv_file:
+                str_text = str_text + line.decode()
+            # Import csv as df
+            df = pd.read_csv(StringIO(str_text))
+            # Sanitize dataframe
+            df = df.where(pd.notnull(df), None)
+            df = df.drop(df.columns.difference(self.get_import_fields()), axis=1)
+
+            # Overide this function if there is foreign key ids in the dataframe
+            df = self.manipulate_df(df)
+            errors = 0
+            for model in df.to_dict("records"):
+                # by default, process the modela as a create request. Can be override to change the behavior
+                try:
+                    self.process_model(model)
+                except Exception:
+                    errors += 1
+            self.message_user(
+                request,
+                _("Your CSV file has been imported ( {imports}  imported, {errors} errors)").format(
+                    imports=df.shape[0] - errors, errors=errors
+                ),
+            )
+            return redirect("..")
+        form = CsvImportForm()
+        payload = {"form": form}
+        return render(request, "wbcore/admin/csv_form.html", payload)
+
+
+class NonrelatedInlineModelAdminChecks(InlineModelAdminChecks):
+    """
+    Check used by the admin system to determine whether or not an inline model
+    has a relationship to the parent object.
+    In this case we always want this check to pass.
+    """
+
+    def _check_exclude_of_parent_model(self, obj, parent_model):
+        return []
+
+    def _check_relation(self, obj, parent_model):
+        return []
+
+
+class NonrelatedInlineMixin:
+    """
+    Mixin for models not explicitly related to the inline model.
+    """
+
+    checks_class = NonrelatedInlineModelAdminChecks
+    formset = NonrelatedInlineFormSet
+
+    def get_form_queryset(self, obj):
+        raise NotImplementedError()
+
+    def save_new_instance(self, parent, instance):
+        raise NotImplementedError()
+
+    def save_formset(self, request, form, formset, change):
+        instances = formset.save(commit=False)
+        for instance in instances:
+            self.update_instance(formset.instance, instance)
+            instance.save()
+        formset.save_m2m()
+
+    def get_formset(self, request, obj=None, **kwargs):
+        if "fields" in kwargs:
+            fields = kwargs.pop("fields")
+        else:
+            fields = flatten_fieldsets(self.get_fieldsets(request, obj))
+
+        exclude = [*(self.exclude or []), *self.get_readonly_fields(request, obj)]
+        if self.exclude is None and hasattr(self.form, "_meta") and self.form._meta.exclude:
+            exclude.extend(self.form._meta.exclude)
+        exclude = exclude or None
+
+        can_delete = self.can_delete and self.has_delete_permission(request, obj)
+
+        queryset = self.model.objects.none()
+        if obj:
+            queryset = self.get_form_queryset(obj)
+
+        defaults = {
+            "form": self.form,
+            "formfield_callback": partial(self.formfield_for_dbfield, request=request),
+            "formset": self.formset,
+            "extra": self.get_extra(request, obj),
+            "can_delete": can_delete,
+            "can_order": False,
+            "fields": fields,
+            "min_num": self.get_min_num(request, obj),
+            "max_num": self.get_max_num(request, obj),
+            "exclude": exclude,
+            "queryset": queryset,
+            **kwargs,
+        }
+
+        if defaults["fields"] is None and not modelform_defines_fields(defaults["form"]):
+            defaults["fields"] = ALL_FIELDS
+
+        return nonrelated_inlineformset_factory(self.model, save_new_instance=self.save_new_instance, **defaults)
+
+
+class NonrelatedStackedInline(NonrelatedInlineMixin, admin.StackedInline):
+    pass
+
+
+class NonrelatedTabularInline(NonrelatedInlineMixin, admin.TabularInline):
+    pass

wbcore-2.2.1/wbcore/apps.py

@@ -0,0 +1,17 @@
+from django.apps import AppConfig
+from django.db.models.signals import post_migrate
+
+from .management import create_wbcore_permissions
+
+
+class WBCoreConfig(AppConfig):
+    name = "wbcore"
+
+    def ready(self):
+        """
+        We load received after all apps are ready in order to be able to discover all subclasses
+        """
+        post_migrate.connect(
+            create_wbcore_permissions,
+            dispatch_uid="wbcore.management.create_wbcore_permissions",
+        )

wbcore-2.2.1/wbcore/cache/buttons.py

@@ -0,0 +1,22 @@
+from django.utils.translation import gettext_lazy as _
+from rest_framework.reverse import reverse
+from wbcore.contrib.icons import WBIcon
+from wbcore.enums import RequestType
+from wbcore.metadata.configs import buttons as bt
+from wbcore.metadata.configs.identifiers import IdentifierViewConfig
+
+
+def add_clear_cache_button(sender, instance, request, view, pk=None, **kwargs):
+    if request.user.is_superuser and not instance:
+        cache_key = view._get_cache_key()
+        identifier = IdentifierViewConfig(view, request, instance=instance).get_metadata()
+        return bt.ActionButton(
+            method=RequestType.PATCH,
+            icon=WBIcon.DOWNLOAD.icon,
+            identifiers=(identifier,),
+            endpoint=reverse("wbcore:clear_cache", args=[cache_key], request=request),
+            action_label=_("Clear Cache"),
+            title=_("Clear Cache"),
+            label=_("Clear Cache"),
+            description_fields=_("Clear Cache"),
+        )

wbcore-2.2.1/wbcore/cache/decorators.py

@@ -0,0 +1,29 @@
+from typing import Callable
+
+from ..signals.instance_buttons import add_extra_button
+from .buttons import add_clear_cache_button
+from .registry import periodic_cache_registry
+
+
+def cache_table(
+    timeout: int | Callable | None = None,
+    key_prefix: str | Callable | None = None,
+    periodic_caching: bool = False,
+    periodic_caching_view_kwargs: list[dict[str, str]] | Callable | None = None,
+    periodic_caching_get_parameters: list[dict[str, str]] | Callable | None = None,
+):
+    def _decorator(pandas_view_class):
+        setattr(pandas_view_class, "CACHE_ENABLED", True)
+        setattr(pandas_view_class, "CACHE_TIMEOUT", timeout)
+        setattr(pandas_view_class, "CACHE_KEY_PREFIX", key_prefix)
+        add_extra_button.connect(add_clear_cache_button, sender=pandas_view_class, weak=False)
+
+        if periodic_caching:
+            periodic_cache_registry.add(
+                pandas_view_class,
+                view_kwargs=periodic_caching_view_kwargs,
+                get_parameters=periodic_caching_get_parameters,
+            )
+        return pandas_view_class
+
+    return _decorator

wbcore-2.2.1/wbcore/cache/mixins.py

@@ -0,0 +1,48 @@
+from functools import cached_property
+from typing import Any
+
+import pandas as pd
+from django.core.cache import cache
+from wbcore.utils.strings import camel_to_snake_case
+
+
+class CacheMixin:
+    extra_cache_kwargs: dict[str, Any]
+    CACHE_EMPTY_VALUE = pd.DataFrame()
+    CACHE_MAIN_KEY: str = "df"
+    CACHE_METHOD: str = "_get_dataframe"
+
+    @cached_property
+    def cache_enabled(self) -> bool:
+        return getattr(self, "CACHE_ENABLED", False)
+
+    def _get_cache_timeout(self) -> int | None:
+        cache_timeout = getattr(self, "CACHE_TIMEOUT", None)
+        if callable(cache_timeout):
+            return cache_timeout()
+        return cache_timeout
+
+    def _get_cache_key(self) -> str:
+        cache_key = camel_to_snake_case(self.__class__.__name__)
+        if cache_key_prefix := getattr(self, "CACHE_KEY_PREFIX", None):
+            if callable(cache_key_prefix):
+                cache_key_prefix = cache_key_prefix()
+            cache_key += "-" + cache_key_prefix
+        return cache_key
+
+    def deserialize_cache_results(self, cached_res: dict[str, Any]) -> Any:
+        res = cached_res.pop(self.CACHE_MAIN_KEY, self.CACHE_EMPTY_VALUE)
+        # we loop over the other cached kwargs and set them as class attributes
+        for k, v in cached_res.items():
+            setattr(self, k, v)
+        return res
+
+    def serialize_cache_results(self, res: Any) -> dict[str, Any]:
+        cached_res = {self.CACHE_MAIN_KEY: res}
+        cached_res.update(self.extra_cache_kwargs)
+        return cached_res
+
+    def _get_cached_res(self) -> Any:
+        if cached_res := cache.get(self._get_cache_key()):
+            return self.deserialize_cache_results(cached_res)
+        return self.CACHE_EMPTY_VALUE