V101 publish packages & clone samples (#77)

* content and notebook demonstrating publishing of packages as web layers

* added sample showing how to publish packages as web layers

* updated clone portals sample

Author: AtmaMani

guide/02 API Overview/Release notes.ipynb

@@ -9,7 +9,7 @@
     "\n",
     "* BUG-000101507 gis.groups.search returns incorrect results if the User is an owner of more than 100 groups.\n",
     "* Enabled building initial cache when publishing vector tile packages\n",
-    "* Fixed bug in creating new users on Portal 10.5 or newer\n",
+    "* Fixed bug in creating new users on ArcGIS Online or Portal for ArcGIS 10.5 or newer\n",
     "* Fix to ignore values like size of -1 when initializing item objects\n",
     "* Reorder batch geocoding results to match input array\n",
     "\n",
@@ -56,7 +56,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.5.2"
+   "version": "3.6.0"
   }
  },
  "nbformat": 4,

samples/03 Org Administrators/Clone Portal Users, Groups and Content.ipynb

@@ -17,7 +17,7 @@
    "source": [
     "# Clone Portal users, groups and content\n",
     "\n",
-    "This sample notebook can be used for cloning an entire Portal, from maybe a staging to a production environment. It clones the users, groups and the content. It does not copy over services and data though, and works at the tier of Portal items."
+    "This sample notebook can be used for cloning a portal, from say, a staging to a production environment. It clones the users, groups and the content. It does not copy over services and data though, and works at the tier of portal items."
    ]
   },
   {
@@ -48,10 +48,8 @@
    },
    "outputs": [],
    "source": [
-    "source = GIS(\"https://dev003328.esri.com/portal\", \"admin\", \"esri.agp\", verify_cert=False)\n",
-    "target = GIS(\"https://dev003327.esri.com/portal\", \"admin\", \"esri.agp\", verify_cert=False)\n",
-    "# source = GIS(\"portal or org url\", \"username\", \"password\")\n",
-    "# target = GIS(\"portal or org url\", \"username\", \"password\")\n",
+    "source = GIS(\"portal url\", \"username\", \"password\")\n",
+    "target = GIS(\"target portal url\", \"username\", \"password\")\n",
     "target_admin_username = 'admin'"
    ]
   },
@@ -211,9 +209,10 @@
     }
    ],
    "source": [
-    "for srcuser in sourceusers:\n",
-    "    if not srcuser.username in systemusers:\n",
-    "        if srcuser.username is not target_admin_username: #don't delete the account used to connect\n",
+    "for srcuser in source_users:\n",
+    "    if not srcuser.username in system_users:\n",
+    "        #don't delete the account used to connect\n",
+    "        if srcuser.username != target_admin_username:\n",
     "            try:\n",
     "                targetusr = target.users.get(srcuser.username)\n",
     "                if targetusr is not None:\n",
@@ -243,20 +242,20 @@
     "def copy_user(target, user, password):\n",
     "    # See if the user has firstName and lastName properties\n",
     "    try:\n",
-    "        firstname = user.firstName\n",
-    "        lastname = user.lastName\n",
+    "        first_name = user.firstName\n",
+    "        last_name = user.lastName\n",
     "    except:\n",
     "        # if not, split the fullName\n",
-    "        fullName = user.fullName\n",
-    "        firstname = fullName.split()[0]\n",
+    "        full_name = user.fullName\n",
+    "        first_name = full_name.split()[0]\n",
     "        try:\n",
-    "            lastname = fullName.split()[1]\n",
+    "            last_name = full_name.split()[1]\n",
     "        except:\n",
-    "            lastname = 'NoLastName'\n",
+    "            last_name = 'NoLastName'\n",
     "\n",
     "    try:\n",
     "        # create user\n",
-    "        target_user = target.users.create(user.username, password, firstname, lastname,\n",
+    "        target_user = target.users.create(user.username, password, first_name, last_name,\n",
     "                                          user.email, user.description, user.role)\n",
     "\n",
     "        # update user properties\n",
@@ -344,7 +343,7 @@
    "source": [
     "ignore_list = [target_admin_username,'system_publisher', 'esri_nav', 'esri_livingatlas', \n",
     "               'esri_boundaries', 'esri_demographics']\n",
-    "for user in sourceusers:\n",
+    "for user in source_users:\n",
     "    if not user.username in ignore_list:\n",
     "        print(\"Creating user: \" + user.username)\n",
     "        copy_user(target, user, 'TestPassword@123')"
@@ -430,8 +429,8 @@
     }
    ],
    "source": [
-    "targetusers = target.users.search()\n",
-    "targetusers"
+    "target_users = target.users.search()\n",
+    "target_users"
    ]
   },
   {
@@ -483,8 +482,8 @@
     }
    ],
    "source": [
-    "sourcegroups = source.groups.search()\n",
-    "sourcegroups"
+    "source_groups = source.groups.search()\n",
+    "source_groups"
    ]
   },
   {
@@ -511,8 +510,8 @@
     }
    ],
    "source": [
-    "targetgroups = target.groups.search()\n",
-    "targetgroups"
+    "target_groups = target.groups.search()\n",
+    "target_groups"
    ]
   },
   {
@@ -531,9 +530,9 @@
    "outputs": [],
    "source": [
     "groups_to_ignore = ['Basemaps']\n",
-    "for tg in targetgroups:\n",
+    "for tg in target_groups:\n",
     "    if tg.title not in groups_to_ignore:\n",
-    "        for sg in sourcegroups:\n",
+    "        for sg in source_groups:\n",
     "            if sg.title == tg.title and (not tg.owner in systemusers):\n",
     "                print(\"Cleaning up group {} in target Portal...\".format(tg.title))\n",
     "                tg.delete()\n",
@@ -667,8 +666,8 @@
     }
    ],
    "source": [
-    "targetgroups = target.groups.search()\n",
-    "targetgroups"
+    "target_groups = target.groups.search()\n",
+    "target_groups"
    ]
   },
   {
@@ -722,8 +721,9 @@
    "metadata": {},
    "source": [
     "Copying items consists of multiple steps. The following section of the sample does the following\n",
-    "    1. Create a dictionary of itemIds and item objects for each user in each folder\n",
-    "    2. Prepare sharing information for each item"
+    "\n",
+    " 1. Create a dictionary of itemIds and `Item` objects for each user in each folder\n",
+    " 2. Prepare sharing information for each item"
    ]
   },
   {
@@ -800,18 +800,18 @@
    ],
    "source": [
     "source_items_by_id = {}\n",
-    "for user in sourceusers:\n",
-    "    if not user.username in systemusers:  # ignore any 'system' Portal users\n",
+    "for user in source_users:\n",
+    "    if not user.username in system_users:  # ignore any 'system' Portal users\n",
     "        print(\"Collecting item ids for {}...\".format(user.username))\n",
-    "        usercontent = user.items()\n",
+    "        user_content = user.items()\n",
     "        # Copy item ids from root folder first\n",
-    "        for item in usercontent:\n",
+    "        for item in user_content:\n",
     "            source_items_by_id[item.itemid] = item \n",
     "        # Copy item ids from folders next\n",
     "        folders = user.folders\n",
     "        for folder in folders:\n",
-    "            folderitems = user.items(folder=folder['title'])\n",
-    "            for item in folderitems:\n",
+    "            folder_items = user.items(folder=folder['title'])\n",
+    "            for item in folder_items:\n",
     "                source_items_by_id[item.itemid] = item "
    ]
   },
