inventree-manufacturing-costs 0.1.0__py3-none-any.whl

inventree_manufacturing_costs-0.1.0.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: inventree-manufacturing-costs
+Version: 0.1.0
+Summary: Capture part manufacturing costs
+Home-page: https://github.com/SchrodingersGat/inventree-manufacturing-costs
+Author: Oliver Walters
+Author-email: oliver.henry.walters@gmail.com
+License: MIT
+Keywords: inventree plugin
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: InvenTree
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI](https://img.shields.io/pypi/v/inventree-manufacturing-costs)](https://pypi.org/project/inventree-manufacturing-costs/)
+![PEP](https://github.com/SchrodingersGat/inventree-manufacturing-costs/actions/workflows/ci.yaml/badge.svg)
+
+
+# InvenTree Manufacturing Costs
+
+An [InvenTree](https://inventree.org) plugin for capturing and managing manufacturing costs.
+
+## Description
+
+InvenTree provides tracking of raw material costs via Bills of Materials (BOMs). However, there are a number of additional costs associated with manufacturing a part which are not captured in the BOM structure. This plugin provides a framework for capturing and managing these additional costs, which may include:
+
+- Labor costs
+- Machine costs
+- Overhead costs
+- Processing costs
+- Other miscellaneous costs
+
+These costs are typically not captured in the BOM structure, but are important for accurate cost accounting and pricing.
+
+### Manufacturing Rate
+
+Multiple pre-defined manufacturing rates can be created, which capture the cost per unit time for a given process. For example, a CNC machine may have a cost of $50 per hour, while a manual assembly process may have a labor cost of $20 per hour.
+
+These rates can be stored in the database, and assigned to specific manufacturing cost entries. This is useful for capturing recurring costs associated with time-based processes, and allows for easy updating of rates as costs change over time.
+
+### Manufacturing Cost
+
+A manufacturing cost captures a specific cost associated with the manufacturing of a particular assembly. This may include labor costs, machine costs, overhead costs, or other miscellaneous costs.
+
+Each manufacturing cost may be associated with a specific manufacturing rate, allowing the cost to be calculated based on the rate required for the process. Alternatively, a fixed cost may be specified directly.
+
+## Installation
+
+### Via User Interface
+
+The simplest way to install this plugin is from the InvenTree plugin interface. Enter the plugin name (`inventree-manufacturing-costs`) and click the `Install` button:
+
+![Install Plugin](docs/img/install.png)
+
+### Command Line 
+
+To install manually via the command line, run the following command (ensuring you have access to the appropriate Python environment):
+
+```bash
+pip install -U inventree-manufacturing-costs
+```
+
+*Note: After the plugin is installed, it must be activated via the InvenTree plugin interface.*
+
+## Usage
+
+### Manufacturing Rates
+
+To manage manufacturing rates, navigate to the "Manufacturing Rates" section in the InvenTree admin center. Here, you can create, edit, and delete manufacturing rates as needed:
+
+![Manufacturing Rates](docs/img/manufacturing_rates.png)
+
+### Manufacturing Costs
+
+Manufacturing costs are associated with specified assemblies. To view or edit manufacturing costs for a specific part, navigate to the part detail page and select the "Manufacturing Costs" tab:
+
+![Manufacturing Costs](docs/img/manufacturing_costs.png)
+
+Note that this table only displays the manufacturing costs directly associated with the selected assembly. Costs associated with sub-assemblies are not displayed here - however these costs are included when exporting manufacturing costs (see below).
+
+### Exporting Manufacturing Costs
+
+Manufacturing costs can be exported to a CSV file for further analysis or reporting. To export manufacturing costs, click the "Export" button on the "Manufacturing Costs" tab for the desired assembly.
+
+Exporting manufacturing costs will include all costs associated with the selected assembly, as well as manufacturing costs associated with any sub-assemblies.
+
+This information can be used (in association with BOM cost information) to calculate the total cost of manufacturing a given assembly.
+

inventree_manufacturing_costs-0.1.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+inventree_manufacturing_costs-0.1.0.dist-info/licenses/LICENSE,sha256=4YPRs7DCPobmZTuCAvlCstDV6C-5y2i1h10ZoLJEVIQ,1113
+manufacturing_costs/__init__.py,sha256=AamVBjEe3jzcFGrwK_0mC4sI1NjzOOLvT9k7BvLzj7E,50
+manufacturing_costs/admin.py,sha256=bMGhhEY8hVv3i4uBL2ojxYJ_3zwyj1lvsoIQE2LA6yE,573
+manufacturing_costs/apps.py,sha256=unF9_8OIa3uFSXqg5V0Nvn9np1FRNhJ5YT6D27m3SBA,349
+manufacturing_costs/core.py,sha256=vlNKEQW351o4pRNokAMUi2QL51PyF5bX-1uNmd6ODNQ,3691
+manufacturing_costs/models.py,sha256=mGa2ZMqjb_k5Uzu2DH71fNDUX1CoC9ld-XQKnlBK-yk,4563
+manufacturing_costs/serializers.py,sha256=2YwgJUt-ptw8wkHQekrVqLU5yKz6c-kBj701sqfRfpU,3824
+manufacturing_costs/views.py,sha256=zfuge8Ld6Ao-G9LRf4FbtNu1E3DzuoY19xElRjtK4IE,8049
+manufacturing_costs/migrations/0001_initial.py,sha256=yd-Jqj3I9tyA_2EgDtFwUIXigjasbalMv_VlLDv0G-k,5938
+manufacturing_costs/migrations/0002_remove_manufacturingcost_amortization_and_more.py,sha256=6ussQD7A-ermRPSC_0vhykVJTvPXIx-91GfyMv9vs8Y,1317
+manufacturing_costs/migrations/0003_manufacturingcost_description.py,sha256=IWpOnkF1MFEg1Y-89k0i9risrbkfOyt8padmsqgZek8,612
+manufacturing_costs/migrations/0004_manufacturingcost_active_manufacturingcost_inherited.py,sha256=T9irGk3uyOWK92kBuyzGZ1xg0smiUAa4fNGcZhoPknY,879
+manufacturing_costs/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+manufacturing_costs/static/AdminPanel.js,sha256=ewTLiqoVmV-SHgh6Ik5ldHirgFgVh-kyXEvga89s4Gs,6517
+manufacturing_costs/static/AdminPanel.js.map,sha256=v-no9UGHO4fLsRq7Gx0o2Z4ZspkdFxnKk12c6ylpfMs,10264
+manufacturing_costs/static/PartPanel.js,sha256=7NWGEfo4zIivOGsYq5k8mIVlQWgM7Th0cH-vhE_Ucfs,13452
+manufacturing_costs/static/PartPanel.js.map,sha256=QKi7esyDSTRziwR8YIucVIV5DrjdyvooMOwGQww5WOs,22449
+manufacturing_costs/static/.vite/manifest.json,sha256=sPjDhV7inyCutMv5CdF4L1eJ-aAY9dluFawTqNn_fLs,469
+manufacturing_costs/static/assets/index-BjwOiYns.js,sha256=-kOOgzd0zZYg5BhUnvpmwWr3rsWaT0Jcb2eqqD2v39o,133966
+manufacturing_costs/static/assets/index-BjwOiYns.js.map,sha256=CbVdlj6F8RLHq_BC5pMKsDp-dIL2YKJKdOhklbGNNg4,261945
+inventree_manufacturing_costs-0.1.0.dist-info/METADATA,sha256=6RevFyqJEH1nVAAE9g26Y-GJkzgSJ4Iyaj7CaOEIU0w,4613
+inventree_manufacturing_costs-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+inventree_manufacturing_costs-0.1.0.dist-info/entry_points.txt,sha256=17UEkeIVDI3oA1Z2mCotfEgBkVCmwjCsc5lYja9Wvgc,85
+inventree_manufacturing_costs-0.1.0.dist-info/top_level.txt,sha256=eKb1KtNZpbFJo_iKMuZSjmnfqdSmp0-C3_Iw79RO3NY,20
+inventree_manufacturing_costs-0.1.0.dist-info/RECORD,,

inventree_manufacturing_costs-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

inventree_manufacturing_costs-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[inventree_plugins]
+ManufacturingCosts = manufacturing_costs.core:ManufacturingCosts

inventree_manufacturing_costs-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Oliver Walters <oliver.henry.walters@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

inventree_manufacturing_costs-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+manufacturing_costs

manufacturing_costs/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+PLUGIN_VERSION = "0.1.0"

manufacturing_costs/admin.py

@@ -0,0 +1,23 @@
+"""Admin site configuration for the ManufacturingCosts plugin."""
+
+from django.contrib import admin
+
+from .models import ManufacturingRate, ManufacturingCost
+
+
+@admin.register(ManufacturingRate)
+class ManufacturingRateAdmin(admin.ModelAdmin):
+    """Admin interface for the ManufacturingRate."""
+
+    list_display = ("name", "description", "price")
+
+
+@admin.register(ManufacturingCost)
+class ManufacturingCostAdmin(admin.ModelAdmin):
+    """Admin interface for the ManufacturingCost model."""
+
+    list_display = (
+        "part",
+        "rate",
+        "quantity",
+    )

manufacturing_costs/apps.py

@@ -0,0 +1,13 @@
+"""Django config for the ManufacturingCosts plugin."""
+
+from django.apps import AppConfig
+
+
+class ManufacturingCostsConfig(AppConfig):
+    """Config class for the ManufacturingCosts plugin."""
+
+    name = "manufacturing_costs"
+
+    def ready(self):
+        """This function is called whenever the ManufacturingCosts plugin is loaded."""
+        ...

manufacturing_costs/core.py

@@ -0,0 +1,118 @@
+"""Capture part manufacturing costs"""
+
+from django.contrib.auth.models import Group
+from django.utils.translation import gettext_lazy as _
+
+from plugin import InvenTreePlugin
+
+from plugin.mixins import AppMixin, SettingsMixin, UrlsMixin, UserInterfaceMixin
+
+from . import PLUGIN_VERSION
+
+
+class ManufacturingCosts(
+    AppMixin, SettingsMixin, UrlsMixin, UserInterfaceMixin, InvenTreePlugin
+):
+    """ManufacturingCosts - custom InvenTree plugin."""
+
+    # Plugin metadata
+    TITLE = "Manufacturing Costs"
+    NAME = "ManufacturingCosts"
+    SLUG = "manufacturing-costs"
+    DESCRIPTION = "Capture part manufacturing costs"
+    VERSION = PLUGIN_VERSION
+
+    # Additional project information
+    AUTHOR = "Oliver Walters"
+    WEBSITE = "https://github.com/SchrodingersGat/inventree-manufacturing-costs"
+    LICENSE = "MIT"
+
+    MIN_VERSION = "0.18.0"
+
+    # Plugin settings (from SettingsMixin)
+    SETTINGS = {
+        "USER_GROUP": {
+            "name": _("Allowed Group"),
+            "description": _(
+                "The user group that is allowed to view manufacturing costs"
+            ),
+            "model": "auth.group",
+        }
+    }
+
+    def setup_urls(self):
+        """Configure custom URL endpoints for this plugin."""
+        from .views import construct_urls
+
+        return construct_urls()
+
+    def is_user_allowed(self, request):
+        """Check if the user is allowed to view manufacturing costs."""
+        if user_group_id := self.get_setting("USER_GROUP", backup_value=None):
+            user_group = Group.objects.filter(id=user_group_id).first()
+
+            if user_group is not None and user_group not in request.user.groups.all():
+                return False
+
+        return True
+
+    def get_part_panels(self, part_id: int, request):
+        """Return the custom part panel component for this plugin."""
+
+        from part.models import Part
+
+        if not part_id:
+            return []
+
+        try:
+            instance = Part.objects.get(pk=part_id)
+        except (Part.DoesNotExist, ValueError):
+            return []
+
+        if not instance.assembly:
+            # If the part is not an assembly, do not display the panel
+            return []
+
+        return [
+            {
+                "key": "manufacturing-costs",
+                "title": "Manufacturing Costs",
+                "description": "Part manufacturing costs",
+                "icon": "ti:clock-dollar:outline",
+                "source": self.plugin_static_file("PartPanel.js:renderPartPanel"),
+            }
+        ]
+
+    def get_admin_panels(self, request):
+        """Return the custom admin panel component for this plugin."""
+
+        return [
+            {
+                "key": "manufacturing-costs",
+                "title": "Manufacturing Rates",
+                "description": "Part manufacturing rates",
+                "icon": "ti:clock-dollar:outline",
+                "source": self.plugin_static_file("AdminPanel.js:renderAdminPanel"),
+            }
+        ]
+
+    # Custom UI panels
+    def get_ui_panels(self, request, context: dict, **kwargs):
+        """Return a list of custom panels to be rendered in the InvenTree user interface."""
+
+        # Check if user is allowed to view this plugin
+        if not self.is_user_allowed(request):
+            return []
+
+        target_model = context.get("target_model", None)
+        target_id = context.get("target_id", None)
+
+        if target_model == "admincenter":
+            return self.get_admin_panels(request)
+
+        if target_model == "part":
+            target_id = context.get("target_id", None)
+            return self.get_part_panels(target_id, request)
+
+        # Nothing to do
+        return []

manufacturing_costs/migrations/0001_initial.py

@@ -0,0 +1,163 @@
+# Generated by Django 4.2.22 on 2025-07-09 06:11
+
+import InvenTree.fields
+import django.core.validators
+from django.db import migrations, models
+import django.db.models.deletion
+import djmoney.models.fields
+import djmoney.models.validators
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="ManufacturingRate",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "name",
+                    models.CharField(
+                        help_text="Name of the manufacturing rate",
+                        max_length=100,
+                        unique=True,
+                        verbose_name="Name",
+                    ),
+                ),
+                (
+                    "description",
+                    models.CharField(
+                        help_text="Description of the manufacturing rate",
+                        max_length=200,
+                        verbose_name="Description",
+                    ),
+                ),
+                (
+                    "units",
+                    models.CharField(
+                        blank=True,
+                        help_text="Units for the manufacturing rate",
+                        max_length=50,
+                        verbose_name="Units",
+                    ),
+                ),
+                (
+                    "price_currency",
+                    djmoney.models.fields.CurrencyField(
+                        choices=[], default="", editable=False, max_length=3
+                    ),
+                ),
+                (
+                    "price",
+                    InvenTree.fields.InvenTreeModelMoneyField(
+                        currency_choices=[],
+                        decimal_places=6,
+                        default_currency="",
+                        help_text="Manufacturing rate cost",
+                        max_digits=19,
+                        validators=[djmoney.models.validators.MinMoneyValidator(0)],
+                        verbose_name="Cost",
+                    ),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="ManufacturingCost",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "quantity",
+                    models.DecimalField(
+                        decimal_places=6,
+                        default=1,
+                        help_text="Quantity of the part for which this cost applies",
+                        max_digits=19,
+                        verbose_name="Quantity",
+                    ),
+                ),
+                (
+                    "unit_cost_currency",
+                    djmoney.models.fields.CurrencyField(
+                        choices=[], default="", editable=False, max_length=3, null=True
+                    ),
+                ),
+                (
+                    "unit_cost",
+                    InvenTree.fields.InvenTreeModelMoneyField(
+                        blank=True,
+                        currency_choices=[],
+                        decimal_places=6,
+                        default_currency="",
+                        help_text="Cost of manufacturing this part",
+                        max_digits=19,
+                        null=True,
+                        validators=[djmoney.models.validators.MinMoneyValidator(0)],
+                        verbose_name="Cost",
+                    ),
+                ),
+                (
+                    "notes",
+                    models.CharField(
+                        blank=True,
+                        help_text="Additional notes about this manufacturing cost",
+                        max_length=200,
+                        verbose_name="Notes",
+                    ),
+                ),
+                (
+                    "amortization",
+                    models.PositiveIntegerField(
+                        default=1,
+                        help_text="Part quantity over which the cost is amortized",
+                        validators=[
+                            django.core.validators.MinValueValidator(
+                                1, "Amortization quantity must be at least 1"
+                            )
+                        ],
+                        verbose_name="Amortization Quantity",
+                    ),
+                ),
+                (
+                    "part",
+                    models.ForeignKey(
+                        help_text="The part associated with this manufacturing cost",
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="manufacturing_costs",
+                        to="part.part",
+                        verbose_name="Part",
+                    ),
+                ),
+                (
+                    "rate",
+                    models.ForeignKey(
+                        help_text="The manufacturing rate used for this cost",
+                        null=True,
+                        blank=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="manufacturing_costs",
+                        to="manufacturing_costs.manufacturingrate",
+                        verbose_name="Manufacturing Rate",
+                    ),
+                ),
+            ],
+        ),
+    ]

