POT SDK MarkDown Init

sato3238 · Mar 28, 2022 · afa77a2 · afa77a2
1 parent d41c44b
commit afa77a2
Show file tree

Hide file tree

Showing 155 changed files with 1,302 additions and 1,859 deletions.
diff --git a/2019-03-22-plugin-getting-started.md b/2019-03-22-plugin-getting-started.md
diff --git a/ARGOS RPA+ Python Plugin Developers.md b/ARGOS RPA+ Python Plugin Developers.md
diff --git a/ARGOS_RPA_POT_SDK_on_Windows10.md b/ARGOS_RPA_POT_SDK_on_Windows10.md
@@ -0,0 +1,89 @@
+# ARGOS-Labs POT SDK on Windows 10
+
+This guide shows how to develop a plugin using ARGOS POT (`Python-to-Operations Tools`) SDK.
+
+## Prerequisites
+
+You need to install Python Interpreter and IDE
+
+### [Install Python Interpreter](Install_Python_Interpreter_Windows10.md)
+
+You need to install Python 3.7.3 32bit on Windows 10. Once you installed this interpreter it's enough to use this.
+
+### [Install ARGOS POT SDK](Install_ARGOS_POT_SDK_Windows10.md)
+
+ARGOS POT SDK consists of three parts as follows:
+
+| Item | Minimum version | Role | Description |
+|---|---|---|---|
+| [alabs.common](https://pypi-official.argos-labs.com/#/package/alabs-common) | 3.721.1350 | SDK library | Library for SDK |
+| [alabs.icon](https://pypi-official.argos-labs.com/#/package/alabs-icon) | 1.711.2351 | icon utility | This utility make plugin icon |
+| [alabs.ppm](https://pypi-official.argos-labs.com/#/package/alabs-ppm) | 4.115.1700 | POT utility | POT main utility |
+
+
+### [Installation of PyCharm IDE](Install_PyCharm_Windows10.md)
+
+You can install one of Python [IDE](https://en.wikipedia.org/wiki/Integrated_development_environment)
+* `PyCharm` Community Edition
+* `Visual Studio Code` and Python extension
+> We shows `PyCharm` capture examples in this document.
+
+## How to build a ARGOS Low-Code Python Plugin
+
+This guild shows how to build ARGOS Low-Code Python Plugin.
+
+#### [Download template](Download_Template.md)
+
+Everytime before starting you need to prepare base folder from `template` and need to set configuration for `PyCharm` IDE.
+You can download a `Template` folder in which there are several files including 
+
+#### [PyCharm settings](PyCharm_Settings_Windows10.md)
+You need to set settings at the first time of after preparing template.
+
+## Coding for plugin
+Next Guide shows how to code from the scafolding template.
+
+### [Set package name](Set_Package_name_Windows10.md)
+
+You need to change python package name from `argoslabs.demo.helloworld` to `argoslabs.myplugin.asciiart` for example.
+
+### [Install dependent module](Install_Dependent_modules_Windows10.md)
+
+When you make your own plugin you need to install third party dependent modules from [pypi.org](https://pypi.org). This guild shows how to do for this topic.
+
+### [Main Coding at `__init__.py`](Main_Coding_Windows10.md)
+
+Plugin's main code is made from the source, `argoslabs/myplugin/asciiart/__init__.py`.
+
+### [Testing and Unique name](Testing_Windows10.md)
+
+Every code need to be tested as much as possible. And package name like `argoslabs.gourp.plugin_name` and `STU`'s Icon display name must be unique.
+This guild show you how to test plugin with unittest and check to have unique name. 
+
+### [Tags and Version](Setup_yaml.md)
+Before building plugin you have to set tags and version for that plugin.
+
+### [Usage help with README.md]()
+Each plugin must have a usage help so that shows this contents at STU link. This guide shows how to make this help contents.
+
+## Build plugin
+
+Now that everything is ready for build. Let's build.
+
+### [Preparing private repository]()
+
+After build a plugin you need to upload this plugin to your own Python private repository. This guide shows how to install private repository and configuration at Supervisor.
+
+### [Build icon and plugin]()
+Although normal python CLI program do not need 
+
+## After making plugin
+
+Once you build your own plugin it's time to make a bot at `STU` for testing. And you may need to upgrade the plugin if needed.
+
+### [Test a bot at STU]()
+
+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.
+
+### [How to upgrade plugin]()
+Because plugin is a normal software it need to fix or upgrade if needed. This guide shows how to upgrade your plugin.
diff --git a/Captures/01-Install_Python_3.7/01-google-search.png b/Captures/01-Install_Python_3.7/01-google-search.png
diff --git a/Captures/01-Install_Python_3.7/02-Python3.7.3-Page.png b/Captures/01-Install_Python_3.7/02-Python3.7.3-Page.png
diff --git a/Captures/01-Install_Python_3.7/03-download-executable-x86-installable.png b/Captures/01-Install_Python_3.7/03-download-executable-x86-installable.png
diff --git a/Captures/01-Install_Python_3.7/04-install-python.png b/Captures/01-Install_Python_3.7/04-install-python.png
diff --git a/Captures/01-Install_Python_3.7/05-optional-features.png b/Captures/01-Install_Python_3.7/05-optional-features.png
diff --git a/Captures/01-Install_Python_3.7/06-cusmise-install-location.png b/Captures/01-Install_Python_3.7/06-cusmise-install-location.png
diff --git a/Captures/01-Install_Python_3.7/07-setup-succussful.png b/Captures/01-Install_Python_3.7/07-setup-succussful.png
diff --git a/Captures/01-Install_Python_3.7/08-python-version-check.png b/Captures/01-Install_Python_3.7/08-python-version-check.png
diff --git a/Captures/01-Install_Python_3.7/09-building-venv.png b/Captures/01-Install_Python_3.7/09-building-venv.png
diff --git a/Captures/02-install_PyCharm/01-google-search.png b/Captures/02-install_PyCharm/01-google-search.png
diff --git a/Captures/02-install_PyCharm/02-download-CE.png b/Captures/02-install_PyCharm/02-download-CE.png
diff --git a/Captures/02-install_PyCharm/03-execute-install-program.png b/Captures/02-install_PyCharm/03-execute-install-program.png
diff --git a/Captures/02-install_PyCharm/04-start-install-with-default.png b/Captures/02-install_PyCharm/04-start-install-with-default.png
diff --git a/Captures/02-install_PyCharm/05-installing-with-defalt.png b/Captures/02-install_PyCharm/05-installing-with-defalt.png
diff --git a/Captures/02-install_PyCharm/06-finish-installation.png b/Captures/02-install_PyCharm/06-finish-installation.png
diff --git a/Captures/02-install_PyCharm/07-starting-first-accept.png b/Captures/02-install_PyCharm/07-starting-first-accept.png
diff --git a/Captures/02-install_PyCharm/08-select-white-theme.png b/Captures/02-install_PyCharm/08-select-white-theme.png
diff --git a/Captures/02-install_PyCharm/09-open.png b/Captures/02-install_PyCharm/09-open.png
diff --git a/Captures/02-install_PyCharm/10-open-c-work.png b/Captures/02-install_PyCharm/10-open-c-work.png
diff --git a/Captures/03-Make_Plugin_PyCharm/01-download-plugin-template.png b/Captures/03-Make_Plugin_PyCharm/01-download-plugin-template.png
diff --git a/Captures/03-Make_Plugin_PyCharm/02-extract-c-work.png b/Captures/03-Make_Plugin_PyCharm/02-extract-c-work.png
diff --git a/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/03-pycharm-settings.png b/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/03-pycharm-settings.png
diff --git a/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/04-proj-interpreter-py37.png b/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/04-proj-interpreter-py37.png
diff --git a/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/05-add-content-root.png b/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/05-add-content-root.png
diff --git a/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/06-code-styles-80-columns.png b/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/06-code-styles-80-columns.png
diff --git a/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/07-typo-inspection-off.png b/Captures/03-Make_Plugin_PyCharm/02-pycharm-settings/07-typo-inspection-off.png
diff --git a/Captures/03-Make_Plugin_PyCharm/03-naming/01-rename-second-level.png b/Captures/03-Make_Plugin_PyCharm/03-naming/01-rename-second-level.png
diff --git a/Captures/03-Make_Plugin_PyCharm/03-naming/02-rename-demo.png b/Captures/03-Make_Plugin_PyCharm/03-naming/02-rename-demo.png
diff --git a/Captures/03-Make_Plugin_PyCharm/03-naming/03-rename-third.png b/Captures/03-Make_Plugin_PyCharm/03-naming/03-rename-third.png
diff --git a/Captures/03-Make_Plugin_PyCharm/03-naming/04-rename-hello.png b/Captures/03-Make_Plugin_PyCharm/03-naming/04-rename-hello.png
diff --git a/Captures/03-Make_Plugin_PyCharm/03-naming/05-check-changed.png b/Captures/03-Make_Plugin_PyCharm/03-naming/05-check-changed.png
diff --git a/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/01-requirements.png b/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/01-requirements.png
diff --git a/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/02-open-terminal.png b/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/02-open-terminal.png
diff --git a/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/03-pip-install.png b/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/03-pip-install.png
diff --git a/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/figlet-org.png b/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/figlet-org.png
diff --git a/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/pyfiglet.png b/Captures/03-Make_Plugin_PyCharm/04-dependent-modules/pyfiglet.png
diff --git a/Captures/03-Make_Plugin_PyCharm/05-coding/01-ModuleContext.png b/Captures/03-Make_Plugin_PyCharm/05-coding/01-ModuleContext.png
diff --git a/Captures/03-Make_Plugin_PyCharm/05-coding/02-Input-Design.png b/Captures/03-Make_Plugin_PyCharm/05-coding/02-Input-Design.png
diff --git a/Captures/03-Make_Plugin_PyCharm/05-coding/03-Exception-Handling.png b/Captures/03-Make_Plugin_PyCharm/05-coding/03-Exception-Handling.png
diff --git a/Captures/03-Make_Plugin_PyCharm/05-coding/04-STU-FailureCodeAction.png b/Captures/03-Make_Plugin_PyCharm/05-coding/04-STU-FailureCodeAction.png
diff --git a/Captures/03-Make_Plugin_PyCharm/05-coding/05-Stdout.png b/Captures/03-Make_Plugin_PyCharm/05-coding/05-Stdout.png
diff --git a/Captures/03-Make_Plugin_PyCharm/05-coding/06-STU-ReturnValue.png b/Captures/03-Make_Plugin_PyCharm/05-coding/06-STU-ReturnValue.png
diff --git a/Captures/03-Make_Plugin_PyCharm/05-coding/STU-Operation-Groups.png b/Captures/03-Make_Plugin_PyCharm/05-coding/STU-Operation-Groups.png
diff --git a/Captures/03-Make_Plugin_PyCharm/05-coding/STU-Return-Value.png b/Captures/03-Make_Plugin_PyCharm/05-coding/STU-Return-Value.png
diff --git a/Captures/03-Make_Plugin_PyCharm/06-testing/01-unittest-code.png b/Captures/03-Make_Plugin_PyCharm/06-testing/01-unittest-code.png
diff --git a/Captures/03-Make_Plugin_PyCharm/06-testing/02-debug-unittest.png b/Captures/03-Make_Plugin_PyCharm/06-testing/02-debug-unittest.png
diff --git a/Captures/03-Make_Plugin_PyCharm/06-testing/03-check-all-passed.png b/Captures/03-Make_Plugin_PyCharm/06-testing/03-check-all-passed.png
diff --git a/Captures/03-Make_Plugin_PyCharm/06-testing/04-check-unique-name.png b/Captures/03-Make_Plugin_PyCharm/06-testing/04-check-unique-name.png
diff --git a/Captures/03-Make_Plugin_PyCharm/07-setup_yaml/01-setup-yaml.png b/Captures/03-Make_Plugin_PyCharm/07-setup_yaml/01-setup-yaml.png
diff --git a/Captures/03-Make_Plugin_PyCharm/33-make-icon.png b/Captures/03-Make_Plugin_PyCharm/33-make-icon.png
diff --git a/Captures/03-Make_Plugin_PyCharm/34-build/34-build-bat.png b/Captures/03-Make_Plugin_PyCharm/34-build/34-build-bat.png
diff --git a/Captures/03-Make_Plugin_PyCharm/34-build/35-upload-account.png b/Captures/03-Make_Plugin_PyCharm/34-build/35-upload-account.png
diff --git a/Captures/03-Make_Plugin_PyCharm/34-build/36-uploaded-plugin.png b/Captures/03-Make_Plugin_PyCharm/34-build/36-uploaded-plugin.png
diff --git a/Captures/03-Make_Plugin_PyCharm/37-STU-login.png b/Captures/03-Make_Plugin_PyCharm/37-STU-login.png
diff --git a/Captures/03-Make_Plugin_PyCharm/38-private-plugin.png b/Captures/03-Make_Plugin_PyCharm/38-private-plugin.png
diff --git a/Captures/03-Make_Plugin_PyCharm/39-submit.png b/Captures/03-Make_Plugin_PyCharm/39-submit.png
diff --git a/Download_Template.md b/Download_Template.md
@@ -0,0 +1,10 @@
+# Download template
+
+![01-download-plugin-template](Captures/03-Make_Plugin_PyCharm/01-download-plugin-template.png)
+You can download [template zipped file](https://s3-us-west-2.amazonaws.com/rpa-file.argos-labs.com/plugin-template.zip) from our [POT SDK Guide](https://www.argos-labs.com/new-argos-pot-sdk/).
+
+> Saved template filename is `plugin-template.zip`
+
+![02-extract-c-work](Capture/../Captures/03-Make_Plugin_PyCharm/02-extract-c-work.png)
+
+Please extract the downloaded zip file into `C:\work`. So you can see the `C:\work\plugin-template` folder.