#36 - deploy on PCs without internet

see issue #36 for details

Author: kensoh

README.md

@@ -2,7 +2,7 @@
 
 # TagUI for Python
 
-[**Use Cases**](#use-cases) | [**API Reference**](#api-reference) | [**About & Credits**](#about--credits) | [**v1.13**](https://github.com/tebelorg/TagUI-Python/releases)
+[**Use Cases**](#use-cases) | [**API Reference**](#api-reference) | [**About & Credits**](#about--credits) | [**v1.14**](https://github.com/tebelorg/TagUI-Python/releases)
 
 ![TagUI for Python demo in Jupyter notebook](https://raw.githubusercontent.com/tebelorg/Tump/master/tagui_python.gif)
 
@@ -16,7 +16,7 @@ To use TagUI for Python in Jupyter notebook, Python script or interactive shell
 import tagui as t
 ```
 
-To deploy in environments without internet access, join the discussion here -
+To deploy in environments without internet access, add your constraints here -
 ```py
 t.init(); t.url('https://github.com/tebelorg/TagUI-Python/issues/36')
 ```
@@ -61,7 +61,7 @@ t.init(visual_automation = True, chrome_browser = False)
 t.keyboard('[cmd][space]')
 t.keyboard('safari[enter]')
 t.keyboard('[cmd]t')
-t.keyboard('avengers[enter]')
+t.keyboard('joker[enter]')
 t.wait(2.5)
 t.snap('page.png', 'results.png')
 t.close()
@@ -96,11 +96,12 @@ Function|Parameters|Purpose
 init()|visual_automation = False, chrome_browser = True|start TagUI, auto-call setup() on first run
 close()||close TagUI, Chrome browser, SikuliX
 setup()||setup TagUI to user home folder
+pack()|(beta feature - [see this issue](https://github.com/tebelorg/TagUI-Python/issues/36))|for deployment without internet
 
 #### DEBUG FUNCTIONS
 Function|Parameters|Purpose
 :-------|:---------|:------
-debug()|True or False|toggle debug mode, eg print and log debug info
+debug()|True or False|toggle debug mode, ie print and log debug info
 send()|tagui_instruction|send TagUI instruction to TagUI for execution
 
 #### BASIC FUNCTIONS
@@ -163,7 +164,7 @@ TagUI is the number #1 open-source RPA software with thousands of active users.
 
 Over the past 2 months I took on a daddy role full-time, taking care of my newborn baby girl and wife. In between nannying and caregiving, I decided to use my time pockets to create a Python package for TagUI. I would like to bring RPA into the heart of machine learning - the Python ecosystem. I hope that TagUI for Python and ML frameworks would be a match made in heaven, and `pip install tagui` would make lives easier for Python users.
 
-Lastly, at only 1k lines of code (excluding comments), it would make my day to see developers of other languages porting this project over to their favourite programming language. It would be an interesting exercise and not too difficult, given the ample comments I sprinkled all over this single-file package (tagui.py), and its intuitive architecture.
+Lastly, at only ~1k lines of code, it would make my day to see developers of other languages porting this project over to their favourite programming language. It would be an interesting exercise and not too difficult, given the ample comments I sprinkled across this [single-file package (tagui.py)](https://github.com/tebelorg/TagUI-Python/blob/master/tagui.py), and its intuitive architecture.
 
 ![TagUI for Python architecture](https://raw.githubusercontent.com/tebelorg/Tump/master/TagUI-Python/architecture.png)
 

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='tagui',
-    version='1.13.0',
+    version='1.14.0',
     py_modules=['tagui'],
     author='Ken Soh',
     author_email='[email protected]',

tagui.py

@@ -2,7 +2,7 @@
 # Apache License 2.0, Copyright 2019 Tebel.Automation Private Limited
 # https://github.com/tebelorg/TagUI-Python/blob/master/LICENSE.txt
 __author__ = 'Ken Soh <[email protected]>'
-__version__ = '1.13.0'
+__version__ = '1.14.0'
 
 import subprocess
 import os
@@ -270,21 +270,37 @@ def setup():
     else:
         print('[TAGUI][ERROR] - unknown ' + platform.system() + ' operating system to setup TagUI')
         return False
+    
+    if not os.path.isfile('tagui_python.zip'):
+        # primary installation pathway by downloading from internet, requiring internet access
+        print('[TAGUI][INFO] - downloading TagUI (~200MB) and unzipping to below folder...')
+        print('[TAGUI][INFO] - ' + home_directory)
+
+        # set tagui zip download url and download zip for respective operating systems
+        tagui_zip_url = 'https://github.com/tebelorg/Tump/releases/download/v1.0.0/' + tagui_zip_file 
+        if not download(tagui_zip_url, home_directory + '/' + tagui_zip_file):
+            # error message is shown by download(), no need for message here 
+            return False
 
-    print('[TAGUI][INFO] - downloading TagUI (~200MB) and unzipping to below folder...')
-    print('[TAGUI][INFO] - ' + home_directory)
+        # unzip downloaded zip file to user home folder
+        unzip(home_directory + '/' + tagui_zip_file, home_directory)
+        if not os.path.isfile(home_directory + '/' + 'tagui' + '/' + 'src' + '/' + 'tagui'):
+            print('[TAGUI][ERROR] - unable to unzip TagUI to ' + home_directory)
+            return False
 
-    # set tagui zip download url and download zip for respective operating systems
-    tagui_zip_url = 'https://github.com/tebelorg/Tump/releases/download/v1.0.0/' + tagui_zip_file 
-    if not download(tagui_zip_url, home_directory + '/' + tagui_zip_file):
-        # error message is shown by download(), no need for message here 
-        return False
+    else:
+        # secondary installation pathway by using the tagui_python.zip generated from pack()
+        print('[TAGUI][INFO] - unzipping TagUI (~200MB) from tagui_python.zip to below folder...')
+        print('[TAGUI][INFO] - ' + home_directory)
 
-    # unzip downloaded zip file to user home folder
-    unzip(home_directory + '/' + tagui_zip_file, home_directory)
-    if not os.path.isfile(home_directory + '/' + 'tagui' + '/' + 'src' + '/' + 'tagui'):
-        print('[TAGUI][ERROR] - unable to unzip TagUI to ' + home_directory)
-        return False
+        import shutil
+        shutil.move('tagui_python.zip', home_directory + '/' + tagui_zip_file)
+
+        if not os.path.isdir(home_directory + '/tagui'): os.mkdir(home_directory + '/tagui')
+        unzip(home_directory + '/' + tagui_zip_file, home_directory + '/tagui')
+        if not os.path.isfile(home_directory + '/' + 'tagui' + '/' + 'src' + '/' + 'tagui'):
+            print('[TAGUI][ERROR] - unable to unzip TagUI to ' + home_directory)
+            return False
 
     # set correct tagui folder for different operating systems
     if platform.system() == 'Windows':
@@ -539,6 +555,39 @@ def init(visual_automation = False, chrome_browser = True):
         _tagui_started = False
         return False
 
+def pack():
+    """function to pack TagUI files for installation on an air-gapped computer without internet"""
+
+    print('[TAGUI][INFO] - detecting and zipping your TagUI installation to tagui_python.zip ...')
+
+    # first make sure TagUI files have been downloaded and synced to latest stable delta files
+    global _tagui_started
+    if _tagui_started:
+        if not close():
+            return False
+    if not init(False, False):
+        return False
+    if not close():
+        return False
+
+    # next download jython to tagui/src/sikulix folder (after init() it can be moved away)
+    if platform.system() == 'Windows':
+        tagui_directory = os.environ['APPDATA'] + '/' + 'tagui'
+    else:
+        tagui_directory = os.path.expanduser('~') + '/' + '.tagui'
+    sikulix_directory = tagui_directory + '/' + 'src' + '/' + 'sikulix'
+    sikulix_jython_url = 'https://github.com/tebelorg/Tump/releases/download/v1.0.0/jython-standalone-2.7.1.jar'
+    if not download(sikulix_jython_url, sikulix_directory + '/' + 'jython-standalone-2.7.1.jar'):
+        return False
+
+    # next zip entire TagUI installation and save a copy of tagui.py to the current folder
+    import shutil
+    shutil.make_archive('tagui_python', 'zip', tagui_directory)
+    shutil.copyfile(os.path.dirname(__file__) + '/tagui.py', 'tagui.py')
+
+    print('[TAGUI][INFO] - done. copy tagui_python.zip and tagui.py to your target computer.')
+    print('[TAGUI][INFO] - then install and use with import tagui as t followed by t.init()')
+
 def _ready():
     """internal function to check if tagui is ready to receive instructions after init() is called"""