Welcome to the Python-to-Operation Toolset (POT) SDK for ARGOS Low-code platform. This doucoment will show you how to develop and release a plugin from your Python solution.
Before your start, let's prepare your POT SDK environment. There are 3 pieces of software you need to install.
- Python interpreter
- The POT SDK
- IDE (PyCharm)
Oh, btw, we are assuming you already have signed up with ARGOS Supervisor account, downloaded the latest version of STU and PAM from the ARGOS LABS website, and installed them successfully.
You will need Python 3.7.3 32bit on Windows 10. Please select the 32bit version even when your OS is 64bit because of compatibility reasons.
ARGOS POT SDK consists of three components as follows:
| Item | Minimum version | Role | Description |
|---|---|---|---|
| alabs.common | 3.721.1350 | SDK library | Library for SDK |
| alabs.icon | 1.711.2351 | icon utility | This utility make plugin icon |
| alabs.ppm | 4.115.1700 | POT utility | POT main utility |
This guide is based on one of the most popular Python IDE
PyCharmCommunity Edition
The step by step guide for how to build ARGOS Low-Code Python plugin.
When starting a new project, you must prepare a base folder from Template everytime. Then, you must set configuration for PyCharm IDE.
You can download the Template folder in which you will find several files including
You must complete the IDE settings after preparation of Template.
This document will show you how to code from the scaffolding template.
You need to change python package name from argoslabs.demo.helloworld to argoslabs.myplugin.asciiart for example.
When your plugin requires installation of any third party modules (dependent modules) from pypi.org. This guild will show you how to do it.
Plugin's main code is made from the source, argoslabs/myplugin/asciiart/__init__.py.
Every code needs to be tested as much as possible. Also, it is required to have a unique name for your package like argoslabs.gourp.plugin_name and for your display name that will appear under STU's Icon. This guild will show you how to test your plugin with unittest and to check for the unique names.
Before building the plugin you have to set tags and version for that plugin.
Each plugin must have a usage help. The README.md contents will be linked the STU's help button. This guide shows how to make this help contents.
Now that everything is ready. Let's build your plugin.
After building your plugin, you can upload it to your own Python private repository. This guide shows how to install private repository and configuration at Supervisor.
You must select a fitting image and make an icon using alabs.icon utility and then you can build this plugin with build.bat batch file.
Once you build your own plugin, it's time to make a bot with STU for testing. And you may need to upgrade the plugin if needed.
Now your plugin is registered at private repository so you can make use of this plugin. This guide shows how to make a bot using your plugin.
Because plugin is a normal software it need to fix or upgrade if needed. This guide shows how to upgrade your plugin.