django-bom 1.262__py3-none-any.whl

bom/part_bom.py

@@ -0,0 +1,192 @@
+import logging
+from collections import OrderedDict
+
+from djmoney.money import Money
+
+from .base_classes import AsDictModel
+
+
+logger = logging.getLogger(__name__)
+
+
+class PartBom(AsDictModel):
+    def __init__(self, part_revision, quantity, unit_cost=None, missing_item_costs=0, nre_cost=None, out_of_pocket_cost=None):
+        self.part_revision = part_revision
+        self.parts = OrderedDict()
+        self.quantity = quantity
+        self._currency = self.part_revision.part.organization.currency
+        if unit_cost is None:
+            unit_cost = Money(0, self._currency)
+        if nre_cost is None:
+            nre_cost = Money(0, self._currency)
+        if out_of_pocket_cost is None:
+            out_of_pocket_cost = Money(0, self._currency)
+
+        self.unit_cost = unit_cost
+        self.missing_item_costs = missing_item_costs  # count of items that have no cost
+        self.nre_cost = nre_cost
+        self.out_of_pocket_cost = out_of_pocket_cost  # cost of buying self.quantity with MOQs
+
+    def cost(self):
+        return self.unit_cost * self.quantity
+
+    def total_out_of_pocket_cost(self):
+        return self.out_of_pocket_cost + self.nre_cost
+
+    def append_item_and_update(self, item):
+        if item.bom_id in self.parts:
+            self.parts[item.bom_id].extended_quantity += item.extended_quantity
+            ref = ', ' + item.references
+            self.parts[item.bom_id].references += ref
+        else:
+            self.parts[item.bom_id] = item
+
+            item.total_extended_quantity = int(self.quantity) * item.extended_quantity
+            self.update_bom_for_part(item)
+
+    def update_bom_for_part(self, bom_part):
+        if bom_part.do_not_load:
+            bom_part.order_quantity = 0
+            bom_part.order_cost = 0
+            return
+
+        if bom_part.seller_part:
+            try:
+                bom_part.order_quantity = bom_part.seller_part.order_quantity(bom_part.total_extended_quantity)
+                bom_part.order_cost = bom_part.total_extended_quantity * bom_part.seller_part.unit_cost
+            except AttributeError:
+                pass
+            self.unit_cost = (self.unit_cost + bom_part.seller_part.unit_cost * bom_part.extended_quantity) if bom_part.seller_part.unit_cost is not None else self.unit_cost
+            self.out_of_pocket_cost = self.out_of_pocket_cost + bom_part.out_of_pocket_cost()
+            self.nre_cost = (self.nre_cost + bom_part.seller_part.nre_cost) if bom_part.seller_part.nre_cost is not None else self.nre_cost
+        else:
+            self.missing_item_costs += 1
+
+    def update(self):
+        self.missing_item_costs = 0
+        self.unit_cost = Money(0, self._currency)
+        self.out_of_pocket_cost = Money(0, self._currency)
+        self.nre_cost = Money(0, self._currency)
+        for _, bom_part in self.parts.items():
+            self.update_bom_for_part(bom_part)
+
+    def mouser_parts(self):
+        mouser_items = {}
+        for bom_id, item in self.parts.items():
+            if item.part.id not in mouser_items and item.part.number_class.mouser_enabled:
+                for manufacturer_part in item.part.manufacturer_parts():
+                    mouser_items.update({bom_id: manufacturer_part})
+                    if not manufacturer_part.mouser_disable:
+                        mouser_items.update({bom_id: manufacturer_part})
+        return mouser_items
+
+    def manufacturer_parts(self, source_mouser=False):
+        # TODO: optimize this query to not hit the DB in a for loop
+        if source_mouser:
+            mps = []
+            for item in self.parts:
+                if item.part.manufacturer_part.source_mouser:
+                    mps.append(item.part.manufacturer_part)
+            return mps
+        return [item.part.manufacturer_part for item in self.parts]
+
+    def as_dict(self, include_id=False):
+        d = super().as_dict()
+        d['unit_cost'] = self.unit_cost.amount
+        d['nre'] = self.nre_cost.amount
+        d['out_of_pocket_cost'] = self.out_of_pocket_cost.amount
+        return d
+
+
+class PartBomItem(AsDictModel):
+    def __init__(self, bom_id, part, part_revision, do_not_load, references, quantity, extended_quantity, seller_part=None):
+        # top_level_quantity is the highest quantity, typically a order quantity for the highest assembly level in a BOM
+        # A bom item should not care about its parent quantity
+        self.bom_id = bom_id
+        self.part = part
+        self.part_revision = part_revision
+        self.do_not_load = do_not_load
+        self.references = references
+
+        self.quantity = quantity  # quantity is the quantity per each direct parent assembly
+        self.extended_quantity = extended_quantity  # extended_quantity, is the item quantity used in the top level assembly (e.g. assuming PartBom.quantity = 1)
+        self.total_extended_quantity = None  # extended_quantity * top_level_quantity (PartBom.quantity) - Set when appending to PartBom
+        self.order_quantity = None  # order quantity taking into MOQ/MPQ constraints - Set when appending to PartBom
+
+        self._currency = self.part.organization.currency
+
+        self.order_cost = Money(0, self._currency)  # order_cost is updated similar to above order_quantity - Set when appending to PartBom
+        self.seller_part = seller_part
+
+        self.api_info = None
+
+    def extended_cost(self):
+        try:
+            return self.extended_quantity * self.seller_part.unit_cost
+        except (AttributeError, TypeError) as err:
+            logger.log(logging.INFO, '[part_bom.py] ' + str(err))
+            return Money(0, self._currency)
+
+    def out_of_pocket_cost(self):
+        try:
+            return self.order_quantity * self.seller_part.unit_cost
+        except (AttributeError, TypeError) as err:
+            logger.log(logging.INFO, '[part_bom.py] ' + str(err))
+            return Money(0, self._currency)
+
+    def as_dict(self, include_id=False):
+        dict = super().as_dict()
+        del dict['bom_id']
+        return dict
+
+    def as_dict_for_export(self):
+        return {
+            'part_number': self.part.full_part_number(),
+            'quantity': self.quantity,
+            'do_not_load': self.do_not_load,
+            'part_class': self.part.number_class.name if self.part.number_class else '',
+            'references': self.references,
+            'part_synopsis': self.part_revision.synopsis(),
+            'part_description': self.part_revision.description,
+            'part_revision': self.part_revision.revision,
+            'part_manufacturer': self.part.primary_manufacturer_part.manufacturer.name if self.part.primary_manufacturer_part is not None and self.part.primary_manufacturer_part.manufacturer is not None else '',
+            'part_manufacturer_part_number': self.part.primary_manufacturer_part.manufacturer_part_number if self.part.primary_manufacturer_part is not None else '',
+            'part_ext_qty': self.extended_quantity,
+            'part_order_qty': self.order_quantity,
+            'part_seller': self.seller_part.seller.name if self.seller_part is not None else '',
+            'part_seller_part_number': self.seller_part.seller_part_number if self.seller_part is not None else '',
+            'part_cost': self.seller_part.unit_cost if self.seller_part is not None else '',
+            'part_moq': self.seller_part.minimum_order_quantity if self.seller_part is not None else 0,
+            'part_nre': self.seller_part.nre_cost if self.seller_part is not None else 0,
+            'part_ext_cost': self.extended_cost(),
+            'part_out_of_pocket_cost': self.out_of_pocket_cost(),
+            'part_lead_time_days': self.seller_part.lead_time_days if self.seller_part is not None else 0,
+        }
+
+    def manufacturer_parts_for_export(self):
+        return [mp.as_dict_for_export() for mp in self.part.manufacturer_parts(exclude_primary=True)]
+
+    def seller_parts_for_export(self):
+        return [sp.as_dict_for_export() for sp in self.part.seller_parts(exclude_primary=True)]
+
+    def __str__(self):
+        return f'{self.part.full_part_number()}, qty: {self.quantity}'
+
+
+class PartIndentedBomItem(PartBomItem, AsDictModel):
+    def __init__(self, indent_level, parent_id, subpart, parent_quantity, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.indent_level = indent_level
+        self.parent_id = parent_id
+        self.subpart = subpart
+        self.parent_quantity = parent_quantity
+
+    def as_dict_for_export(self):
+        dict = super().as_dict_for_export()
+        dict.update({
+            'level': self.indent_level,
+        })
+        return dict
+
+    def __str__(self):
+        return f'level: {self.indent_level}, {super().__str__()}'

bom/settings.py

@@ -0,0 +1,262 @@
+import logging
+import os
+from pathlib import Path
+
+from django.utils.log import DEFAULT_LOGGING
+
+logger = logging.getLogger(__name__)
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+try:
+    from .local_settings import *
+except ImportError:
+    logger.warning("local_settings.py not found. Using default settings.")
+    pass
+
+BOM_CONFIG = {}
+BOM_CONFIG_DEFAULT = {
+    'base_template': 'base.html',
+    'mouser_api_key': None,
+    'standalone_mode': True,
+    'admin_dashboard': {
+        'enable_autocomplete': True,
+        'page_size': 50,
+    }
+}
+BOM_ORGANIZATION_MODEL = 'bom.Organization'
+BOM_USER_META_MODEL = 'bom.UserMeta'
+
+# Apply custom settings over defaults
+bom_config_new = BOM_CONFIG_DEFAULT.copy()
+bom_config_new.update(BOM_CONFIG)
+BOM_CONFIG = bom_config_new
+
+
+# --------------------------------------------------------------------------
+# APPLICATION DEFINITION
+# --------------------------------------------------------------------------
+
+INSTALLED_APPS = [
+    # Custom Apps first
+    'bom.apps.BomConfig',
+
+    # Django contrib apps
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+
+    # Third-party apps
+    'materializecssform',
+    'social_django',
+    'djmoney',
+    'djmoney.contrib.exchange',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'social_django.middleware.SocialAuthExceptionMiddleware',
+]
+
+ROOT_URLCONF = 'bom.urls'
+WSGI_APPLICATION = 'bom.wsgi.application'
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+
+
+# --------------------------------------------------------------------------
+# TEMPLATES
+# --------------------------------------------------------------------------
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        # Use pathlib syntax for cleaner path joining
+        'DIRS': [BASE_DIR / 'bom' / 'templates' / 'bom'],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+                'django.template.context_processors.media',
+                'social_django.context_processors.backends',
+                'social_django.context_processors.login_redirect',
+                'bom.context_processors.bom_config',
+            ],
+        },
+    },
+]
+
+
+# --------------------------------------------------------------------------
+# AUTHENTICATION & SECURITY
+# --------------------------------------------------------------------------
+
+AUTHENTICATION_BACKENDS = (
+    'social_core.backends.google.GoogleOAuth2',
+    'django.contrib.auth.backends.ModelBackend',
+)
+
+# Password validation - kept as is
+
+AUTH_PASSWORD_VALIDATORS = [
+    {'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',},
+    {'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',},
+    {'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',},
+    {'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',},
+]
+
+# Social Auth Settings - kept as is
+SOCIAL_AUTH_GOOGLE_OAUTH2_SCOPE = ['email', 'profile', 'https://www.googleapis.com/auth/drive', ]
+SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS = {
+    'access_type': 'offline',
+    'approval_prompt': 'force'
+}
+
+SOCIAL_AUTH_PIPELINE = (
+    'social_core.pipeline.social_auth.social_details',
+    'social_core.pipeline.social_auth.social_uid',
+    'social_core.pipeline.social_auth.social_user',
+    'social_core.pipeline.user.get_username',
+    'social_core.pipeline.social_auth.associate_by_email',
+    'social_core.pipeline.user.create_user',
+    'social_core.pipeline.social_auth.associate_user',
+    'social_core.pipeline.social_auth.load_extra_data',
+    'social_core.pipeline.user.user_details',
+    'bom.third_party_apis.google_drive.initialize_parent',
+)
+
+SOCIAL_AUTH_DISCONNECT_PIPELINE = (
+    'social_core.pipeline.disconnect.allowed_to_disconnect',
+    'bom.third_party_apis.google_drive.uninitialize_parent',
+    'social_core.pipeline.disconnect.get_entries',
+    'social_core.pipeline.disconnect.revoke_tokens',
+    'social_core.pipeline.disconnect.disconnect',
+)
+
+
+# --------------------------------------------------------------------------
+# I18N & TIME
+# --------------------------------------------------------------------------
+
+LANGUAGE_CODE = 'en-us'
+TIME_ZONE = 'UTC'
+USE_I18N = True
+USE_L10N = True # Deprecated in Django 4.0, but harmless for now
+USE_TZ = True
+
+
+# --------------------------------------------------------------------------
+# FILE STORAGE (Static and Media)
+# --------------------------------------------------------------------------
+
+STATIC_URL = '/static/'
+STATIC_ROOT = BASE_DIR / 'static'
+
+MEDIA_URL = '/media/'
+MEDIA_ROOT = BASE_DIR / 'media'
+
+# Use the Django 4.2+ STORAGES setting
+STORAGES = {
+    # Default is FileSystemStorage, configured by STATIC_ROOT/MEDIA_ROOT
+    "default": {
+        "BACKEND": "django.core.files.storage.FileSystemStorage",
+    },
+    "staticfiles": {
+        "BACKEND": "django.contrib.staticfiles.storage.StaticFilesStorage",
+    },
+}
+
+
+# --------------------------------------------------------------------------
+# URLS & REDIRECTS
+# --------------------------------------------------------------------------
+
+LOGIN_URL = '/login/'
+LOGOUT_URL = '/logout/'
+
+LOGIN_REDIRECT_URL = '/'
+LOGOUT_REDIRECT_URL = '/'
+
+SOCIAL_AUTH_LOGIN_REDIRECT_URL = '/settings?tab_anchor=file'
+SOCIAL_AUTH_DISCONNECT_REDIRECT_URL = '/settings?tab_anchor=file'
+SOCIAL_AUTH_LOGIN_ERROR_URL = '/'
+
+# Custom login url for BOM_LOGIN (kept for compatibility)
+BOM_LOGIN_URL = None
+
+
+# --------------------------------------------------------------------------
+# DJMONEY CONFIG
+# --------------------------------------------------------------------------
+
+CURRENCY_DECIMAL_PLACES = 4
+EXCHANGE_BACKEND = 'djmoney.contrib.exchange.backends.FixerBackend'
+
+
+# --------------------------------------------------------------------------
+# LOGGING
+# --------------------------------------------------------------------------
+
+# Set DEBUG to False here if not defined in local_settings
+DEBUG = locals().get('DEBUG', False)
+LOG_FILE_PATH = '/var/log/indabom/django.log' if not DEBUG else BASE_DIR / 'bom.log'
+
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'handlers': {
+        'mail_admins': {
+            'class': 'django.utils.log.AdminEmailHandler',
+            'level': 'ERROR',
+            'include_html': True,
+        },
+        'logfile': {
+            'class': 'logging.handlers.WatchedFileHandler',
+            'filename': LOG_FILE_PATH,
+            'formatter': 'timestamp', # Define a simple formatter
+        },
+        'console': {
+            'class': 'logging.StreamHandler',
+            'formatter': 'timestamp',
+        },
+    },
+    'formatters': {
+        'timestamp': {
+            'format': "[%(asctime)s] %(levelname)s [%(name)s.%(funcName)s:%(lineno)d] %(message)s"
+        },
+    },
+    'loggers': {
+        # Catchall logger
+        '': {
+            'handlers': ['console', 'logfile'],
+            'level': 'INFO',
+        },
+        # Django logging
+        'django': {
+            'handlers': ['logfile'],
+            'level': 'ERROR',
+            'propagate': False,
+        },
+        'django.request': {
+            'handlers': ['mail_admins', 'logfile'],
+            'level': 'ERROR',
+            'propagate': False,
+        },
+        # django-bom app
+        'bom': {
+            'handlers': ['logfile', 'console'],
+            'level': 'INFO',
+            'propagate': False
+        },
+    },
+}

bom/static/bom/css/dashboard.css

@@ -0,0 +1,17 @@
+@media print {
+    #searchForm {
+        display: none;
+    }
+
+    .actions-row {
+        display: none;
+    }
+
+    .fixed-action-btn {
+        display: none;
+    }
+
+    .responsive-table-wrapper {
+        overflow-x: visible !important;
+    }
+}

bom/static/bom/css/jquery.treetable.css

@@ -0,0 +1,28 @@
+table.treetable span.indenter {
+  display: inline-block;
+  margin: 0;
+  padding: 0;
+  text-align: right;
+
+  /* Disable text selection of nodes (for better D&D UX) */
+  user-select: none;
+  -khtml-user-select: none;
+  -moz-user-select: none;
+  -o-user-select: none;
+  -webkit-user-select: none;
+
+  /* Force content-box box model for indenter (Bootstrap compatibility) */
+  -webkit-box-sizing: content-box;
+  -moz-box-sizing: content-box;
+  box-sizing: content-box;
+
+  width: 19px;
+}
+
+table.treetable span.indenter a {
+  background-position: left center;
+  background-repeat: no-repeat;
+  display: inline-block;
+  text-decoration: none;
+  width: 19px;
+}