updated __init__.py, script_run and RTD files (#184)

* updated __init__.py and script_run

* updated RTD rst files

docs/source/execution.rst

@@ -6,10 +6,7 @@ To execute the script and update Grouper and EDS, include the
 
 ::
 
-   (admin1) $ ./scripts/script_run --config config/figshare.ini \
-                          --persistent_path $persist_path \
-                          --ldap_password $password --grouper_password $password \
-                          --quota --portal --sync
+   (admin1) $ ./scripts/script_run --config config/figshare.ini --persistent_path $persist_path --ldap_password $password --grouper_password $password --quota --portal --sync
 
 Note: Without the ``sync`` flag, the above command line will perform a
 “dry run” where both ``quota`` and ``portal`` queries are conducted. It
@@ -54,11 +51,13 @@ Execution can be done as follows:
 
 ::
 
+
    (admin1) $ ./scripts/user_update --config config/figshare.ini \
                           --persistent_path $persist_path \
                           --ldap_password $password --grouper_password $password \
                           --quota 123456 --portal testportal --netid <username> --sync
 
+
 Here, the script will update the specified ``<username>`` to be
 associated with the ``123456`` quota and the ``testportal`` portal. Much
 like ``script_run``, execution requires the ``--sync`` flag. Otherwise,
@@ -118,8 +117,8 @@ exists, it will skip to the privilege assignments. To execute the script:
 ::
 
    (admin1) $ ./scripts/add_grouper_groups --config config/figshare.ini \
-                          --persistent_path $persist_path --grouper_password $password \
-                          --main_themes --sub_portals --quota --add
+                          --persistent_path $persist_path --grouper_password $password --main_themes --sub_portals --quota --add
+
 
 The ``main_themes``, ``sub_portals`` and ``quota`` flags will conduct
 checks and create those sets of groups. Without the ``add`` flag, it is

docs/source/getting_started.rst

@@ -11,12 +11,14 @@ The :repo-main-file:`requirements.txt <requirements.txt>` indicates the required
 libraries. In short, you will need the following to have a working copy of
 this software.
 
-1. Python (>=3.8)
+
+1. Python (>=3.8) (we use 3.9)
 2. `ldap3`_ (2.6.1)
-3. `numpy`_ (>=1.22.0)
+3. `numpy`_ (>=1.22.0) (we use 1.23.0)
 4. :ual-re:`redata <redata-commons>` (>=0.5.0)
 5. `pandas`_ (>=1.4.3)
-6. `tabulate`_ (>=0.8.7)
+6. `tabulate`_ (>=0.8.7) (we use 0.8.10)
+
 7. `requests`_ (2.25.1)
 
 Note: Python 3.7 will not be supported by Numpy 1.22.0 (June 2022). see https://github.com/UAL-RE/ReQUIAM/issues/170
@@ -27,11 +29,11 @@ Installation Instructions
 Python and setting up a ``conda`` environment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-First, install a working version of Python (>=3.8) using ``conda``. We recommend using
-the `Anaconda`_ package installer.
+First, we recommend using the `Anaconda`_ package installer the latest version under your account, which uses Python 3.9. We do not recommend to 
+install it using `root`.
+
 
-After you have Anaconda installed, you will want to create a separate
-``conda`` environment and activate it:
+After that, you shall create a separate ``conda`` environment and activate it for ReQUIAM:
 
 ::
 
@@ -60,6 +62,7 @@ You can confirm installation via ``conda list``
 
 ::
 
+
    (admin1) $ conda list
 
 You shall see the above packages versions matching the requirements.
@@ -102,6 +105,7 @@ query, execute the following command:
                           --persistent_path $persist_path \
                           --ldap_password $password --grouper_password $password
 
+
 Test command-line flags (``test`` and ``test_reverse``) are available to
 test EDS query and Grouper synchronization (with the ``sync`` flag) by
 executing the following :

requiam/__init__.py

@@ -1,7 +1,7 @@
 from typing import Union
 from datetime import datetime
 
-__version__ = "1.0.1"
+__version__ = "1.1.0"
 
 CODE_NAME = 'ReQUIAM'
 

scripts/script_run

@@ -75,7 +75,7 @@ if __name__ == '__main__':
     {CODE_NAME} active branch: {gi.branch}
     {CODE_NAME} version: {__version__}
     {CODE_NAME} commit hash: {gi.short_commit}
-    Created by Chun Ly
+    Updated by Yan Han on 2022-07-18, Created by Chun Ly
     Issues? Submit a GitHub ticket: https://github.com/UAL-RE/ReQUIAM/issues/new
     """
     print(banner_message)