From 12442039817f6991ef5617fae0cc2ed1ad1c76ca Mon Sep 17 00:00:00 2001 From: Michael Date: Thu, 27 Jan 2022 19:49:23 +0100 Subject: [PATCH] Update python.md --- docs/extend/python.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/extend/python.md b/docs/extend/python.md index e1d357a..51c9949 100644 --- a/docs/extend/python.md +++ b/docs/extend/python.md @@ -92,7 +92,7 @@ from inventree.base import Parameter from inventree.base import ParameterTemplate ## Create a new PartCategory object, -## underneath the existing category with pk 7 +## underneath the existing category with pk 7. Leave the parent empty fpr a top level category furniture = PartCategory.create(api, { 'name': 'Furniture', 'description': 'Chairs, tables, etc', @@ -109,20 +109,27 @@ couch = Part.create(api, { 'virtual': False, ## Note - You do not have to fill out *all* fields }) +``` +#### Adding parameters to the sofa +Each can have multiple parameters like added like resistance, voltage or capacitance. For the sofa length and weight make sense. Each parameter has a parameter template that combines the parameter name with a unit. So we first have to create the parameters: -## Before we can add parameters to the couch, we neeed to create the parameter templates -## These parameter templates need to be defined only once and can be used for all other parts. +```python LengthTemplate = ParameterTemplate.create(api, { 'name' : 'Length', 'units' : 'Meters' }) WeightTemplate = ParameterTemplate.create(api, { 'name' : 'Weight', 'units' : 'kg' }) +``` +These parameter templates need to be defined only once and can be used for all other parts. Now add parameter values to the sofa -## Now we create the parameters +```python ParameterLength = Parameter.create(api, { 'part': couch.pk, 'template': LengthTemplate.pk, 'data' : 2 }) ParameterWeight = Parameter.create(api, { 'part': couch.pk, 'template': WeightTemplate.pk, 'data' : 60 }) +``` +Lets finally add a picture -## Add a picture to the part +```python couch.upload_image('my_nice_couch.jpg') ``` + #### Adding a location to the sofa If we have several sofas on stock we need to know there we have stored them. So let’s add stock locations to the part. Stock locations can be organized in a hierarchical manner e.g. boxes in shelves in aisles in rooms. So each location can have a parent. Let’s assume we have 10 sofas in box 12 and 3 sofas in box 13 located in shelve 43 aisle 3. First we have to create the locations, afterwards we can put the sofas inside.