@@ -831,12 +831,12 @@
    },
    "outputs": [],
    "source": [
-    "for group in sourcegroups:\n",
+    "for group in source_groups:\n",
     "    if group.title not in groups_to_ignore:\n",
-    "        if not group.owner in systemusers:\n",
+    "        if not group.owner in system_users:\n",
     "            target_group_id = copied_groups[group.groupid]\n",
     "            for group_item in group.content():\n",
-    "                if not group_item.owner in systemusers:\n",
+    "                if not group_item.owner in system_users:\n",
     "                    try:\n",
     "                        item = source_items_by_id[group_item.itemid]\n",
     "                        if item is not None:\n",
@@ -5580,7 +5580,7 @@
     "        print(\"**************\\n\"+user.username)\n",
     "        usercontent = user.items()\n",
     "        folders = user.folders\n",
-    "        for item in usercontent:\n",
+    "        for item in user_content:\n",
     "            try:\n",
     "                copied_item = copy_item(target, user, None, item)\n",
     "                if copied_item is not None:\n",
@@ -5598,12 +5598,10 @@
     "                print(\"Error copying \" + item.title)\n",
     "\n",
     "        for folder in folders:\n",
-    "            target.content.create_folder(folder['title'], user)\n",
-    "            folderitems = user.items(folder['title'])\n",
+    "            target.content.create_folder(folder, user)\n",
+    "            folder_items = user.items(folder['title'])\n",
     "            for item in folderitems:\n",
     "                try:\n",
-    "                    #display(item)\n",
-    "                    #print(item.__repr__())\n",
     "                    copied_item = copy_item(target, user, folder['title'], item)\n",
     "                    if copied_item is not None:\n",
     "                        copied_items[item.itemid] = copied_item.itemid\n",
@@ -5622,8 +5620,8 @@
     "        # Copy the related items for this user (if specified)\n",
     "        if relationships:\n",
     "            for folder in folders:\n",
-    "                folderitems = usercontent[folder]\n",
-    "                for item in folderitems:\n",
+    "                folder_items = user_content[folder]\n",
+    "                for item in folder_items:\n",
     "                    try:\n",
     "                        copy_relationships(target, copied_items, item, \n",
     "                                           relationships, user, folder)\n",
@@ -5634,7 +5632,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [default]",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -5648,7 +5646,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.5.2"
+   "version": "3.6.0"
   }
  },
  "nbformat": 4,