Skip to content

Commit f8f7375

Browse files
committed
Addressed Atma's comments about an example workflow of using pipenv
1 parent c8af034 commit f8f7375

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,13 +121,17 @@
121121
"### Install using pipenv or pip\n",
122122
"\n",
123123
"#### 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",
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, create a new folder named `your-folder`. Open a terminal, and run `cd /path/to/your-folder` to change directories into `your-folder`. Then, enter the following command to simultaneously create a new environment and install the API in it:\n",
125125
"\n",
126126
"```\n",
127127
"pipenv install arcgis\n",
128128
"```\n",
129129
"\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",
130+
"After running this command, you will notice that a new file named `Pipfile` was created in `your-folder`. A [Pipfile](https://github.com/pypa/pipfile) contains package information that represents a python environment. Open your terminal and make sure you are still in the `your-folder` directory; then, run `pipenv shell`. You have now activated your python environment, the environment that contains the `arcgis` package! You can run `jupyter notebook` or `python` in this environment to start using the API.\n",
131+
" \n",
132+
"Pipenv differs from conda and other environment managers in that environments are specific to the folder that contains the Pipfile. In this way, pipenv's use of `Pipfile` is similar to how `npm` uses `package.json`. To learn more about installing and using pipenv, click [here](https://docs.pipenv.org/) or [here](http://docs.python-guide.org/en/latest/dev/virtualenvs/#installing-packages-for-your-project).\n",
133+
"\n",
134+
"> __Tip__: You can run any command in an environment without activating it by running `pipenv run {insert_command_here}` in a directory with a valid Pipfile.\n",
131135
"\n",
132136
"#### Pip\n",
133137
"\n",
@@ -140,7 +144,7 @@
140144
"#### Disclaimer\n",
141145
"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",
142146
"\n",
143-
"> 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",
147+
"> __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",
144148
"\n",
145149
"### Install without Dependencies\n",
146150
"\n",
@@ -292,7 +296,7 @@
292296
"name": "python",
293297
"nbconvert_exporter": "python",
294298
"pygments_lexer": "ipython3",
295-
"version": "3.6.1"
299+
"version": "3.6.5"
296300
},
297301
"varInspector": {
298302
"cols": {

0 commit comments

Comments
 (0)