ArcREST

python package for REST API (AGS, AGOL, webmap JSON, etc..)

Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star blank 374f33e4d622a2930833db3cbea26b5d03dc44961a6ecab0b9e13276d97d6682 (1 ratings)
Rated 4.0 out of 5
Subscribe to updates I use ArcREST


Statistics on ArcREST

Number of watchers on Github 187
Number of open issues 28
Average time to close an issue 10 days
Main language Python
Average time to merge a PR 3 days
Open pull requests 6+
Closed pull requests 8+
Last commit over 1 year ago
Repo Created almost 5 years ago
Repo Last Updated 11 months ago
Size 25.1 MB
Organization / Authoresri
Latest Release3.5.9
Contributors22
Page Updated
Do you use ArcREST? Leave a review!
View open issues (28)
View ArcREST activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating ArcREST for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)
What people are saying about ArcREST Leave a review
AWESOME

This repository is no longer being maintained. Please use the ArcGIS Python API.

Site: https://github.com/Esri/arcgis-python-api

ArcREST Version 3.5.x

A latest release(v3.5.9) of ArcREST can be downloaded here: https://github.com/Esri/ArcREST/releases/tag/3.5.9

  • If you are using an older version(v3.0.1) of ArcRest, you can find it here: https://github.com/Esri/ArcREST/releases/tag/v3.0.1
  • If you are using an older version(v2) of ArcRest, you can find it here: https://github.com/Esri/ArcREST/tree/FinalV2
  • If you are using an older version(v1) of ArcRest, you can find it here: https://github.com/Esri/ArcREST/tree/October2014v1.0Final

A set of python tools to assist working with ArcGIS REST API for ArcGIS Server (AGS), ArcGIS Online (AGOL), and ArcGIS WebMap JSON.

This is not a full implementation of the Esri REST API, but we would like to make it, so help out! Please feel free to contribute.

Features

  • Add, Delete, Update and Query Feature Services
  • Upload attachments to feature services
  • Assists in managing and publishing content
  • Allows users to control, migrate and update online content
  • Manage users on Portal, ArcGIS Server, and ArcGIS Online sites
  • Plus additional information not even listed here!

Documentation

The API reference is hosted here. The Esri portal API reference is hosted here

General Help

New to Github? Get started here.

Requirements

  • Python 2.7.x/Python 3.4 (https://www.python.org/)
  • numpy >= 1.7.1 (numpy is included with ArcGIS default installation)
  • Six (https://pypi.python.org/pypi/six) (Six is included in current version)
  • pip (https://pip.pypa.io/en/stable/installing/)

Recommended Installation

  • ArcPy (optional)
  • ArcGIS Desktop 10.2, 10.3, 10.4, 10.5 (optional)
    • If ArcPy is not installed, there will be limited functionality.

Installation

Download from PyPi using pip

pip install arcrest_package

Download a geoprocessing package to install ArcREST!

Download the GeoProcessing Package here: https://github.com/Esri/ArcREST/blob/master/ArcGIS%20Desktop%20Installer/installing_arcrest.gpk
* Note: ArcMap/Catalog is required to use the gpk format.
* Note: this tools can be used to update ArcREST as well
1. Open the GPK in the ArcGIS Desktop Product of your choosing.
2. Run the tool by double clicking on the tool icon.
3. Test the import
  • Note: If you have not done so, you may need to add your python install path and scripts folder to your environment variables. In your system PATH environment variable, add both the path to Python and the Python Scripts folder. ex: C:\Python27\ArcGIS10.3;C:\Python27\ArcGIS10.3\Scripts
  1. Install requirements
  2. run the setup.py. This should copy it to your python's site-package folder.
pip install -r requirements.txt
python setup.py install

Getting Started

Fetch your folders:

import arcrest
from arcresthelper import securityhandlerhelper

config = {'username': 'myusername', 'password': 'myp4ssword'}
token = securityhandlerhelper.securityhandlerhelper(config)
admin = arcrest.manageorg.Administration(securityHandler=token.securityhandler)
content = admin.content
userInfo = content.users.user()
userInfo.folders

Get item metadata:

item = admin.content.getItem(itemId=itemId)
item.title
 u'Streets'

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

PyPi

Please see our PyPi page.

To build the wheel - python setup_wheel.py bdist_wheel

Licensing

Copyright 2016 Esri

Licensed under the Apache License, Version 2.0 (the License); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's LICENSE file.

ArcREST open issues Ask a question     (View All Issues)
  • about 2 years AGSAdministration.createSite() - cluster parameter on AGS 10.4.1
  • over 2 years Unable to disable esri access (userType='arcgisonly')
  • over 2 years Having trouble updating a vector tile package and associated tile layer in AGOL
  • over 2 years bug: unspecified (and poss. unneeded) Python 2.7.9 requirement
  • over 2 years Enterprise login example
  • over 2 years Ability to 'Replace' Item and keep Feature Service ID.
  • over 2 years Feature Layer Attachment Example
  • over 2 years Unexpected keyword argument "multipart" when doing updateItem()
  • over 2 years attribute not implemented manageags.AGSAdministration
  • over 2 years Q: get Group object(s) by title?
  • over 2 years stop printing errors, return them instead
  • over 2 years wrong exception thrown for incorrect password
  • over 2 years RemoveAndAddFeatures using integer as the id field
  • over 2 years overuse of "pass" keyword? (AKA "pass with care")
  • over 2 years rebuilt agol tile cache from a python script
  • over 2 years The Big To Do List (ArcREST 4.0)
  • almost 2 years comparison to python API
  • almost 2 years Create Replica FS problem
  • almost 2 years Update GP installer to work in ArcGIS Pro and install arcrest in the correct enviroment
  • almost 2 years installer not working properly with ArcGIS Pro 1.4
  • almost 2 years pip install not working
  • about 2 years ArcRest Toolbox - Tool "Remove Data from Feature Service" - Error: "missing or invalid parameters"
  • about 2 years ArcRest Toolbox - Tool "Remove Data from Feature Service" - Python Compatibility Issues
  • about 2 years How to createService in folder by AGSAdministration
  • about 2 years Add WebSocket connection to StreamService
ArcREST open pull requests (View All Pulls)
  • import _meteor
  • Update _base.py
  • Fix a problem in the manageorg User class currentFolder.setter method
  • Handle servers with no folders except root
  • Keep featureservicetools from returning ags object
  • Convert to Python3
ArcREST list of languages used
Other projects in Python