Skip to content

Commit ea9cd02

Browse files
committed
Added information about activating the pipenv environments to the guide
1 parent 817eb58 commit ea9cd02

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

guide/01-getting-started/install-and-set-up.ipynb

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
" - [Install Using ArcGIS Pro Python Package Manager](#Install-using-ArcGIS-Pro-Python-Package-Manager)\n",
2121
" - [Install Using the Python Command Prompt](#Install-using-Python-Command-Prompt)\n",
2222
" - [Install Using Anaconda for Python Distribution](#Install-using-Anaconda-for-Python-Distribution)\n",
23-
" - [Install Using pip](#Install-using-pip)\n",
23+
" - [Install Using pip or pipenv](#Install-using-pipenv-or-pip)\n",
2424
" - [Install without Dependencies](#Install-without-Dependencies)\n",
2525
" - [Upgrade the `arcgis` package](#Upgrade-the-arcgis-package)\n",
2626
" - [ArcGIS Pro 2.1](#ArcGIS-Pro-2.1)\n",
@@ -120,19 +120,25 @@
120120
"\n",
121121
"### Install using pipenv or pip\n",
122122
"\n",
123-
"[Pipenv](https://docs.pipenv.org/) is the official packaging tool for managing environments and installing packages from the [Python Package Index (PyPI)](https://pypi.python.org/pypi). To install the ArcGIS API for Python from PyPI in a new environment, open a terminal and enter the following command:\n",
123+
"#### Pipenv\n",
124+
"[Pipenv](https://docs.pipenv.org/) is the official packaging tool for managing environments and installing packages from the [Python Package Index (PyPI)](https://pypi.python.org/pypi). To install the ArcGIS API for Python from PyPI in a new environment, open a terminal in an empty directory and enter the following command:\n",
124125
"\n",
125126
"```\n",
126127
"pipenv install arcgis\n",
127128
"```\n",
128129
"\n",
130+
"This will install the `arcgis` package and create a `Pipfile` in your current working directory. You can activate this environment by running '`pipenv shell`' in this directory. You can also run any command in this environment without activating it by running '`pipenv run {insert_command_here}`'. See [this guide](http://docs.python-guide.org/en/latest/dev/virtualenvs/#installing-packages-for-your-project) for more information. \n",
131+
"\n",
132+
"#### Pip\n",
133+
"\n",
129134
"[Pip](https://pip.pypa.io/en/stable/) is the predecessor of pipenv, and can also be used to install packages from PyPI (but you must manage environments with seperate tools like [virtualenv](https://virtualenv.pypa.io/en/stable/)). To install the API with pip, open a terminal and enter the following command:\n",
130135
" \n",
131136
"```\n",
132137
"pip install arcgis\n",
133138
"```\n",
134139
"\n",
135-
"You should avoid mixing conda with pipenv/pip: they are completely seperate package managers. It is recommended that you use conda to install the API if you are a beginner user. Read more about the differences [here](https://stackoverflow.com/questions/20994716/what-is-the-difference-between-pip-and-conda) and [here](https://docs.pipenv.org/).\n",
140+
"#### Disclaimer\n",
141+
"You should avoid mixing conda with pipenv/pip: they are completely seperate package managers. It is recommended that you use conda to install the API if you are a beginner user. Read more about the differences [here](https://stackoverflow.com/questions/20994716/what-is-the-difference-between-pip-and-conda) and [here](http://docs.python-guide.org/en/latest/dev/virtualenvs/).\n",
136142
"\n",
137143
"> Note: when installing the ArcGIS API for Python with pipenv/pip, some dependencies may require Microsoft Visual C++ 14.0. If you see any errors related to this, either install the Microsoft Visual C++ tools or install the API without dependencies.\n",
138144
"\n",

0 commit comments

Comments
 (0)