django-bom 1.193__tar.gz → 1.237__tar.gz

django_bom-1.237/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: django-bom
+Version: 1.237
+Summary: A simple Django app to manage a bill of materials.
+Author-email: Mike Kasparian <mpkasp@gmail.com>
+License: GPL-3.0-only
+Project-URL: Homepage, https://www.indabom.com/
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django<5.3,>=5.2
+Requires-Dist: social-auth-app-django<6,>=5
+Requires-Dist: social-auth-core<6,>=4
+Requires-Dist: google-api-python-client>=2
+Requires-Dist: django-materializecss-form
+Requires-Dist: django-money<5,>=3
+Dynamic: license-file
+
+# BOM
+![](https://github.com/mpkasp/django-bom/workflows/Django%20CI/badge.svg)
+
+BOM is a simple Django app to manage a bill of materials. It supports multiple part numbering schemes, tracking component sourcing information, estimates costs, and contains smart integrations with Mouser to pull in the latest component pricing and Google Drive for part file management. BOM is written in Python 3 and Django 3.
+
+[See a live example](https://www.indabom.com).
+
+BOM can be added to an existing (or new) Django project, or stand alone on its own, which can be more convenient if you're interested in tweaking the tool. 
+
+If you already have a django project, you can skip to [Add Django Bom To Your App](#add-django-bom-to-your-app), otherwise [Start From Scratch: Add to new Django project](#start-from-scratch-add-to-a-new-django-project) to add it to a new django project, or [Start From Scratch: Use as standalone Django project](#start-from-scratch-use-as-a-standalone-django-project).
+
+## Table of contents
+   * [Start From Scratch: Add to new Django project](#start-from-scratch-add-to-a-new-django-project)
+   * [Add Django Bom To Your App](#add-django-bom-to-your-app)
+   * [Start From Scratch: Use as standalone Django project](#start-from-scratch-use-as-a-standalone-django-project)
+   * [Customize Base Template](#customize-base-template)
+   * [Integrations](#integrations)
+   * [Contributing](#contributing)
+   * [Installation pitfalls](#installation-pitfalls)
+   
+## Start From Scratch: Add to a new Django project
+1. To start from scratch, install your pipenv using Python 3.12
+```
+pipenv --python 3.12
+pipenv shell
+```
+
+2. From here install django, and set up your project.
+```
+pipenv install django
+django-admin startproject mysite
+cd mysite
+python manage.py migrate
+python manage.py createsuperuser # make a user for your development environment
+```
+
+3. Continue on to [Add Django Bom To Your App](#add-django-bom-to-your-app).
+
+## Add Django Bom To Your App
+django-bom is a [reusable django application](https://docs.djangoproject.com/en/1.11/intro/reusable-apps/). If you don't already have a django project, you can follow some quick steps below to get up and running, or read about creating your first django app [here](https://docs.djangoproject.com/en/1.11/intro/tutorial01/).
+
+```
+pip install django-bom
+```
+
+1. Add "bom" to your INSTALLED_APPS setting like this::
+
+```
+INSTALLED_APPS = [
+    ...
+    'bom',
+    'social_django', # to enable google drive sync in bom
+    'djmoney', # for currency
+    'djmoney.contrib.exchange', # for currency
+    'materializecssform',
+]
+```
+
+2. Update your URLconf in your project urls.py like this::
+
+```
+path('bom/', include('bom.urls')),
+```
+
+And don't forget to import include:
+
+```
+from django.conf.urls import include
+```
+
+3. Update your settings.py to add the bom context processor `'bom.context_processors.bom_config',` to your TEMPLATES variable, and create a new empty dictionary BOM_CONFIG.
+
+```
+TEMPLATES = [
+    {
+        ...
+        'OPTIONS': {
+            'context_processors': [
+                ...
+                'bom.context_processors.bom_config',
+            ],
+        },
+    },
+]
+```
+
+and
+
+```
+BOM_CONFIG = {'standalone_mode': False}
+```
+
+4. Run `python manage.py migrate` to create the bom models.
+
+5. Start the development server `python manage.py runserver` and visit http://127.0.0.1:8000/admin/
+   to manage the bom (you'll need the Admin app enabled).
+
+6. Visit http://127.0.0.1:8000/bom/ to begin.
+
+   
+## Start From Scratch: Use as a standalone Django project
+1. To start from scratch we recommend setting up a virtual environment
+```
+virtualenv -p python3 mysite
+cd mysite
+source bin/activate
+```
+
+2. From here install django, and set up your project.
+```
+git clone https://github.com/mpkasp/django-bom.git
+pipenv install
+python manage.py migrate
+cp bom/local_settings.py.example bom/local_settings.py
+python manage.py runserver
+```
+
+## Customize Base Template
+The base template can be customized to your pleasing. Just add the following configuration to your settings.py:
+
+```
+BOM_CONFIG = {
+    'base_template': 'base.html',
+}
+```
+
+where `base.html` is your base template.
+
+## Integrations
+### Mouser Integration
+For part matching, make sure to add your Mouser api key. You can get your key [here](https://www.mouser.com/MyMouser/MouserSearchApplication.aspx).
+
+### Google Drive Integration
+Make sure to add the following to your settings.py:
+```
+AUTHENTICATION_BACKENDS = (
+    'social_core.backends.google.GoogleOpenId',
+    'social_core.backends.google.GoogleOAuth2',
+    'social_core.backends.google.GoogleOAuth',
+    'django.contrib.auth.backends.ModelBackend',
+)
+
+SOCIAL_AUTH_GOOGLE_OAUTH2_SCOPE = ['email', 'profile', 'https://www.googleapis.com/auth/drive', 'https://www.googleapis.com/auth/plus.login']
+SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS = {
+    'access_type': 'offline',
+    'approval_prompt': 'auto'
+}
+``` 
+And if you're using https on production add:
+```
+SOCIAL_AUTH_REDIRECT_IS_HTTPS = not DEBUG
+```
+
+### FIXER
+Fixer.io is used to handle exchange rate calculations. This is helpful if you may be purchasing parts from another currency (especially via Mouser) and you still need to estimate your part costs.
+
+To set this up you just need to add your API key to local_settings.py as shown in the example.
+
+To update rates, migrate and run `python manage.py update_rates`. Some day we will need to add a (celerybeat?) task to update rates on a schedule. Explained more [here](https://github.com/django-money/django-money#working-with-exchange-rates).
+
+## Contributing
+
+Contributions welcome! Before contributing your work please read the [contributing readme](https://github.com/mpkasp/django-bom/blob/master/CONTRIBUTING.md).
+
+Also reach out to mike@indabom.com to discuss features, and join our slack channel.
+
+## Installation Pitfalls
+
+### Windows
+#### Sqlite
+You may get an error during your `pip install -r requirements.txt` related to sqlite. This may be fixed by installing Visual C++ for python...
+
+#### Cryptography
+Sometimes you'll have issues installing cryptography, if this is the case you may just need to set up some environment variables. This [stackoverflow](https://stackoverflow.com/questions/46288737/error-while-installing-sqlite-using-pip-on-python-2-7-13) may help.

{django-bom-1.193 → django_bom-1.237}/README.md

@@ -19,16 +19,15 @@ If you already have a django project, you can skip to [Add Django Bom To Your Ap
    * [Installation pitfalls](#installation-pitfalls)
    
 ## Start From Scratch: Add to a new Django project
-1. To start from scratch we recommend setting up a virtual environment
+1. To start from scratch, install your pipenv using Python 3.12
 ```
-virtualenv -p python3 mysite
-cd mysite
-source bin/activate
+pipenv --python 3.12
+pipenv shell
 ```
 
 2. From here install django, and set up your project.
 ```
-pip install django
+pipenv install django
 django-admin startproject mysite
 cd mysite
 python manage.py migrate
@@ -38,7 +37,7 @@ python manage.py createsuperuser # make a user for your development environment
 3. Continue on to [Add Django Bom To Your App](#add-django-bom-to-your-app).
 
 ## Add Django Bom To Your App
-django-bom is a [reusable django application](https://docs.djangoproject.com/en/1.11/intro/reusable-apps/). If you don't already have a django project, you can follow some quick steps below to get up and running, or read about creating your first django app [here](https://docs.djangoproject.com/en/1.11/intro/tutorial01/). Note that django-bom currently supports python 2.7.
+django-bom is a [reusable django application](https://docs.djangoproject.com/en/1.11/intro/reusable-apps/). If you don't already have a django project, you can follow some quick steps below to get up and running, or read about creating your first django app [here](https://docs.djangoproject.com/en/1.11/intro/tutorial01/).
 
 ```
 pip install django-bom
@@ -88,7 +87,7 @@ TEMPLATES = [
 and
 
 ```
-BOM_CONFIG = {}
+BOM_CONFIG = {'standalone_mode': False}
 ```
 
 4. Run `python manage.py migrate` to create the bom models.
@@ -110,7 +109,7 @@ source bin/activate
 2. From here install django, and set up your project.
 ```
 git clone https://github.com/mpkasp/django-bom.git
-pip install -r requirements.txt
+pipenv install
 python manage.py migrate
 cp bom/local_settings.py.example bom/local_settings.py
 python manage.py runserver

{django-bom-1.193 → django_bom-1.237}/bom/admin.py

@@ -1,7 +1,23 @@
 from django.contrib import admin
+from django.contrib.auth import get_user_model
 from django.contrib.auth.admin import UserAdmin
-from .models import *
 
+from .models import (
+    Assembly,
+    Manufacturer,
+    ManufacturerPart,
+    Organization,
+    Part,
+    PartClass,
+    PartRevision,
+    Seller,
+    SellerPart,
+    Subpart,
+    UserMeta,
+)
+
+
+User = get_user_model()
 
 class UserMetaInline(admin.TabularInline):
     model = UserMeta
@@ -36,6 +52,7 @@ class SellerPartAdmin(admin.ModelAdmin):
     list_display = (
         'manufacturer_part',
         'seller',
+        'seller_part_number',
         'minimum_order_quantity',
         'minimum_pack_quantity',
         'unit_cost',
@@ -125,7 +142,11 @@ class AssemblyAdmin(admin.ModelAdmin):
     ]
 
 
-admin.site.unregister(User)
+# Try to unregister User model
+try:
+    admin.site.unregister(User)
+except admin.sites.NotRegistered:
+    pass
 
 admin.site.register(User, UserAdmin)
 admin.site.register(Organization, OrganizationAdmin)

{django-bom-1.193 → django_bom-1.237}/bom/base_classes.py

@@ -11,7 +11,7 @@ class AsDictModel:
 
     def __iter__(self):
         for key in dir(self):
-            if not key.startswith("_"):
+            if not key.startswith("_") and not key == "objects":
                 value = getattr(self, key)
                 if not callable(value):
                     if isinstance(value, (dict, OrderedDict)):

{django-bom-1.193 → django_bom-1.237}/bom/constants.py

@@ -39,6 +39,7 @@ VALUE_UNITS = (
     ('Ohms', '\u03A9'),
     ('mOhms', 'm\u03A9'),
     ('kOhms', 'k\u03A9'),
+    ('MOhms', 'M\u03A9'),
     ('F', 'F'),
     ('pF', 'pF'),
     ('nF', 'nF'),
@@ -52,6 +53,7 @@ VALUE_UNITS = (
     ('C', '\u00B0C'),
     ('F', '\u00B0F'),
     ('H', 'H'),
+    ('nH', 'nH'),
     ('mH', 'mH'),
     ('uH', '\u03BCH'),
     ('Hz', 'Hz'),
@@ -90,6 +92,8 @@ PACKAGE_TYPES = (
     ('QFT', 'QFT'),
     ('PLCC', 'PLCC'),
     ('VGA', 'VGA'),
+    ('BGA', 'BGA'),
+    ('CSP', 'CSP'),
     ('Other', 'Other'),
 )
 

{django-bom-1.193 → django_bom-1.237}/bom/csv_headers.py

@@ -1,4 +1,5 @@
 from abc import ABC
+
 from .utils import get_from_dict
 
 
@@ -143,6 +144,13 @@ class CSVHeaders(ABC):
                         c = evaluate(headers, operand, operator, c, i + 1 == num_asserts)
                         i += 2
 
+    def validate_header_in(self, headers, header):
+        header_synonyms = self.get_synoynms(header)
+        for hs in header_synonyms:
+            if hs in headers:
+                return True
+        raise CSVHeaderError(f'Missing column named {header}')
+
 
 #
 # For each CSV header class, a static data member dictionary uses the key as the default name for the header while the
@@ -164,9 +172,12 @@ class ManufacturerPartCSVHeaders(CSVHeaders):
 class SellerPartCSVHeaders(CSVHeaders):
     all_headers_defns = [
         CSVHeader('seller', name_options=['part_seller', 'part_seller_name', ]),
-        CSVHeader('part_cost', name_options=['seller_part_unit_cost', 'unit_cost', ]),
-        CSVHeader('moq', name_options=['minimum_order_quantity', 'moq', 'part_moq', ]),
-        CSVHeader('nre', name_options=['part_nre', 'part_nre_cost', ]),
+        CSVHeader('seller_part_number', name_options=['seller_pn', 'spn', 'pn', 'part_seller_part_number', 'seller_part_number', ]),
+        CSVHeader('unit_cost', name_options=['seller_part_unit_cost', 'unit_cost', 'part_cost', ]),
+        CSVHeader('minimum_order_quantity', name_options=['minimum_order_quantity', 'moq', 'part_moq', ]),
+        CSVHeader('nre_cost', name_options=['part_nre', 'part_nre_cost', 'nre', 'nre_cost', ]),
+        CSVHeader('minimum_pack_quantity', name_options=['minimum_pack_quantity', 'mpq', 'part_mpq' ]),
+        CSVHeader('lead_time_days', name_options=['lead_time_days', 'lead_time', 'lt']),
     ]
 
 
@@ -223,7 +234,8 @@ class PartsListCSVHeaders(CSVHeaders):
         CSVHeader('manufacturer_part_number', name_options=['mpn', 'mfg_part_number', 'part_manufacturer_part_number', 'mfg part number', 'manufacturer part number']),
         CSVHeader('part_number', name_options=['part number', 'part no', ]),
         CSVHeader('revision', name_options=['rev', 'part_revision', ]),
-    ] + part_attributes
+    ] + part_attributes \
+      + SellerPartCSVHeaders.all_headers_defns
 
 
 class PartsListCSVHeadersSemiIntelligent(PartsListCSVHeaders):
@@ -234,17 +246,19 @@ class PartsListCSVHeadersSemiIntelligent(PartsListCSVHeaders):
         CSVHeader('part_class', name_options=['class', 'part_category']),
         CSVHeader('part_number', name_options=['part number', 'part no', ]),
         CSVHeader('revision', name_options=['rev', 'part_revision', ]),
-    ] + PartsListCSVHeaders.part_attributes
+    ] + PartsListCSVHeaders.part_attributes \
+      + SellerPartCSVHeaders.all_headers_defns
 
 
 class BOMFlatCSVHeaders(CSVHeaders):
     all_headers_defns = [
         CSVHeader('part_number', name_options=['part number', 'part no', ]),
-        CSVHeader('quantity', name_options=['count', 'qty', ]),
+        CSVHeader('quantity', name_options=['count', 'qty', 'quantity', ]),
         CSVHeader('do_not_load', name_options=['dnl', 'dnp', 'do_not_populate', 'do_not_load', 'do not load', 'do not populate', ]),
         CSVHeader('part_class', name_options=['class', 'part_category']),
         CSVHeader('references', name_options=['designator', 'designators', 'reference', ]),
         CSVHeader('synopsis', name_options=['part_synopsis', ]),
+        CSVHeader('description', name_options=['part_description', 'desc', ]),
         CSVHeader('revision', name_options=['rev', 'part_revision', 'rev.']),
     ] + ManufacturerPartCSVHeaders.all_headers_defns \
       + SellerPartCSVHeaders.all_headers_defns + [

django_bom-1.237/bom/decorators.py

@@ -0,0 +1,32 @@
+from django.contrib import messages
+from django.core.exceptions import PermissionDenied
+from django.http import HttpResponseRedirect
+from django.urls import reverse
+
+from social_django.models import UserSocialAuth
+
+
+def google_authenticated(function):
+    def wrap(request, *args, **kwargs):
+        user = request.user
+        try:
+            user.social_auth.get(provider='google-oauth2')
+            return function(request, *args, **kwargs)
+        except UserSocialAuth.DoesNotExist as e:
+            messages.error(request, "You must Sign in with Google to access this feature.")
+            return HttpResponseRedirect(reverse('bom:settings', kwargs={'tab_anchor': 'organization'}))
+
+    wrap.__doc__ = function.__doc__
+    wrap.__name__ = function.__name__
+    return wrap
+
+def organization_admin(function):
+    def wrap(request, *args, **kwargs):
+        if request.user.bom_profile().role != 'A':
+            messages.error(request, "You don't have permission to perform this action.")
+            return HttpResponseRedirect(request.META.get('HTTP_REFERER'), reverse('bom:home'))
+        return function(request, *args, **kwargs)
+
+    wrap.__doc__ = function.__doc__
+    wrap.__name__ = function.__name__
+    return wrap