Setting up python for CS CLI

NarendraRama · NarendraRama · commit 5ff4511d144b · 2021-06-28T13:09:32.000+05:30
Added content related to setting up python for CS CLI
diff --git a/cloudslang/Makefile b/cloudslang/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/cloudslang/cloudslang_content.rst b/cloudslang/cloudslang_content.rst
@@ -41,13 +41,13 @@ Running Content Dependent on Java Actions
 
 Some of the content is dependent on Java actions from the cs-actions repository.
 CloudSlang uses Maven to manage these dependencies. When executing an operation
-that declares a dependency, the required Maven project and all the resources 
+that declares a dependency, the required Maven project and all the resources
 specified in its pom's ``dependencies`` will be resolved and downloaded (if
 necessary).
 
 .. note::
 
-    Maven version used in the CLI, Builder and cs-actions is ``3.3.9`` with JRE version ``8u282-8.52.0.23``
+    Maven version used in the CLI, Builder and cs-actions is ``3.3.9`` with JRE version ``8u282-8.52.0.23``.
     There might be some issues while building the Java Actions with
     other versions.
 
diff --git a/cloudslang/cloudslang_dsl_reference.rst b/cloudslang/cloudslang_dsl_reference.rst
@@ -1845,6 +1845,32 @@ cannot be named ``on_failure``.
    are evaluated are ``SUCCESS`` and ``FAILURE``. Any other results will be
    evaluated as ``SUCCESS``.
 
+run_id
+------
+
+The ``run_id`` returns the run ID of the current execution.
+
+**Example - assign a flow with run_id parameter**
+
+.. code-block:: yaml
+
+   - namespace: run_id
+       flow:
+       name: run_id_usage
+       workflow:
+      - add_numbers:
+          do:
+            io.cloudslang.base.math.add_numbers:
+             - value1: 'integer1'
+             - value2: 'integer2'
+             - run_id: '${run_id}'
+           navigate:
+             - SUCCESS: SUCCESS
+             - FAILURE: on_failure
+           results:
+             - FAILURE
+             - SUCCESS
+
 Flow Results
 ~~~~~~~~~~~~
 
@@ -1994,10 +2020,10 @@ modules:
 Installing Packages into the python-lib Folder
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Prerequisites:  Python 2.7 and pip.
+Prerequisites:  Python 3.8.7 and pip.
 
-You can download Python (version 2.7) from `here <https://www.python.org/>`__.
-Python 2.7.9 and later include pip by default. If you already have Python but
+You can download Python (version 3.8.7) from `here <https://www.python.org/>`__.
+that includes pip by default. If you already have Python but
 don't have pip, see the pip
 `documentation <https://pip.pypa.io/en/latest/installing.html>`__ for
 installation instructions.
@@ -2434,6 +2460,19 @@ value associated with ``expression2``.
       outputs:
         - out1
 
+.. _regex:
+
+cs_regex(selection, regex, split_lines)
+---------------------------------------
+
+May appear in the value of an `input <#inputs>`__ and `expression <#expressions>`__.
+
+**Example - usage of ``regex`` function in inputs**
+
+.. code-block:: Python
+
+
+
 .. _get:
 
 get()
diff --git a/cloudslang/conf.py b/cloudslang/conf.py
@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'cloudslang_doc'
+copyright = '2021, Narendra'
+author = 'Narendra'
+
+# The full version, including alpha/beta/rc tags
+release = '2.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
diff --git a/cloudslang/index.rst b/cloudslang/index.rst
@@ -0,0 +1,20 @@
+.. cloudslang_doc documentation master file, created by
+   sphinx-quickstart on Mon Jun 14 19:35:22 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to cloudslang_doc's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/cloudslang/make.bat b/cloudslang/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/overview/get_started.rst b/overview/get_started.rst
@@ -20,6 +20,39 @@ Download, Unzip and Run
 -  The CLI will run the ready-made ``print_text`` operation that will
    print the value passed to the variable ``text`` to the screen.
 
+Set up python for CloudSlang cli
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To use an external python in cloudslang-cli, set the ``use.jython.expressions``
+property to ``false`` in ``cslang-cli/configuration/cslang.properties``.
+
+.. Important::
+
+  By default, the property ``use.jython.expressions=true`` is set to ``true``
+  pointing to use Jython.
+
+#. Unzip the downloaded python 3.8.7 package to any directory. Notice the python-3.8.7 folder after unzipping.
+#. Navigate to **cslang-cli/configuration** and open the **cslang.properties** file using any text editor.
+#. Specify a property ``python.path`` to point it to the following locations based on your Operating System:
+
+   * Windows: **<unzipped_location>/python-3.8.7**
+
+   * Linux: **<unzipped_location>/python-3.8.7/bin**
+
+#. Additionally for Linux environment, perform the following steps to grant permissions:
+
+    a. Open the terminal shell at **/python-3.8.7/bin** folder, and then run the following command:
+
+       .. code:: bash
+
+          ln -sf python3 python
+
+    b. Navigate back to **/python-3.8.7** folder, and then run the following command. The permission to access the folder is granted.
+
+       .. code:: bash
+
+          chmod -R 755 bin
+
 Docker
 ======
 
diff --git a/tutorial/15_lesson.rst b/tutorial/15_lesson.rst
@@ -12,8 +12,8 @@ Get Started
 
 In this lesson we'll be installing a 3rd party Python package. In order to do so
 you'll need to have Python and pip installed on your machine. You can download
-Python (version 2.7) from `here <https://www.python.org/>`__. Python 2.7.9 and
-later include pip by default. If you already have Python but don't have pip
+Python (version 3.8.x) from `here <https://www.python.org/>`__ which includes pip
+by default. If you already have Python but don't have pip
 installed on your machine, see the pip
 `documentation <https://pip.pypa.io/en/latest/installing.html>`__ for
 installation instructions.
@@ -48,6 +48,39 @@ like this (other folders omitted for simplicity):
 And finally, we'll need a new file, **fancy_text.sl** in the
 **tutorials/hiring** folder, to house a new operation.
 
+Set up python for CloudSlang cli
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To use an external python in cloudslang-cli, set the ``use.jython.expressions``
+property to ``false`` in ``cslang-cli/configuration/cslang.properties``.
+
+.. Important::
+
+   By default, the property ``use.jython.expressions=true`` is set to ``true``
+   pointing to use Jython.
+
+#. Unzip the downloaded python 3.8.7 package to any directory. Notice the python-3.8.7 folder after unzipping.
+#. Navigate to **cslang-cli/configuration** and open the **cslang.properties** file using any text editor.
+#. Specify a property ``python.path`` to point it to the following locations based on your Operating System:
+
+    * Windows: **<unzipped_location>/python-3.8.7**
+
+    * Linux: **<unzipped_location>/python-3.8.7/bin**
+
+#. Additionally for Linux environment, perform the following steps to grant permissions:
+
+     a. Open the terminal shell at **/python-3.8.7/bin** folder, and then run the following command:
+
+        .. code:: bash
+
+           ln -sf python3 python
+
+     b. Navigate back to **/python-3.8.7** folder, and then run the following command. The permission to access the folder is granted.
+
+        .. code:: bash
+
+           chmod -R 755 bin
+
 Requirements
 ------------
 
