pyweclapp - Methods, classes and class builders for interacting with the weclapp api
This Package contains methods to acess weclapp objects via the api.
Setup
Step1
Set up your weclapp domain and provide weclapp API token.
import os
os.environ["weclappApiToken"] = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
os.environ["weclappDomain"] = "yourCompany.weclapp.com
weclapp
Provides basic function for quering the Weclapp API (GET, PUT, POST and DELETE)
You can specify with asType the desired datatype of the response, so that for example the "result" attribte gets removed when asking for e.g. all orders in these functions will throw a specialized weclappError if they fail. PUT function uses the query Parmateter "justUsedProperties" by default to allow for updates with only changes.
weclappClasses
Provides a nested pydantic dataModel for the most used classes with update tracking and metaData handling
To initialise use .fromWeclapp -> e.g. weclappClasses.SalesOrder.fromWeclapp("salesOrderId") to retrieve the dictionary again use .getUpdateDict("used+") with updateType To directly Update use .updateWeclapp(), .updateEntity() functions
Creating Neu class Instances in weclapp
the class also provides you with a template to create an emptyClass. In this case use the fromBlank() classmethod. after that all attributes will be set to None, lists or empyt subclasses, that you can modify or append to. after compleetion call the postNewEntity() method to post it to weclapp. Please do not set "id" or "verion"
Example
salesOrder = weclappClasses.SalesOrder.fromBlank()
salesOrder.customerId = "1234"
salesOrder.invoiceAddress.firstName = "Max"
salesOrder.qmd("1234", addToMetaData=True).booleanValue = True # Adds a custom Attribute
orderItem = weclappClasses.OrderItems.fromBlank()
orderItem.articleId = "1234"
salesOrder.orderItems.append(orderItem)
salesOrder.postNewEntity()
Createing a new class Template
Sometimes you may want to create a new weclappClass that does not exist yet or update an old one.
Setup Example
from pyweclapp.weclappClasses.weclappClassBlueprint import weclappClassCreator
weclappClassCreator.WeclappClassCreator(entityName="ticket",
expamleEntityId="74344116", targetDirectory="util/weclappClasses").createPythonFile()
offers a convenient way to do this. just specify a entityName -> "salesOrder", "shipment", "contract", "article", "etc." expamleEntityId -> to estimate the types targetDirectory -> where the generaed files should be placed entity -> overwirtes the starting dictionary (Optional)
This will create the templates for the weclappclass as well as a init file. if you need supproperties make sure the example entity contains example of this. Oherwhise it will only be an enpty list without model
CATION may overwrite existing files -> choose an empty directory
CustomAttributes
when working with customAttribes a way of nameing them is important. However the ids vary form system to system the CAT classes (CustomATtributes) will generate the a classtemplate like in examples. ater that the attributes will be accessable with their weclappSystemNames with suggesions selectableElements will also be parsed. use bracets in description to choose a different system Name e.g.: "this is a selectable - Option (MySelectableOption)" -> Name will be "MySelectableOption" otherhwise invalid characters will be removed and a "X" will be added if the startincharacter is invalid
CAUTION this may overwrite changes you made in your module.
Setup Example
from pyweclapp.customAttributes import CAT_Generator
# specify your wish directory.
CAT_Generator(entityName="ticket", entityId="74344116",
targetDirectory="util/customAttributes")
if you only need attribtes for specific entity please use the more specific and lightweight subclasses like cat_SalesOrder
weclappDoc
allows you to upload, download or modify documents
it autosets a description (DocDescription class) in json format to make documents identifiable via code.
DocManager(entityName, entityId)
-> get all documents of a entity: .getDocuments()
-> Upload a file -> .uploadFile()
-> download a file -> .getDocumentFiles()
Document
behaives like a weclapp class -> Document.fromWeclapp() Allows to: -> update -> .updateFile() -> download -> .downloadDoc() -> set Description -> .setDescription() -> update Description -> .updateDescription()
Example
docManger = pyweclapp.weclappDoc.DocManager("shipment", "74433425")
availableDocs = docManger.getDocuments()
timeFunctions
higher level functions for working with dates in different formats
optimised for woring with weclapp
create wheel with comand >python3 setup.py bdist_wheel sdist
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyweclapp-0.1.30.tar.gz.
File metadata
- Download URL: pyweclapp-0.1.30.tar.gz
- Upload date:
- Size: 38.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a976f7f813d4b271fce99019af48dca1b7c51dd0fc8847d3d7fcc9b8ccf04222
|
|
| MD5 |
5721577e7aca16bae9302bc07aef241c
|
|
| BLAKE2b-256 |
d56a9dfed1360afc387155bd038d323da63b794185b92ce4554acd0e206bf655
|
File details
Details for the file pyweclapp-0.1.30-py3-none-any.whl.
File metadata
- Download URL: pyweclapp-0.1.30-py3-none-any.whl
- Upload date:
- Size: 48.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
225304e306d1e7eaaa083982e26df58ad150b12153b821a04b469977ffbdc649
|
|
| MD5 |
320b5a71dc60eca17a9454e640020b9e
|
|
| BLAKE2b-256 |
898d03f50189aec623730e1f8503f574d18fbed2891b18314f756923d056d2a8
|