manufacturing_costs/migrations/0002_remove_manufacturingcost_amortization_and_more.py

@@ -0,0 +1,43 @@
+# Generated by Django 4.2.23 on 2025-09-02 11:14
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("manufacturing_costs", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="manufacturingcost",
+            name="amortization",
+        ),
+        migrations.AddField(
+            model_name="manufacturingcost",
+            name="updated",
+            field=models.DateTimeField(
+                blank=True,
+                default=None,
+                help_text="Timestamp of last update",
+                null=True,
+                verbose_name="Updated",
+            ),
+        ),
+        migrations.AddField(
+            model_name="manufacturingcost",
+            name="updated_by",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="User who last updated this object",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="%(class)s_updated",
+                to=settings.AUTH_USER_MODEL,
+                verbose_name="Update By",
+            ),
+        ),
+    ]

manufacturing_costs/migrations/0003_manufacturingcost_description.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.23 on 2025-09-02 11:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("manufacturing_costs", "0002_remove_manufacturingcost_amortization_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="manufacturingcost",
+            name="description",
+            field=models.CharField(
+                blank=True,
+                help_text="Description of this manufacturing cost",
+                max_length=200,
+                verbose_name="Description",
+            ),
+        ),
+    ]

manufacturing_costs/migrations/0004_manufacturingcost_active_manufacturingcost_inherited.py

@@ -0,0 +1,31 @@
+# Generated by Django 5.2.8 on 2025-11-11 08:43
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("manufacturing_costs", "0003_manufacturingcost_description"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="manufacturingcost",
+            name="active",
+            field=models.BooleanField(
+                default=True,
+                help_text="Is this manufacturing cost active?",
+                verbose_name="Active",
+            ),
+        ),
+        migrations.AddField(
+            model_name="manufacturingcost",
+            name="inherited",
+            field=models.BooleanField(
+                default=False,
+                help_text="Is this manufacturing cost inherited by variant parts?",
+                verbose_name="Inherited",
+            ),
+        ),
+    ]