Skip to content

Instantly share code, notes, and snippets.

@sloanlance
Created August 19, 2016 14:21
Show Gist options
  • Save sloanlance/b6e8bcb1a4355d314423d2af1c5a047d to your computer and use it in GitHub Desktop.
Save sloanlance/b6e8bcb1a4355d314423d2af1c5a047d to your computer and use it in GitHub Desktop.
An exceprt of documentation I added to the ArcREST wiki. From: https://github.com/Esri/ArcREST/wiki/1.-ArcREST-Home-page

Since ArcREST's repository directory structure doesn't follow that expected of the usual Python packages (some files that usually appear in the root directory are in the src directory instead), care must be taken to install it using specific commands.

  1. Install from PyPI using pip:

This is recommended in README.md. The package in PyPI is a static build of ArcREST and is not dependent on the contents of the git repository, so the unusual directory structure isn't an impediment.

pip install arcrest_package
  1. Install from GitHub using pip:

ArcREST may be installed from the git repository, but the unusual directory structure requires a specially formatted fragment suffix for the URL:

pip install 'git+https://github.com/Esri/ArcREST.git#egg=arcrest&subdirectory=src'

To install a specific tag or branch from the git repository, its name may be added to the URL, too. For example, to install the version 3.5.3 tag, use:

pip install 'git+https://github.com/Esri/ArcREST.git@3.5.3#egg=arcrest&subdirectory=src'
Note
Although these URLs work with pip, they are not truly valid URLs and will not work in a typical web browser.
  1. Install from a local git repository clone:

If you have cloned the git repository to your local environment, you can use the following commands in the src directory:

pip install -r requirements.txt
python setup.py install
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment