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.
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, otherwise Start From Scratch: Add to new Django project to add it to a new django project, or Start From Scratch: Use as standalone Django project.
- Start From Scratch: Add to new Django project
- Add Django Bom To Your App
- Start From Scratch: Use as standalone Django project
- Customize Base Template
- Integrations
- Contributing
- Installation pitfalls
- To start from scratch we recommend setting up a virtual environment
virtualenv -p python3 mysite
cd mysite
source bin/activate
- From here install django, and set up your project.
pip install django
django-admin startproject mysite
cd mysite
python manage.py migrate
python manage.py createsuperuser # make a user for your development environment
- Continue on to Add Django Bom To Your App.
django-bom is a reusable django application. 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. Note that django-bom currently supports python 2.7.
pip install django-bom
Alternatively, to gain access to the new features contained in this fork, use the following install instead
pip install git+https://github.com/williskneeland/django-bom
- 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',
]
- 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
- 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 = {}
-
Run
python manage.py migrate
to create the bom models. -
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). -
Visit http://127.0.0.1:8000/bom/ to begin.
- To start from scratch we recommend setting up a virtual environment
virtualenv -p python3 mysite
cd mysite
source bin/activate
- From here install django, and set up your project.
git clone https://github.com/mpkasp/django-bom.git
pip install -r requirements.txt
python manage.py migrate
cp bom/local_settings.py.example bom/local_settings.py
python manage.py runserver
Each time a user is assigned to a new task in a workflow, they can be notified via email. The email will contain details about the workflow, as well as any previous comments from the last step in the workflow. To get this working, we'll need to configure Django to connect to a SMTP server domain.
- Add the following settings to the end of the settings.py file of your project:
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = ''
EMAIL_PORT = 587 # Default port for most SMTP servers
EMAIL_USE_TLS = True # Mandatory for personal email providers
EMAIL_HOST_USER = ''
EMAIL_HOST_PASSWORD = ''
The EMAIL_HOST
variable refers to the SMTP server domain to use. Three common providers are:
Provider | SMTP Host |
---|---|
Gmail | 'smtp.gmail.com' |
Outlook | 'smtp-mail.outlook.com' |
Yahoo | 'smtp.yahoo.com' |
For this example, we'll be using Gmail (smtp.gmail.com), however the setup should be similar for other providers.
Leave both the EMAIL_HOST_USER
and EMAIL_HOST_PASSWORD
blank for now. We'll use Django Environ to avoid setting these credentials directly in the code.
- Get a Gmail app password
You can do this by going to myaccount.google.com
, navigating to Security, and selecting App passwords. You must also have two-factor authentication set up, since it's required to get an app password. Then click on select app
, choose a custom name for the app password, for example "Django Email", and hit Generate.
- Hiding user and password credentials with Django Environ
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.
For part matching, make sure to add your Mouser api key. You can get your key here.
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.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.
Contributions welcome! Before contributing your work please read the contributing readme.
Also reach out to mike@indabom.com to discuss features, and join our slack channel.
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...
Sometimes you'll have issues installing cryptography, if this is the case you may just need to set up some environment variables. This stackoverflow may help.