wbportfolio 2.2.1__py2.py3-none-any.whl

wbportfolio/contrib/company_portfolio/dynamic_preferences_registry.py

@@ -0,0 +1,87 @@
+from contextlib import suppress
+
+from django.db.utils import ProgrammingError
+from dynamic_preferences.preferences import Section
+from dynamic_preferences.registries import global_preferences_registry
+from wbcore.contrib.directory.models import CustomerStatus
+from wbcore.contrib.dynamic_preferences.types import (
+    CallableDefaultModelChoicePreference,
+)
+
+portfolio = Section("wbportfolio")
+
+
+def get_default_returning_client_customer_status():
+    with suppress(ProgrammingError):
+        return CustomerStatus.objects.filter(title="Returning Client").first()
+
+
+def get_default_lost_client_customer_status():
+    with suppress(ProgrammingError):
+        return CustomerStatus.objects.filter(title="Lost Client").first()
+
+
+def get_default_tpm_customer_status():
+    with suppress(ProgrammingError):
+        return CustomerStatus.objects.filter(title="Third Party Marketer (TPM)").first()
+
+
+def get_default_client_customer_status():
+    with suppress(ProgrammingError):
+        return CustomerStatus.objects.filter(title="Client").first()
+
+
+@global_preferences_registry.register
+class ReturningClientCustomerStatus(CallableDefaultModelChoicePreference):
+    section = portfolio
+    name = "returning_client_customer_status"
+    model = CustomerStatus
+
+    verbose_name = "Returning Client customer status"
+    help_text = "The customer status corresponding to the Returning Client Group"
+
+    @property
+    def default(self):
+        return get_default_returning_client_customer_status()
+
+
+@global_preferences_registry.register
+class LostClientCustomerStatus(CallableDefaultModelChoicePreference):
+    section = portfolio
+    name = "lost_client_customer_status"
+    model = CustomerStatus
+
+    verbose_name = "Lost Client customer status"
+    help_text = "The customer status corresponding to the Lost Client Group"
+
+    @property
+    def default(self):
+        return get_default_lost_client_customer_status()
+
+
+@global_preferences_registry.register
+class TPMCustomerStatus(CallableDefaultModelChoicePreference):
+    section = portfolio
+    name = "tpm_customer_status"
+    model = CustomerStatus
+
+    verbose_name = "TPM customer status"
+    help_text = "The customer status corresponding to the TPM group"
+
+    @property
+    def default(self):
+        return get_default_tpm_customer_status()
+
+
+@global_preferences_registry.register
+class ClientCustomerStatus(CallableDefaultModelChoicePreference):
+    section = portfolio
+    name = "client_customer_status"
+    model = CustomerStatus
+
+    verbose_name = "Client customer status"
+    help_text = "The customer status corresponding to the Client group"
+
+    @property
+    def default(self):
+        return get_default_client_customer_status()

wbportfolio/contrib/company_portfolio/factories.py

@@ -0,0 +1,32 @@
+import factory
+
+from .models import AssetAllocation, AssetAllocationType, GeographicFocus
+
+
+class AssetAllocationTypeFactory(factory.django.DjangoModelFactory):
+    name = factory.Faker("word")
+    default_max_investment = factory.Faker("pydecimal", min_value=0.0, max_value=1, right_digits=4)
+
+    class Meta:
+        model = AssetAllocationType
+
+
+class AssetAllocationFactory(factory.django.DjangoModelFactory):
+    company = factory.SubFactory("wbcore.contrib.directory.factories.CompanyFactory")
+    asset_type = factory.SubFactory(AssetAllocationTypeFactory)
+    percent = factory.Faker("pydecimal", min_value=0.0, max_value=1, right_digits=4)
+    max_investment = factory.Faker("pydecimal", min_value=0.0, max_value=1, right_digits=4)
+    comment = factory.Faker("sentence")
+
+    class Meta:
+        model = AssetAllocation
+
+
+class GeographicFocusFactory(factory.django.DjangoModelFactory):
+    company = factory.SubFactory("wbcore.contrib.directory.factories.CompanyFactory")
+    country = factory.SubFactory("wbcore.contrib.geography.factories.CountryFactory")
+    percent = factory.Faker("pydecimal", min_value=0.0, max_value=1, right_digits=4)
+    comment = factory.Faker("sentence")
+
+    class Meta:
+        model = GeographicFocus

