Python SDK Template
The Python template generates a python module based on the module name and exposes clean interfaces based on the module interface inside an API module. A core API which contain the single source of truth and a module code which is created as scaffolding code. For each interface a test file is also created.
The Python module allows to be extended and implemented based on the API core and inside the scaffolding files.
Following template feature switches are supported:
- API - Only creates the interface files for you
- Scaffold - Creates a full project with reference implementation and build system support.
In the generated source code you will find a
README which explain in great detail how to build and use the code.
An interface like this counter will be directly transformed to an abstract class.
- name: Counter
- name: count
- name: increment
The class will then later be used to be implemented by the customer.
A data structure like this message which contains one field, called text is transformed into a class with public fields.
- name: Message
- name: text
A data structure is transformed to a python class. As these API structs shall be able to be used outside of the module the fields are public.
self.text : str = str()
A enumeration will be transformed to a set of constants.
- name: Direction
- name: Up
- name: Down
- name: Left
- name: Right
This is transformed to
from enum import Enum
Up = 0
Down = 1
Left = 2
Right = 3