django-ledger 0.7.10__py3-none-any.whl → 0.8.0__py3-none-any.whl

django_ledger/models/vendor.py

@@ -11,7 +11,8 @@ whether temporarily or indefinitely may be flagged as inactive (i.e. active is F
 as an option in the UI, but can still be used programmatically (via API).
 """
 import os
-from uuid import uuid4
+import warnings
+from uuid import uuid4, UUID
 
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.db import models, transaction, IntegrityError
@@ -19,9 +20,14 @@ from django.db.models import Q, F, QuerySet, Manager
 from django.utils.text import slugify
 from django.utils.translation import gettext_lazy as _
 
+from django_ledger.models.deprecations import deprecated_entity_slug_behavior
 from django_ledger.models.mixins import ContactInfoMixIn, CreateUpdateMixIn, FinancialAccountInfoMixin, TaxInfoMixIn
 from django_ledger.models.utils import lazy_loader
-from django_ledger.settings import DJANGO_LEDGER_DOCUMENT_NUMBER_PADDING, DJANGO_LEDGER_VENDOR_NUMBER_PREFIX
+from django_ledger.settings import (
+    DJANGO_LEDGER_DOCUMENT_NUMBER_PADDING,
+    DJANGO_LEDGER_VENDOR_NUMBER_PREFIX,
+    DJANGO_LEDGER_USE_DEPRECATED_BEHAVIOR
+)
 
 
 def vendor_picture_upload_to(instance, filename):
@@ -42,7 +48,15 @@ class VendorModelQuerySet(QuerySet):
     Custom defined VendorModel QuerySet.
     """
 
-    def active(self) -> QuerySet:
+    def for_user(self, user_model) -> 'VendorModelQuerySet':
+        if user_model.is_superuser:
+            return self
+        return self.filter(
+            Q(entity_model__admin=user_model) |
+            Q(entity_model__managers__in=[user_model])
+        )
+
+    def active(self) -> 'VendorModelQuerySet':
         """
         Active vendors can be assigned to new bills and show on dropdown menus and views.
 
@@ -53,7 +67,7 @@ class VendorModelQuerySet(QuerySet):
         """
         return self.filter(active=True)
 
-    def inactive(self) -> QuerySet:
+    def inactive(self) -> 'VendorModelQuerySet':
         """
         Active vendors can be assigned to new bills and show on dropdown menus and views.
         Marking VendorModels as inactive can help reduce Database load to populate select inputs and also inactivate
@@ -67,7 +81,7 @@ class VendorModelQuerySet(QuerySet):
         """
         return self.filter(active=False)
 
-    def hidden(self) -> QuerySet:
+    def hidden(self) -> 'VendorModelQuerySet':
         """
         Hidden vendors do not show on dropdown menus, but may be used via APIs or any other method that does not
         involve the UI.
@@ -79,7 +93,7 @@ class VendorModelQuerySet(QuerySet):
         """
         return self.filter(hidden=True)
 
-    def visible(self) -> QuerySet:
+    def visible(self) -> 'VendorModelQuerySet':
         """
         Visible vendors show on dropdown menus and views. Visible vendors are active and not hidden.
 
@@ -95,49 +109,67 @@ class VendorModelQuerySet(QuerySet):
 
 class VendorModelManager(Manager):
     """
-    Custom defined VendorModel Manager, which defines many methods for initial query of the Database.
-    """
+    Manages operations related to VendorModel instances.
 
-    def for_user(self, user_model):
-        qs = self.get_queryset()
-        if user_model.is_superuser:
-            return qs
-        return qs.filter(
-            Q(entity_model__admin=user_model) |
-            Q(entity_model__managers__in=[user_model])
-        )
+    A specialized manager for handling interactions with VendorModel entities,
+    providing additional support for filtering based on associated EntityModel or EntityModel slug.
+    """
 
-    def for_entity(self, entity_slug, user_model) -> VendorModelQuerySet:
+    @deprecated_entity_slug_behavior
+    def for_entity(self, entity_model: 'EntityModel | str | UUID' = None, **kwargs) -> VendorModelQuerySet:
         """
-        Fetches a QuerySet of VendorModel associated with a specific EntityModel & UserModel.
-        May pass an instance of EntityModel or a String representing the EntityModel slug.
-
-        Parameters
-        ----------
-        entity_slug: str or EntityModel
-            The entity slug or EntityModel used for filtering the QuerySet.
-        user_model
-            Logged in and authenticated django UserModel instance.
+            Filters the queryset for a given entity model.
+
+            This method modifies the queryset to include only those records
+            associated with the specified entity model. The entity model can
+            be provided in various formats such as an instance of `EntityModel`,
+            a string representing the entity's slug, or its UUID.
+
+            If a deprecated parameter `user_model` is provided, it will issue
+            a warning and may alter the behavior if the deprecated behavior flag
+            `DJANGO_LEDGER_USE_DEPRECATED_BEHAVIOR` is set.
+
+            Parameters
+            ----------
+            entity_model : EntityModel | str | UUID
+                The entity model or its identifier (slug or UUID) to filter the
+                queryset by.
+
+            **kwargs
+                Additional parameters for optional functionality. The parameter
+                `user_model` is supported for backward compatibility but is
+                deprecated and should be avoided.
+
+            Returns
+            -------
+            VendorModelQuerySet
+                A queryset filtered for the given entity model.
+        """
+        EntityModel = lazy_loader.get_entity_model()
 
-        Examples
-        ________
-            >>> request_user = request.user
-            >>> slug = kwargs['entity_slug'] # may come from request kwargs
-            >>> vendor_model_qs = VendorModel.objects.for_entity(user_model=request_user, entity_slug=slug)
+        qs = self.get_queryset()
+        if 'user_model' in kwargs:
+            warnings.warn(
+                'user_model parameter is deprecated and will be removed in a future release. '
+                'Use for_user(user_model).for_entity(entity_model) instead to keep current behavior.',
+                DeprecationWarning,
+                stacklevel=2
+            )
 
-        Returns
-        -------
-        VendorModelQuerySet
-            A filtered VendorModel QuerySet.
-        """
-        qs = self.for_user(user_model)
-        if isinstance(entity_slug, lazy_loader.get_entity_model()):
-            return qs.filter(
-                Q(entity_model=entity_slug)
+            if DJANGO_LEDGER_USE_DEPRECATED_BEHAVIOR:
+                qs = qs.for_user(kwargs['user_model'])
+
+        if isinstance(entity_model, EntityModel):
+            qs = qs.filter(entity_model=entity_model)
+        elif isinstance(entity_model, str):
+            qs = qs.filter(entity_model__slug__exact=entity_model)
+        elif isinstance(entity_model, UUID):
+            qs = qs.filter(entity_model_id=entity_model)
+        else:
+            raise VendorModelValidationError(
+                'EntityModel slug must be either a string or an EntityModel instance'
             )
-        return qs.filter(
-            Q(entity_model__slug__exact=entity_slug)
-        )
+        return qs
 
 
 class VendorModelAbstract(ContactInfoMixIn,

django_ledger/report/core.py

@@ -6,25 +6,16 @@ from django.core.exceptions import ValidationError
 from django_ledger.io.io_context import IODigestContextManager
 from django_ledger.models.ledger import LedgerModel
 from django_ledger.models.unit import EntityUnitModel
-from django_ledger.settings import DJANGO_LEDGER_PDF_SUPPORT_ENABLED
 from django_ledger.templatetags.django_ledger import currency_symbol, currency_format
 
-if DJANGO_LEDGER_PDF_SUPPORT_ENABLED:
-    from fpdf import FPDF, XPos, YPos
+from fpdf import FPDF, XPos, YPos
 
 
 class PDFReportValidationError(ValidationError):
     pass
 
 
-def load_support():
-    support = list()
-    if DJANGO_LEDGER_PDF_SUPPORT_ENABLED:
-        support.append(FPDF)
-    return support
-
-
-class BaseReportSupport(*load_support()):
+class BaseReportSupport(FPDF):
     FOOTER_LOGO_PATH = 'django_ledger/logo/django-ledger-logo-report.png'
 
     def __init__(self,
@@ -33,9 +24,6 @@ class BaseReportSupport(*load_support()):
                  report_subtitle: Optional[str] = None,
                  **kwargs):
 
-        if not DJANGO_LEDGER_PDF_SUPPORT_ENABLED:
-            raise NotImplementedError('PDF support not enabled.')
-
         super().__init__(*args, **kwargs)
         self.REPORT_TYPE: Optional[str] = None
         self.REPORT_SUBTITLE: Optional[str] = report_subtitle

django_ledger/settings.py

@@ -10,49 +10,6 @@ from django.conf import settings
 logger = logging.getLogger('Django Ledger Logger')
 logger.setLevel(logging.INFO)
 
-try:
-    from graphene import __version__
-    from graphene_django import __version__
-    from oauth2_provider import __version__
-
-    DJANGO_LEDGER_GRAPHQL_SUPPORT_ENABLED = True
-except ImportError:
-    DJANGO_LEDGER_GRAPHQL_SUPPORT_ENABLED = False
-
-try:
-    from fpdf import FPDF
-
-    DJANGO_LEDGER_PDF_SUPPORT_ENABLED = True
-except ImportError:
-    DJANGO_LEDGER_PDF_SUPPORT_ENABLED = False
-
-logger.info(f'Django Ledger GraphQL Enabled: {DJANGO_LEDGER_GRAPHQL_SUPPORT_ENABLED}')
-
-
-## MODEL ABSTRACTS ##
-# DJANGO_LEDGER_ACCOUNT_MODEL = getattr(settings, 'DJANGO_LEDGER_ACCOUNT_MODEL', 'django_ledger.AccountModel')
-# DJANGO_LEDGER_CHART_OF_ACCOUNTS_MODEL = getattr(settings, 'DJANGO_LEDGER_ACCOUNT_MODEL', 'django_ledger.ChartOfAccountModel')
-# DJANGO_LEDGER_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_TRANSACTION_MODEL', 'django_ledger.TransactionModel')
-# DJANGO_LEDGER_JOURNAL_ENTRY_MODEL = getattr(settings, 'DJANGO_LEDGER_JOURNAL_ENTRY_MODEL', 'django_ledger.JournalEntryModel')
-# DJANGO_LEDGER_LEDGER_MODEL = getattr(settings, 'DJANGO_LEDGER_LEDGER_MODEL', 'django_ledger.LedgerModel')
-# DJANGO_LEDGER_ENTITY_MODEL = getattr(settings, 'DJANGO_LEDGER_ENTITY_MODEL', 'django_ledger.EntityModel')
-# DJANGO_LEDGER_ENTITY_STATE_MODEL = getattr(settings, 'DJANGO_LEDGER_ENTITY_STATE_MODEL', 'django_ledger.EntityStateModel')
-# DJANGO_LEDGER_ENTITY_UNIT_MODEL = getattr(settings, 'DJANGO_LEDGER_ENTITY_UNIT_MODEL', 'django_ledger.EntityUnitModel')
-# DJANGO_LEDGER_ESTIMATE_MODEL = getattr(settings, 'DJANGO_LEDGER_ESTIMATE_MODEL', 'django_ledger.EstimateModel')
-# DJANGO_LEDGER_BILL_MODEL = getattr(settings, 'DJANGO_LEDGER_BILL_MODEL', 'django_ledger.BillModel')
-# DJANGO_LEDGER_INVOICE_MODEL = getattr(settings, 'DJANGO_LEDGER_INVOICE_MODEL', 'django_ledger.InvoiceModel')
-# DJANGO_LEDGER_PURCHASE_ORDER_MODEL = getattr(settings, 'DJANGO_LEDGER_PURCHASE_ORDER_MODEL', 'django_ledger.PurchaseOrderModel')
-# DJANGO_LEDGER_CUSTOMER_MODEL = getattr(settings, 'DJANGO_LEDGER_CUSTOMER_MODEL', 'django_ledger.CustomerModel')
-# DJANGO_LEDGER_VENDOR_MODEL = getattr(settings, 'DJANGO_LEDGER_VENDOR_MODEL', 'django_ledger.VendorModel')
-# DJANGO_LEDGER_BANK_ACCOUNT_MODEL = getattr(settings, 'DJANGO_LEDGER_BANK_ACCOUNT_MODEL', 'django_ledger.BankAccountModel')
-# DJANGO_LEDGER_CLOSING_ENTRY_MODEL = getattr(settings, 'DJANGO_LEDGER_CLOSING_ENTRY_MODEL', 'django_ledger.ClosingEntryModel')
-# DJANGO_LEDGER_CLOSING_ENTRY_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_CLOSING_ENTRY_TRANSACTION_MODEL', 'django_ledger.ClosingEntryTransactionModel')
-# DJANGO_LEDGER_UNIT_OF_MEASURE_MODEL = getattr(settings, 'DJANGO_LEDGER_UNIT_OF_MEASURE_MODEL', 'django_ledger.UnitOfMeasureModel')
-# DJANGO_LEDGER_ITEM_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_ITEM_TRANSACTION_MODEL', 'django_ledger.ItemTransactionModel')
-# DJANGO_LEDGER_ITEM_MODEL = getattr(settings, 'DJANGO_LEDGER_ITEM_MODEL', 'django_ledger.ItemModel')
-# DJANGO_LEDGER_STAGED_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_STAGED_TRANSACTION_MODEL', 'django_ledger.StagedTransactionModel')
-# DJANGO_LEDGER_IMPORT_JOB_MODEL = getattr(settings, 'DJANGO_LEDGER_IMPORT_JOB_MODEL', 'django_ledger.ImportJobModel')
-
 DJANGO_LEDGER_USE_CLOSING_ENTRIES = getattr(settings, 'DJANGO_LEDGER_USE_CLOSING_ENTRIES', True)
 DJANGO_LEDGER_DEFAULT_CLOSING_ENTRY_CACHE_TIMEOUT = getattr(settings,
                                                             'DJANGO_LEDGER_DEFAULT_CLOSING_ENTRY_CACHE_TIMEOUT', 3600)
@@ -100,65 +57,93 @@ DJANGO_LEDGER_FINANCIAL_ANALYSIS = {
         'current_ratio': {
             'good_incremental': True,
             'ranges': {
-                'healthy': 2,
-                'watch': 1,
-                'warning': .5,
-                'critical': .25
+                'healthy': 2.0,
+                'watch': 1.5,
+                'warning': 1.0,
+                'critical': 0.5,
             }
         },
         'quick_ratio': {
             'good_incremental': True,
             'ranges': {
-                'healthy': 2,
-                'watch': 1,
-                'warning': .5,
-                'critical': .25
+                'healthy': 1.5,
+                'watch': 1.0,
+                'warning': 0.5,
+                'critical': 0.25
             }
         },
         'debt_to_equity': {
             'good_incremental': False,
             'ranges': {
-                'healthy': 0,
-                'watch': .25,
-                'warning': .5,
-                'critical': 1
+                'healthy': 0.5,
+                'watch': 1.0,
+                'warning': 1.5,
+                'critical': 2.0
             }
         },
         'return_on_equity': {
             'good_incremental': True,
             'ranges': {
-                'healthy': .10,
-                'watch': .07,
-                'warning': .04,
-                'critical': .02
+                'healthy': 0.15,
+                'watch': 0.10,
+                'warning': 0.05,
+                'critical': 0.00
             }
         },
         'return_on_assets': {
             'good_incremental': True,
             'ranges': {
-                'healthy': .10,
-                'watch': .06,
-                'warning': .04,
-                'critical': .02
+                'healthy': 0.05,
+                'watch': 0.03,
+                'warning': 0.02,
+                'critical': 0.01
             }
         },
         'net_profit_margin': {
             'good_incremental': True,
             'ranges': {
-                'healthy': .10,
-                'watch': .06,
-                'warning': .04,
-                'critical': .02
+                'healthy': 0.10,
+                'watch': 0.05,
+                'warning': 0.03,
+                'critical': 0.01
             }
         },
         'gross_profit_margin': {
             'good_incremental': True,
             'ranges': {
-                'healthy': .10,
-                'watch': .06,
-                'warning': .04,
-                'critical': .02
+                'healthy': 0.50,
+                'watch': 0.30,
+                'warning': 0.20,
+                'critical': 0.10
             }
         },
     }
 }
+
+DJANGO_LEDGER_USE_DEPRECATED_BEHAVIOR = getattr(settings, 'DJANGO_LEDGER_USE_DEPRECATED_BEHAVIOR', True)
+DJANGO_LEDGER_THEME = getattr(settings, 'DJANGO_LEDGER_THEME', 'litera')
+
+## MODEL ABSTRACTS ##
+
+# DJANGO_LEDGER_ACCOUNT_MODEL = getattr(settings, 'DJANGO_LEDGER_ACCOUNT_MODEL', 'django_ledger.AccountModel')
+# DJANGO_LEDGER_CHART_OF_ACCOUNTS_MODEL = getattr(settings, 'DJANGO_LEDGER_ACCOUNT_MODEL', 'django_ledger.ChartOfAccountModel')
+# DJANGO_LEDGER_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_TRANSACTION_MODEL', 'django_ledger.TransactionModel')
+# DJANGO_LEDGER_JOURNAL_ENTRY_MODEL = getattr(settings, 'DJANGO_LEDGER_JOURNAL_ENTRY_MODEL', 'django_ledger.JournalEntryModel')
+# DJANGO_LEDGER_LEDGER_MODEL = getattr(settings, 'DJANGO_LEDGER_LEDGER_MODEL', 'django_ledger.LedgerModel')
+# DJANGO_LEDGER_ENTITY_MODEL = getattr(settings, 'DJANGO_LEDGER_ENTITY_MODEL', 'django_ledger.EntityModel')
+# DJANGO_LEDGER_ENTITY_STATE_MODEL = getattr(settings, 'DJANGO_LEDGER_ENTITY_STATE_MODEL', 'django_ledger.EntityStateModel')
+# DJANGO_LEDGER_ENTITY_UNIT_MODEL = getattr(settings, 'DJANGO_LEDGER_ENTITY_UNIT_MODEL', 'django_ledger.EntityUnitModel')
+# DJANGO_LEDGER_ESTIMATE_MODEL = getattr(settings, 'DJANGO_LEDGER_ESTIMATE_MODEL', 'django_ledger.EstimateModel')
+# DJANGO_LEDGER_BILL_MODEL = getattr(settings, 'DJANGO_LEDGER_BILL_MODEL', 'django_ledger.BillModel')
+# DJANGO_LEDGER_INVOICE_MODEL = getattr(settings, 'DJANGO_LEDGER_INVOICE_MODEL', 'django_ledger.InvoiceModel')
+# DJANGO_LEDGER_PURCHASE_ORDER_MODEL = getattr(settings, 'DJANGO_LEDGER_PURCHASE_ORDER_MODEL', 'django_ledger.PurchaseOrderModel')
+# DJANGO_LEDGER_CUSTOMER_MODEL = getattr(settings, 'DJANGO_LEDGER_CUSTOMER_MODEL', 'django_ledger.CustomerModel')
+# DJANGO_LEDGER_VENDOR_MODEL = getattr(settings, 'DJANGO_LEDGER_VENDOR_MODEL', 'django_ledger.VendorModel')
+# DJANGO_LEDGER_BANK_ACCOUNT_MODEL = getattr(settings, 'DJANGO_LEDGER_BANK_ACCOUNT_MODEL', 'django_ledger.BankAccountModel')
+# DJANGO_LEDGER_CLOSING_ENTRY_MODEL = getattr(settings, 'DJANGO_LEDGER_CLOSING_ENTRY_MODEL', 'django_ledger.ClosingEntryModel')
+# DJANGO_LEDGER_CLOSING_ENTRY_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_CLOSING_ENTRY_TRANSACTION_MODEL', 'django_ledger.ClosingEntryTransactionModel')
+# DJANGO_LEDGER_UNIT_OF_MEASURE_MODEL = getattr(settings, 'DJANGO_LEDGER_UNIT_OF_MEASURE_MODEL', 'django_ledger.UnitOfMeasureModel')
+# DJANGO_LEDGER_ITEM_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_ITEM_TRANSACTION_MODEL', 'django_ledger.ItemTransactionModel')
+# DJANGO_LEDGER_ITEM_MODEL = getattr(settings, 'DJANGO_LEDGER_ITEM_MODEL', 'django_ledger.ItemModel')
+# DJANGO_LEDGER_STAGED_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_STAGED_TRANSACTION_MODEL', 'django_ledger.StagedTransactionModel')
+# DJANGO_LEDGER_IMPORT_JOB_MODEL = getattr(settings, 'DJANGO_LEDGER_IMPORT_JOB_MODEL', 'django_ledger.ImportJobModel')