wbportfolio/contrib/company_portfolio/filters.py

@@ -0,0 +1,127 @@
+from wbcore import filters
+from wbcore.contrib.directory.filters import CompanyFilter as CF
+from wbcore.contrib.directory.filters import PersonFilter as PF
+from wbcore.contrib.directory.models import Company, Person
+
+
+class EntryPortfolioFilter(filters.FilterSet):
+    asset_under_management_gte = filters.NumberFilter(
+        label="AUM",
+        help_text="Filter for the Assets under Management",
+        field_name="asset_under_management",
+        lookup_expr="gte",
+        method="aum_filter_gte",
+    )
+    asset_under_management_lte = filters.NumberFilter(
+        label="AUM",
+        help_text="Filter for the Assets under Management",
+        field_name="asset_under_management",
+        lookup_expr="lte",
+        method="aum_filter_lte",
+    )
+
+    def aum_filter_gte(self, queryset, name, value):
+        if value:
+            if self.view.get_model() is Person:
+                return queryset.filter(employers__portfolio_data__asset_under_management__gte=value)
+            elif self.view.get_model() is Company:
+                return queryset.filter(portfolio_data__asset_under_management__gte=value)
+        return queryset
+
+    def aum_filter_lte(self, queryset, name, value):
+        if value:
+            if self.view.get_model() is Person:
+                return queryset.filter(employers__portfolio_data__asset_under_management__lte=value)
+            elif self.view.get_model() is Company:
+                return queryset.filter(portfolio_data__asset_under_management__lte=value)
+        return queryset
+
+    invested_assets_under_management_usd_gte = filters.NumberFilter(
+        label="Invested AUM",
+        help_text="Filter for the invested Capital (AUM) with us",
+        field_name="invested_assets_under_management_usd",
+        lookup_expr="gte",
+        method="filter_gte",
+    )
+    invested_assets_under_management_usd_lte = filters.NumberFilter(
+        label="Invested AUM",
+        help_text="Filter for the invested Capital (AUM) with us",
+        field_name="invested_assets_under_management_usd",
+        lookup_expr="lte",
+        method="filter_lte",
+    )
+
+    def filter_gte(self, queryset, name, value):
+        if value:
+            if self.view.get_model() is Person:
+                return queryset.filter(employers__portfolio_data__invested_assets_under_management_usd__gte=value)
+            elif self.view.get_model() is Company:
+                return queryset.filter(portfolio_data__invested_assets_under_management_usd__gte=value)
+        return queryset
+
+    def filter_lte(self, queryset, name, value):
+        if value:
+            if self.view.get_model() is Person:
+                return queryset.filter(employers__portfolio_data__invested_assets_under_management_usd__lte=value)
+            elif self.view.get_model() is Company:
+                return queryset.filter(portfolio_data__invested_assets_under_management_usd__lte=value)
+        return queryset
+
+    potential_gte = filters.NumberFilter(
+        label="Potential",
+        help_text="Filter for the potential, e.g. how much potential is there to invest with us",
+        field_name="potential",
+        lookup_expr="gte",
+        method="potential_filter_gte",
+    )
+    potential_lte = filters.NumberFilter(
+        label="Potential",
+        help_text="Filter for the potential, e.g. how much potential is there to invest with us",
+        field_name="potential",
+        lookup_expr="lte",
+        method="potential_filter_lte",
+    )
+
+    def potential_filter_gte(self, queryset, name, value):
+        if value:
+            if self.view.get_model() is Person:
+                return queryset.filter(employers__portfolio_data__potential__gte=value)
+            elif self.view.get_model() is Company:
+                return queryset.filter(portfolio_data__potential__gte=value)
+        return queryset
+
+    def potential_filter_lte(self, queryset, name, value):
+        if value:
+            if self.view.get_model() is Person:
+                return queryset.filter(employers__portfolio_data__potential__lte=value)
+            elif self.view.get_model() is Company:
+                return queryset.filter(portfolio_data__potential__lte=value)
+        return queryset
+
+
+class CompanyFilter(CF, EntryPortfolioFilter):
+    @classmethod
+    def get_filter_class_for_remote_filter(cls):
+        """
+        Define which filterset class sender to user for remote filter registration
+        """
+        return CF
+
+    class Meta(CF.Meta):
+        fields = {
+            **CF.Meta.fields,
+        }
+
+
+class PersonFilter(PF, EntryPortfolioFilter):
+    @classmethod
+    def get_filter_class_for_remote_filter(cls):
+        """
+        Define which filterset class sender to user for remote filter registration
+        """
+        return PF
+
+    class Meta(PF.Meta):
+        fields = {
+            **PF.Meta.fields,
+        }

