inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-28 05:36:46 +00:00
Code

Update python.md

Browse Source
This commit is contained in:
Michael 2022-01-27 19:49:23 +01:00 committed by GitHub
parent b4af0702af
commit 1244203981
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/extend/python.md
View File

@ -92,7 +92,7 @@ from inventree.base import Parameter
from inventree.base import ParameterTemplate from inventree.base import ParameterTemplate
## Create a new PartCategory object, ## 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, { furniture = PartCategory.create(api, {
'name': 'Furniture', 'name': 'Furniture',
'description': 'Chairs, tables, etc', 'description': 'Chairs, tables, etc',
@ -109,20 +109,27 @@ couch = Part.create(api, {
'virtual': False, 'virtual': False,
## Note - You do not have to fill out *all* fields ## 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 ```python
## These parameter templates need to be defined only once and can be used for all other parts.
LengthTemplate = ParameterTemplate.create(api, { 'name' : 'Length', 'units' : 'Meters' }) LengthTemplate = ParameterTemplate.create(api, { 'name' : 'Length', 'units' : 'Meters' })
WeightTemplate = ParameterTemplate.create(api, { 'name' : 'Weight', 'units' : 'kg' }) 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 }) ParameterLength = Parameter.create(api, { 'part': couch.pk, 'template': LengthTemplate.pk, 'data' : 2 })
ParameterWeight = Parameter.create(api, { 'part': couch.pk, 'template': WeightTemplate.pk, 'data' : 60 }) 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') couch.upload_image('my_nice_couch.jpg')
``` ```
#### Adding a location to the sofa #### 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. 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.