Skip to content
This repository has been archived by the owner on Mar 31, 2020. It is now read-only.

Commit

Permalink
fixed rst doc for wheel
Browse files Browse the repository at this point in the history
version update to reflect
  • Loading branch information
MikeMillerGIS committed Jan 19, 2017
1 parent d1be8ac commit b6f48f5
Show file tree
Hide file tree
Showing 21 changed files with 88 additions and 109 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ArcREST Version 3.5.x

A latest release(v3.5.8) of ArcREST can be downloaded here: https://github.com/Esri/ArcREST/releases/tag/3.5.8
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
Expand Down
157 changes: 68 additions & 89 deletions src/README.rst
Original file line number Diff line number Diff line change
@@ -1,114 +1,100 @@
# ArcREST Version 3.5.x
ArcREST Version 3.5.x
=====================

A latest release(v3.5.8) of ArcREST can be downloaded here: https://github.com/Esri/ArcREST/releases/tag/3.5.8
* 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 latest release(v3.5.8) of ArcREST can be downloaded here:
https://github.com/Esri/ArcREST/releases/tag/3.5.8 \* 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.
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.
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
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!
- 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](http://esri.github.io/ArcREST/index.html).
The Esri portal API reference is [hosted here](http://resources.arcgis.com/en/help/arcgis-rest-api)
Documentation
-------------

### General Help
The API reference is `hosted
here <http://esri.github.io/ArcREST/index.html>`__. The Esri portal API
reference is `hosted
here <http://resources.arcgis.com/en/help/arcgis-rest-api>`__

[New to Github? Get started here.](http://htmlpreview.github.com/?https://github.com/Esri/esri.github.com/blob/master/help/esri-getting-to-know-github.html)
General Help
~~~~~~~~~~~~

## Requirements
`New to Github? Get started
here. <http://htmlpreview.github.com/?https://github.com/Esri/esri.github.com/blob/master/help/esri-getting-to-know-github.html>`__

* 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/)
Requirements
------------

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

* 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/Pro 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.

```bash
pip install -r requirements.txt
python setup.py install
```

## Getting Started
Getting Started
---------------

Fetch your folders:

```python
import arcrest
from arcresthelper import securityhandlerhelper
.. code:: python
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
```
import arcrest
from arcresthelper import securityhandlerhelper
Get item metadata:
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
```python
item = admin.content.getItem(itemId=itemId)
item.title
u'Streets'
```
Get item metadata:

## Issues
.. code:: python
Find a bug or want to request a new feature? Please let us know by submitting an issue.
item = admin.content.getItem(itemId=itemId)
item.title
u'Streets'
## Contributing
Issues
------

Esri welcomes contributions from anyone and everyone.
Please see our [guidelines for contributing](https://github.com/esri/contributing).
Find a bug or want to request a new feature? Please let us know by
submitting an issue.

## PyPi
Contributing
------------

Please see our [PyPi page](https://pypi.python.org/pypi/ArcREST_Package).
Esri welcomes contributions from anyone and everyone. Please see our
`guidelines for contributing <https://github.com/esri/contributing>`__.

To build the wheel - python setup_wheel.py bdist_wheel

## Licensing
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
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

Expand All @@ -117,10 +103,3 @@ 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](LICENSE) file.

[](Esri Tags: AGS AGOL ArcGIS Server ArcGIS Online Utilities Telecommunications ArcGISSolutions)
[](Esri Language: Python)

2 changes: 1 addition & 1 deletion src/arcrest/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
arcpyFound = True
except:
arcpyFound = False
__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/_abstract/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from __future__ import absolute_import
from . import abstract

__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/agol/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
from . import helperservices
from ._uploads import Uploads

__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/agol/helperservices/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
from .elevation import *
from .hydrology import *
#from .geocoder import *
__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/ags/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@
from ._geocodeservice import GeocodeService
from ._vectortile import VectorTileService
from .server import Server as AGSServer
__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/cmp/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from __future__ import absolute_import
from . import community

__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/common/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
from . import filters
from . import servicedef
from . import find
__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
project.
"""
########################################################################
__version__ = "3.5.8"
__version__ = "3.5.9"
"""
VERIFY_SSL_CERTIFICATES is a system level setting that allows for the by-pass of
less secure sites where the SSL certificates may be expired or invalid.
Expand Down
2 changes: 1 addition & 1 deletion src/arcrest/enrichment/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@
"""
from __future__ import absolute_import
from ._geoenrichment import GeoEnrichment
__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/geometryservice/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from __future__ import absolute_import
from .geometryservice import GeometryService

__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/hostedservice/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
from __future__ import absolute_import
from .service import AdminFeatureService, AdminFeatureServiceLayer, AdminMapService, Services
__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/manageags/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
from .administration import AGSAdministration
from .parameters import ClusterProtocol, Extension

__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/manageorg/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
from .administration import Administration
from ._parameters import *

__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/manageportal/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from __future__ import absolute_import
from .administration import PortalAdministration, _log, _Security, _System

__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/opendata/_web.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
from ..packages.six.moves import http_cookiejar as cookiejar
from ..packages.six.moves.urllib_parse import urlencode
########################################################################
__version__ = "3.5.8"
__version__ = "3.5.9"

########################################################################
class RedirectHandler(request.HTTPRedirectHandler):
Expand Down
2 changes: 1 addition & 1 deletion src/arcrest/security/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
from .security import LDAPSecurityHandler, NTLMSecurityHandler, OAuthSecurityHandler, AGOLTokenSecurityHandler,\
AGSTokenSecurityHandler, ArcGISTokenSecurityHandler, PKISecurityHandler, PortalServerSecurityHandler, \
PortalTokenSecurityHandler, CommunityMapsSecurityHandler
__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/web/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
"""
from __future__ import absolute_import
from . import _base
__version__ = "3.5.8"
__version__ = "3.5.9"
2 changes: 1 addition & 1 deletion src/arcrest/web/_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
from ..packages.six.moves.urllib_parse import urlencode

########################################################################
__version__ = "3.5.8"
__version__ = "3.5.9"
########################################################################

class BaseOperation(object):
Expand Down
2 changes: 1 addition & 1 deletion src/arcrest/webmap/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
import renderer
import symbols
import operationallayers
__version__ = "3.5.8"
__version__ = "3.5.9"

0 comments on commit b6f48f5

Please sign in to comment.