wbportfolio/contrib/company_portfolio/management.py

@@ -0,0 +1,19 @@
+from django.apps import apps as global_apps
+from django.db import DEFAULT_DB_ALIAS
+from django_celery_beat.models import IntervalSchedule, PeriodicTask
+
+from .constants import DEFAULT_PORTFOLIO_DATA_UPDATE_TASK_INTERVAL_MINUTES
+
+
+def initialize_task(app_config, verbosity=2, interactive=True, using=DEFAULT_DB_ALIAS, apps=global_apps, **kwargs):
+    PeriodicTask.objects.update_or_create(
+        name="Portfolio: Update Company Portfolio Data",
+        defaults={
+            "name": "Portfolio: Update Company Portfolio Data",
+            "interval": IntervalSchedule.objects.get_or_create(
+                every=DEFAULT_PORTFOLIO_DATA_UPDATE_TASK_INTERVAL_MINUTES, period=IntervalSchedule.MINUTES
+            )[0],
+            "task": "wbportfolio.contrib.company_portfolio.tasks.update_all_portfolio_data",
+            "crontab": None,
+        },
+    )

wbportfolio/contrib/company_portfolio/migrations/0001_initial.py

@@ -0,0 +1,214 @@
+# Generated by Django 4.2.9 on 2024-02-15 17:18
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("geography", "0001_initial"),
+        ("currency", "0001_initial"),
+        ("directory", "0006_employeremployeerelationship_position_name"),
+    ]
+
+    operations = [
+        migrations.SeparateDatabaseAndState(
+            state_operations=[
+                migrations.CreateModel(
+                    name="AssetAllocationType",
+                    fields=[
+                        (
+                            "id",
+                            models.BigAutoField(
+                                auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                            ),
+                        ),
+                        ("name", models.CharField(max_length=255)),
+                        (
+                            "default_max_investment",
+                            models.DecimalField(
+                                decimal_places=4,
+                                default=0.1,
+                                help_text="The default percentage this allocation is counted towards the potential.",
+                                max_digits=5,
+                            ),
+                        ),
+                    ],
+                    options={
+                        "verbose_name": "Asset Allocation Type",
+                        "verbose_name_plural": "Asset Allocation Types",
+                    },
+                ),
+                migrations.CreateModel(
+                    name="GeographicFocus",
+                    fields=[
+                        (
+                            "id",
+                            models.BigAutoField(
+                                auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                            ),
+                        ),
+                        ("percent", models.DecimalField(decimal_places=4, max_digits=5)),
+                        ("comment", models.TextField(default="")),
+                        (
+                            "company",
+                            models.ForeignKey(
+                                on_delete=django.db.models.deletion.CASCADE,
+                                related_name="geographic_focuses",
+                                to="directory.company",
+                            ),
+                        ),
+                        (
+                            "country",
+                            models.ForeignKey(
+                                on_delete=django.db.models.deletion.PROTECT,
+                                to="geography.geography",
+                                verbose_name="Location",
+                            ),
+                        ),
+                    ],
+                    options={
+                        "verbose_name": "Geographic Focus",
+                        "verbose_name_plural": "Geographic Focuses",
+                    },
+                ),
+                migrations.CreateModel(
+                    name="CompanyPortfolioData",
+                    fields=[
+                        (
+                            "id",
+                            models.BigAutoField(
+                                auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                            ),
+                        ),
+                        (
+                            "assets_under_management",
+                            models.DecimalField(
+                                blank=True,
+                                decimal_places=2,
+                                help_text="The Assets under Management (AUM) that is managed by this company or this person's primary employer.",
+                                max_digits=17,
+                                null=True,
+                                verbose_name="AUM",
+                            ),
+                        ),
+                        (
+                            "invested_assets_under_management_usd",
+                            models.DecimalField(
+                                blank=True,
+                                decimal_places=2,
+                                help_text="The invested Assets under Management (AUM).",
+                                max_digits=17,
+                                null=True,
+                                verbose_name="Invested AUM ($)",
+                            ),
+                        ),
+                        (
+                            "investment_discretion",
+                            models.CharField(
+                                choices=[
+                                    ("FULLY_DISCRETIONAIRY", "Fully Discretionairy"),
+                                    ("MOSTLY_DISCRETIONAIRY", "Mostly Discretionairy"),
+                                    ("MIXED", "Mixed"),
+                                    ("MOSTLY_ADVISORY", "Mostly Advisory"),
+                                    ("FULLY_ADVISORY", "Fully Advisory"),
+                                ],
+                                default="MIXED",
+                                help_text="What discretion this company or this person's primary employer has to invest its assets.",
+                                max_length=21,
+                                verbose_name="Investment Discretion",
+                            ),
+                        ),
+                        (
+                            "potential",
+                            models.DecimalField(
+                                blank=True,
+                                decimal_places=2,
+                                help_text="\n        The potential reflects how much potential a company (regardless whether client/propective) has. The formula to calculate the potential is:\n\n        AUM * Asset Allocation Percent * Asset Allocation Max Investment - Invested AUM.\n    ",
+                                max_digits=19,
+                                null=True,
+                            ),
+                        ),
+                        (
+                            "assets_under_management_currency",
+                            models.ForeignKey(
+                                blank=True,
+                                null=True,
+                                on_delete=django.db.models.deletion.PROTECT,
+                                to="currency.currency",
+                                verbose_name="AUM Currency",
+                            ),
+                        ),
+                        (
+                            "company",
+                            models.OneToOneField(
+                                on_delete=django.db.models.deletion.CASCADE,
+                                related_name="portfolio_data",
+                                to="directory.company",
+                            ),
+                        ),
+                        (
+                            "potential_currency",
+                            models.ForeignKey(
+                                blank=True,
+                                null=True,
+                                on_delete=django.db.models.deletion.PROTECT,
+                                related_name="wbportfolio_potential_currencies",
+                                to="currency.currency",
+                            ),
+                        ),
+                    ],
+                    options={
+                        "verbose_name": "Company Portfolio Data",
+                        "verbose_name_plural": "Company Portfolio Data",
+                    },
+                ),
+                migrations.CreateModel(
+                    name="AssetAllocation",
+                    fields=[
+                        (
+                            "id",
+                            models.BigAutoField(
+                                auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                            ),
+                        ),
+                        ("percent", models.DecimalField(decimal_places=4, max_digits=5)),
+                        (
+                            "max_investment",
+                            models.DecimalField(
+                                blank=True,
+                                decimal_places=4,
+                                help_text="The percentage this allocation is counted towards the potential. Defaults to the default provided in the asset type.",
+                                max_digits=5,
+                                null=True,
+                            ),
+                        ),
+                        ("comment", models.TextField(default="")),
+                        (
+                            "asset_type",
+                            models.ForeignKey(
+                                on_delete=django.db.models.deletion.PROTECT,
+                                related_name="asset_allocations",
+                                to="company_portfolio.assetallocationtype",
+                            ),
+                        ),
+                        (
+                            "company",
+                            models.ForeignKey(
+                                on_delete=django.db.models.deletion.CASCADE,
+                                related_name="asset_allocations",
+                                to="directory.company",
+                            ),
+                        ),
+                    ],
+                    options={
+                        "verbose_name": "Asset Allocation",
+                        "verbose_name_plural": "Asset Allocations",
+                    },
+                ),
+            ],
+            database_operations=[],
+        ),
+    ]