Skip to content

Commit cb68949

Browse files
AtmaManirohitgeo
authored andcommitted
V101 updates (#75)
* v101 added a topic on masking passwords to the 'working with auth schemes' page * guide v101 added section showing how to use well-known raster functions * guide v101 - item2item relationships - added link to REST api showing a table of all possible relationship types * bug fixes for NYC taxi sample notebook * added install instructions from pro 1.4 * guide - getting started - name changes * guide - API overview - updated release notes for v1.0.1, naming changes * guide - 03 - naming changes * guide - 04 - naming changes * guide - 07 - naming changes * guide - landing page - naming changes * samples - naming changes * samples - added credentials * samples - switched to forward slash. Removed redundant thumbnail images
1 parent eec1ddb commit cb68949

File tree

135 files changed

+236
-237
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+236
-237
lines changed

guide/01 Getting Started/Install and set up.ipynb

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,44 +6,55 @@
66
"source": [
77
"# Install using Conda\n",
88
"\n",
9-
"The ArcGIS Python API is distributed via conda. Conda is a popular package and environment manager application that helps you install and update packages such as the ArcGIS Python API and their dependencies. To learn more about conda, see the [getting started guide](http://conda.pydata.org/docs/get-started.html) for conda.\n",
9+
"The ArcGIS API for Python is distributed via conda. [Conda](http://conda.pydata.org/docs/get-started.html) is a popular package and environment manager application that helps you install and update packages such as the ArcGIS Python API and their dependencies. You can install the API through two main workflows - install through anaconda or install using ArcGIS Pro. Both are outlined below.\n",
1010
"\n",
11-
"## Get Conda\n",
12-
"Install the latest version of [Anaconda for Python](https://www.continuum.io/downloads) (for Python 3.5), if you don't already have conda. The ArcGIS Python API requires Python 3.\n",
13-
"If you have installed ArcGIS Pro 1.3, you already have conda and you can use that instead of downloading Anaconda.\n",
11+
"## Step: 1 Get Conda\n",
12+
"Install the latest version of [Anaconda for Python](https://www.continuum.io/downloads) (for Python 3.5), if you don't already have conda. The ArcGIS API for Python requires Python 3.\n",
13+
"If you have installed ArcGIS Pro 1.3 or later, you already have conda and you can skip to the next step.\n",
1414
"\n",
15-
"## Install arcgis package\n",
16-
"Download and install ArcGIS Python API in your conda environment, using the following command in your terminal. If you are running a Windows OS, you can type this into your command prompt or PowerShell or if you have installed ArcGIS Pro, then into your 'Python Command Prompt' shortcut within the ArcGIS Pro program group in Windows start menu. If you are running a Mac or Linux OS, you can type this into your terminal application.\n",
15+
"## Step: 2 Install `arcgis` package\n",
16+
"To download and install the API in your conda environment, type the following command in your terminal.\n",
1717
"\n",
1818
" conda install -c esri arcgis\n",
19-
" \n",
20-
"In the screen shot below, I am typing this command into the Windows command prompt.\n",
19+
"\n",
20+
"If you are running a Windows OS, you can type this into your command prompt or PowerShell. If you are running a Mac or Linux OS, you can type this into your terminal application. In the screen shot below, I am typing this command into the Windows command prompt.\n",
2121
"\n",
2222
"![install arcgis package](http://esri.github.io/arcgis-python-api/notebooks/nbimages/guide_getstarted_InstallAndSetup_01.PNG)\n",
2323
"\n",
24-
"You can now start using the ArcGIS Python API in your Python IDE of choice, or from the Jupyter Notebook environment.\n",
24+
"#### Install using ArcGIS Pro\n",
25+
"ArcGIS Pro 1.4 and later gives you a **Python Package Manager** interface that can be used to download and install the ArcGIS API for Python. As shown in the screen shot below, from your Pro backstage, click on the 'Python' tab. Then click on 'Add Packages' button and type `arcgis` into the search bar. You may have to click on the 'refresh' button to ensure you are getting the latest version of the package. Then click 'Install' and accept the terms and conditions.\n",
26+
"\n",
27+
"![install using ArcGIS Pro](http://esri.github.io/arcgis-python-api/notebooks/nbimages/guide_getstarted_InstallAndSetup_03.PNG)\n",
28+
"\n",
29+
"If you have installed ArcGIS Pro 1.3, then you can use the **Python Command Prompt** shortcut within the ArcGIS Pro program group in Windows start menu and type the conda install command explained earlier. Depending on how you installed Pro, you might have to start this prompt with elevated privileges. \n",
30+
"\n",
31+
"You can now start using the API in your Python IDE of choice, or from the Jupyter Notebook environment.\n",
2532
"\n",
2633
"### Upgrade from older arcgis package\n",
2734
"If you are upgrading from an older version of arcgis package, run the following command in your terminal:\n",
2835
"\n",
2936
" conda upgrade -c esri arcgis\n",
3037
"\n",
38+
"If you are using ArcGIS Pro 1.4 or later to install the API, then as you guessed, you can use the **Update Packages** tab in the screen shot above to update.\n",
39+
"\n",
40+
"----------------------------\n",
3141
"### Offline install\n",
3242
"If you would like to install the API on a machine without internet or, if your workstation is in a disconnected network, you can do so in three steps. \n",
3343
" * First, install the latest version of [Anaconda for Python](https://www.continuum.io/downloads) (for Python 3.5). It is preferable you install full anaconda and not miniconda. \n",
34-
" * Next download the latest version of the API from [Esri's channel on anaconda.org](https://anaconda.org/Esri/arcgis/files) for your OS. For instance, if you are installing on Linux 64-bit, then download the package titled `linux-64/arcgis-1.0-py35_1.tar.bz2` into a known location.\n",
44+
" * Next download the latest version of the API from [Esri's channel on anaconda.org](https://anaconda.org/Esri/arcgis/files) for your OS. For instance, if you are installing on Linux 64-bit, then download the package titled `linux-64/arcgis-1.0.1-py35_1.tar.bz2` into a known location.\n",
3545
" * Run conda from your terminal and install the API using the following command\n",
3646
"\n",
37-
" `conda install /path_to_package_download_folder/linux-64/arcgis-1.0-py35_1.tar.bz2`\n",
47+
" `conda install /path_to_package_download_folder/linux-64/arcgis-1.0.1-py35_1.tar.bz2`\n",
3848
"\n",
3949
"If you find yourself installing the API in multiple machines or, if you need to use miniconda in your workflow, it might be beneficial to set up an offline conda channel. Refer to the [Esri Knowledge Base article for instructions](http://support.esri.com/Products/Developers/scripting-and-automation/arcgis-python-api/1-0#knowledge-base).\n",
4050
"\n",
51+
"-------------------------------\n",
4152
"## Start jupyter notebook\n",
4253
"To use the API in the Jupyter Notebook environment, use the following command in your terminal:\n",
4354
"\n",
4455
" jupyter notebook\n",
4556
"\n",
46-
"Refer to this doc for more help on [how to use the notebook environment](https://developers.arcgis.com/python/guide/Using-the-Jupyter-Notebook-environment/)\n",
57+
"Refer to this doc for more help on [how to use the notebook environment](https://developers.arcgis.com/python/guide/using-the-jupyter-notebook-environment/)\n",
4758
"\n",
4859
"## Test your install\n",
4960
"From the Jupyter Notebook dashboard, create a new Python 3 notebook and type these lines of code:\n",

guide/01 Getting Started/System requirements.ipynb

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,13 @@
66
"source": [
77
"# System requirements\n",
88
"\n",
9-
"In order to use version ArcGIS Python API, you need to use Python 3.\n",
10-
"\n",
11-
"To use the map widget for Jupyter notebook, you need Python 3.4 or 3.5, and <a href=\"https://github.com/ipython/ipywidgets\">ipywidgets</a> version 5.1.5 or newer.\n",
12-
"The conda installer for the arcgis package installs these dependencies."
9+
"In order to use version ArcGIS API for Python, you need Python 3.5 or later."
1310
]
1411
}
1512
],
1613
"metadata": {
1714
"kernelspec": {
18-
"display_name": "Python [default]",
15+
"display_name": "Python 3",
1916
"language": "python",
2017
"name": "python3"
2118
},

guide/01 Getting Started/Using the API.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"source": [
99
"# Using The API\n",
1010
"\n",
11-
"The GIS object is the most important object when working with the Arcgis Python API. The GIS object represents the online GIS you are working with, be it ArcGIS Online or an ArcGIS Portal. You use the GIS object to consume and publish GIS content and administrators may use it to manage GIS users, groups and datastores. The GIS object also includes a number of tools, including spatial analysis tools, big data analytics tools, raster analytics tools as well as helper services such as geocoding and geometry to help in your workflows."
11+
"The GIS object is the most important object when working with the ArcGIS API for Python. The GIS object represents the online GIS you are working with, be it ArcGIS Online or a Portal for ArcGIS. You use the GIS object to consume and publish GIS content and administrators may use it to manage GIS users, groups and datastores. The GIS object also includes a number of tools, including spatial analysis tools, big data analytics tools, raster analytics tools as well as helper services such as geocoding and geometry to help in your workflows."
1212
]
1313
},
1414
{
@@ -115,7 +115,7 @@
115115
"cell_type": "markdown",
116116
"metadata": {},
117117
"source": [
118-
"The Arcgis Python API is integrated with Jupyter Notebook to make it easy to visualize and interact with GIS resources. The user object has a rich representation that can be queried like this:"
118+
"The ArcGIS API for Python is integrated with Jupyter Notebook to make it easy to visualize and interact with GIS resources. The user object has a rich representation that can be queried like this:"
119119
]
120120
},
121121
{

guide/01 Getting Started/Using the Jupyter Notebook environment.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"source": [
1616
"## Starting the Jupyter Notebook environment\n",
1717
"\n",
18-
"Once conda and the ArcGIS Python API is [installed](https://developers.arcgis.com/python/guide/Install-and-set-up), you can start the Jupyter Notebook environment by typing the following command in your terminal.\n",
18+
"Once conda and the ArcGIS API for Python is [installed](https://developers.arcgis.com/python/guide/Install-and-set-up), you can start the Jupyter Notebook environment by typing the following command in your terminal.\n",
1919
"\n",
2020
" jupyter notebook\n",
2121
"\n",
@@ -33,7 +33,7 @@
3333
"cell_type": "markdown",
3434
"metadata": {},
3535
"source": [
36-
"If you installed the ArcGIS Python API in a conda **environment** other than root (which is the default), you need to `activate` that environment before starting the Jupyter Notebook. For more information on the benefits of using environments and how to create and manage them, refer to this [official documentation page](http://conda.pydata.org/docs/using/envs.html).\n",
36+
"If you installed the ArcGIS API for Python in a conda **environment** other than root (which is the default), you need to `activate` that environment before starting the Jupyter Notebook. For more information on the benefits of using environments and how to create and manage them, refer to this [official documentation page](http://conda.pydata.org/docs/using/envs.html).\n",
3737
"\n",
3838
"If you are running a sample notebook for the API, you need to 'cd' into the directory where you [downloaded the samples](https://github.com/Esri/arcgis-python-api/releases/tag/v0.3-beta). In the example above, the samples have been downloaded and extracted into c:\\code directory.\n",
3939
"\n",
@@ -97,7 +97,7 @@
9797
"metadata": {
9898
"anaconda-cloud": {},
9999
"kernelspec": {
100-
"display_name": "Python [default]",
100+
"display_name": "Python 3",
101101
"language": "python",
102102
"name": "python3"
103103
},

guide/02 API Overview/Overview of the ArcGIS Python API.ipynb renamed to guide/02 API Overview/Overview of the ArcGIS API for Python.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Overview of the ArcGIS Python API\n",
7+
"# Overview of the ArcGIS API for Python\n",
88
"\n",
9-
"The ArcGIS Python API is a powerful, modern and easy to use Pythonic library to perform GIS visualization and analysis, spatial data management and GIS system administration tasks that can run both interactively, and using scripts.\n",
9+
"The ArcGIS API for Python is a powerful, modern and easy to use Pythonic library to perform GIS visualization and analysis, spatial data management and GIS system administration tasks that can run both interactively, and using scripts.\n",
1010
"\n",
1111
"## A Pythonic GIS API\n",
12-
"The ArcGIS Python API provides a pythonic representation of a GIS. A pythonic API is one which corresponds to Python best practices in its design and uses standard Python constructs and data structures with clean, readable idioms. The API makes it easy and natural for a Python programmer to use ArcGIS, and conversely, an ArcGIS user to script and automate their GIS.\n",
12+
"The ArcGIS API for Python provides a pythonic representation of a GIS. A pythonic API is one which corresponds to Python best practices in its design and uses standard Python constructs and data structures with clean, readable idioms. The API makes it easy and natural for a Python programmer to use ArcGIS, and conversely, an ArcGIS user to script and automate their GIS.\n",
1313
"\n",
14-
"The ArcGIS Python API is implemented using the online and on-premises web GIS platform provided by ArcGIS Online and ArcGIS Enterprise respectively. The API has Python modules, classes, functions, and types for managing and working with elements of the ArcGIS platform information model."
14+
"The ArcGIS API for Python is implemented using the online and on-premises web GIS platform provided by ArcGIS Online and ArcGIS Enterprise respectively. The API has Python modules, classes, functions, and types for managing and working with elements of the ArcGIS platform information model."
1515
]
1616
},
1717
{
@@ -87,7 +87,7 @@
8787
"metadata": {
8888
"anaconda-cloud": {},
8989
"kernelspec": {
90-
"display_name": "Python [default]",
90+
"display_name": "Python 3",
9191
"language": "python",
9292
"name": "python3"
9393
},

guide/02 API Overview/Release notes.ipynb

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7+
"# What's new in version 1.0.1\n",
8+
"Version 1.0.1 is a bug fix release. Following are some of the bugs that were resolved:\n",
9+
"\n",
10+
"* BUG-000101507 gis.groups.search returns incorrect results if the User is an owner of more than 100 groups.\n",
11+
"* Enabled building initial cache when publishing vector tile packages\n",
12+
"* Fixed bug in creating new users on Portal 10.5 or newer\n",
13+
"* Fix to ignore values like size of -1 when initializing item objects\n",
14+
"* Reorder batch geocoding results to match input array\n",
15+
"\n",
16+
"\n",
717
"# What's new in version 1.0.0\n",
818
"\n",
919
"Ever since we released the public beta versions, your response to this API has been phenomenal. Since the last release of beta 3, the API went through a redesign phase. We took a critical look at the previous design and evaluated it against the ease of use, extensibility and our original goal of developing a Pythonic API for GIS. The result is this new design, a design that simply does not contour to the implementation logic, but efficiently abstracts it, ensuring the simplicity and beauty of the programming language prevails.\n",

guide/03 The GIS/Accessing and creating content.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2038,14 +2038,14 @@
20382038
"metadata": {},
20392039
"source": [
20402040
"## Summary\n",
2041-
"Thus, in this guide you observed how the `gis` module can be used to create new content and search for existing ones. Head over to the guide on [managing-your-content](/managing-your-content) next. When combined into a script, the ArcGIS Python API becomes a powerful tool to automate your GIS content creation and management tasks."
2041+
"Thus, in this guide you observed how the `gis` module can be used to create new content and search for existing ones. Head over to the guide on [managing-your-content](/managing-your-content) next. When combined into a script, the ArcGIS API for Python becomes a powerful tool to automate your GIS content creation and management tasks."
20422042
]
20432043
}
20442044
],
20452045
"metadata": {
20462046
"anaconda-cloud": {},
20472047
"kernelspec": {
2048-
"display_name": "Python [default]",
2048+
"display_name": "Python 3",
20492049
"language": "python",
20502050
"name": "python3"
20512051
},

guide/03 The GIS/Managing your content.ipynb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -769,6 +769,13 @@
769769
"webmap_item.dependent_to()"
770770
]
771771
},
772+
{
773+
"cell_type": "markdown",
774+
"metadata": {},
775+
"source": [
776+
"The table in [this documentation](http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Relationship_types/02r3000000mm000000/) gives you the list of all supported relationship types that can exist between two items in your GIS."
777+
]
778+
},
772779
{
773780
"cell_type": "markdown",
774781
"metadata": {},
@@ -919,7 +926,7 @@
919926
"metadata": {
920927
"anaconda-cloud": {},
921928
"kernelspec": {
922-
"display_name": "Python [default]",
929+
"display_name": "Python 3",
923930
"language": "python",
924931
"name": "python3"
925932
},

guide/03 The GIS/Using the GIS.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"source": [
99
"# Using the GIS \n",
1010
"\n",
11-
"The `GIS` object in the `gis` module is the most important object when working with the Arcgis Python API. The GIS object represents the GIS you are working with, be it ArcGIS Online or an instance of ArcGIS Enterprise. You use the GIS object to consume and publish GIS content and administrators may use it to manage GIS users, groups and datastores. This object becomes your entry point in your Python script when using the API."
11+
"The `GIS` object in the `gis` module is the most important object when working with the ArcGIS API for Python. The GIS object represents the GIS you are working with, be it ArcGIS Online or an instance of ArcGIS Enterprise. You use the GIS object to consume and publish GIS content and administrators may use it to manage GIS users, groups and datastores. This object becomes your entry point in your Python script when using the API."
1212
]
1313
},
1414
{
@@ -33,7 +33,7 @@
3333
"cell_type": "markdown",
3434
"metadata": {},
3535
"source": [
36-
"To create the GIS object, we pass in the url and our login credentials:"
36+
"To create the GIS object, we pass in the url and our login credentials as shown below:"
3737
]
3838
},
3939
{
@@ -44,7 +44,7 @@
4444
},
4545
"outputs": [],
4646
"source": [
47-
"gis = GIS(\"https://yourorg.arcgis.com\", \"username\", \"password\")"
47+
"gis = GIS(\"https://www.arcgis.com\", \"arcgis_python\", \"P@ssword123\")"
4848
]
4949
},
5050
{
@@ -133,7 +133,7 @@
133133
"metadata": {},
134134
"source": [
135135
"## Rich IDE experience with Jupyter notebooks\n",
136-
"The Arcgis Python API is integrated with Jupyter Notebook to make it easy to visualize and interact with GIS resources. The `user` object has a rich representation that can be queried like this:"
136+
"The ArcGIS API for Python is integrated with Jupyter Notebook to make it easy to visualize and interact with GIS resources. The `user` object has a rich representation that can be queried like this:"
137137
]
138138
},
139139
{
@@ -607,7 +607,7 @@
607607
"metadata": {
608608
"anaconda-cloud": {},
609609
"kernelspec": {
610-
"display_name": "Python [default]",
610+
"display_name": "Python 3",
611611
"language": "python",
612612
"name": "python3"
613613
},

0 commit comments

Comments
 (0)