Skip to content

Commit 24349e9

Browse files
CMPengCMPeng
committed
Merge remote-tracking branch 'origin/master' into dev_site_next_release
2 parents 39ff5b9 + ac524fb commit 24349e9

File tree

586 files changed

+646852
-41524
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

586 files changed

+646852
-41524
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Code of conduct
2+
3+
**TL;DR**<br>
4+
We expect folks that participate in both our online and [IRL](www.urbandictionary.com/define.php?term=IRL) communities to be kind and considerate of others at all times.
5+
6+
Esri's official CoC text can be found at http://www.esri.com/events/code-of-conduct

‎CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing). Please expect any pull requests to go through a peer review before being accepted.
2+
3+
### Before filing an issue
4+
5+
Please take a look at [previous issues](https://github.com/Esri/arcgis-python-api/issues?q=is%3Aissue+is%3Aclosed) that resolve common problems.
6+
7+
If you're just looking for help, you'll probably attract the most eyes if you post in the [GeoNet Forums](https://community.esri.com/groups/arcgis-python-api/).
8+
9+
If you think you're encountering a new bug, please feel free to log an [issue](https://github.com/Esri/arcgis-python-api/issues/new) and include the steps to reproduce the problem.
10+
11+
**Please include the following in your issue:**
12+
* Your conda or pip environment (run `conda list` or `pip freeze` and copy/paste the output into the issue)
13+
* Any code (or notebook) you executed that made you run into this issue
14+
15+
# Updating errors in existing notebooks
16+
17+
Do you see an error in an existing notebook? Is there a typo, a misnamed variable, and do you know how to fix it?
18+
* Make the fix in the notebook
19+
* If you made code changes, re-run the appropriate cells in the notebook (Don't re-run every cell in the notebook unless necessary)
20+
* Make a copy of the `dev_site_current` branch on your local fork
21+
* Add the updated notebook to your branch on your fork
22+
* [Open a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) from your fork's branch to this repository's `dev_site_current` branch
23+
24+
# Adding new sample notebooks
25+
26+
Do you have a notebook that shows off functionality of the API? Do you want to see that notebook released with the next version of the ArcGIS API for Python? We welcome your notebooks and workflows as it will benefit a large audience.
27+
28+
* Create a new notebook, make sure it runs consistently on its own on a few systems
29+
* Make sure the notebook filename is in an `all_lowercase_underscore_delimiter_convention.ipynb`
30+
* Make a copy of the `dev_site_next_release` branch on your local fork
31+
* Place the notebook in the correct folder in the `samples/` folder on your fork
32+
* Add the notebook to your branch on your fork
33+
* [Open a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) from your fork's branch to this repository's `dev_site_current` branch

‎PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
\<insert pull request description here\>
2+
3+
-----
4+
5+
# Checklist
6+
7+
Please go through each entry in the below checklist and mark an 'X' if that condition has been met. Every entry should be marked with an 'X' to be get the Pull Request approved.
8+
9+
10+
- [ ] All `import`s are in the first cell? First block of imports are standard libraries, second block are 3rd party libraries, third block are all `arcgis` imports?
11+
- [ ] All `GIS` object instantiations are one of the following?
12+
- `gis = GIS('https://www.arcgis.com', 'arcgis_python', 'P@ssword123')`
13+
- `gis = GIS(profile="your_online_profile")`
14+
- `gis = GIS('https://pythonapi.playground.esri.com/portal', 'arcgis_python', 'amazing_arcgis_123')`
15+
- `gis = GIS(profile="your_enterprise_portal")`
16+
- [ ] If this notebook requires setup or teardown, did you add the appropriate code to `./misc/setup.py` and/or `./misc/teardown.py`?
17+
- [ ] If this notebook references any portal items that need to be staged on AGOL/Python API playground, did you coordinate with a Python API team member to stage the item the correct way with the api\_data\_owner user?
18+
- [ ] Code refactored & split out across multiple cells, useful comments?
19+
- [ ] Consistent voice/tense/narrative style? Thoroughly checked for typos?
20+
- [ ] All images used like `<img src="base64str_here">` instead of `<img src="https://some.url">`? All map widgets contain a static image preview? (Call `mapview_inst.take_screenshot()` to do so)
21+
- [ ] All file paths are constructed in an OS-agnostic fashion with `os.path.join()`? (Instead of `r"\foo\bar"`, `os.path.join(os.path.sep, "foo", "bar")`, etc.)
22+
- [ ] **IF YOU WANT THIS SAMPLE TO BE DISPLAYED ON THE DEVELOPERS.ARCGIS.COM WEBSITE**, ping @ DavidJVitale so he can add it to the list for the next deploy

‎README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,33 @@
1-
# ArcGIS Python API
2-
Documentation and samples for the ArcGIS Python API https://developers.arcgis.com/python/
1+
# ArcGIS API for Python
2+
ArcGIS API for Python is a Python library for working with maps and geospatial data, powered by web GIS. It provides simple and efficient tools for deep learning, sophisticated vector and raster analysis, geocoding, map making, routing and directions, as well as for organizing and managing a GIS with users, groups and information items. In addition to working with your own data, the library enables access to ready to use maps and curated geographic data from Esri and other authoritative sources. It also integrates well with the scientific Python ecosystem and includes rich support for Pandas, Scikit-Learn, Fast.ai, etc. and Jupyter notebook.
33

4-
[ArcGIS Python API](https://developers.arcgis.com/python/)
5-
6-
[Join the conversation](https://geonet.esri.com/groups/arcgis-python-api/)
4+
To learn more about the API, visit the product page [here](https://developers.arcgis.com/python/). You can get in touch with the developers of the API and other users like you at the community page [here](https://geonet.esri.com/groups/arcgis-python-api/).
75

86
## What's included
7+
This SDK repository contains the following items:
8+
* API Reference Documentation. A hosted version of this can be found [here](https://esri.github.io/arcgis-python-api/apidoc/html/).
9+
* Samples as Jupyter Notebooks.
10+
* Guides chapters as Jupyter Notebooks.
911

10-
* Documentation
11-
* Sample Notebooks
12-
* Guides
13-
14-
## Requirements
15-
16-
* [See ArcGIS Python API - Install and Set Up](https://developers.arcgis.com/python/guide/install-and-set-up/)
17-
18-
## Resources
12+
You have multiple ways of executing these notebooks as listed below:
1913

20-
* [ArcGIS for Developers](https://developers.arcgis.com/python/)
14+
- Execute locally on your computer by installing anaconda and the API. See help [here](https://developers.arcgis.com/python/guide/install-and-set-up/#Get-Conda-with-Anaconda-for-Python-Distribution)
15+
- Execute with ArcGIS Pro. See help [here](https://developers.arcgis.com/python/guide/install-and-set-up/#Get-Conda-with-ArcGIS-Pro)
16+
- Execute with ArcGIS Hosted Notebooks. See [here](https://www.esri.com/en-us/arcgis/products/arcgis-notebook-server)
17+
- Execute on a hosted sandbox environment. Go to [notebooks.esri.com](http://notebooks.esri.com/)
18+
- Execute in a Dockerised environment. See help [here](https://developers.arcgis.com/python/guide/install-and-set-up/#Install-as-a-Docker-image)
19+
- Execute with Binder. See help [here](https://mybinder.org/)
2120

2221
## Issues
2322

2423
Find a bug or want to request a new feature? Please let us know by submitting an issue. Thank you!
2524

2625
## Contributing
2726

28-
Anyone and everyone is welcome to contribute. Please see our [guidelines for contributing](https://github.com/esri/contributing).
27+
Anyone and everyone is welcome to contribute. Please see our contribution guideline [here](https://github.com/Esri/arcgis-python-api/wiki/How-to-contribute-samples-and-guide-chapters).
2928

3029
## Licensing
31-
Copyright 2016-2017 Esri
30+
Copyright 2018-2019 Esri
3231

3332
Licensed under the Apache License, Version 2.0 (the "License");
3433
you may not use this file except in compliance with the License.

‎apidoc/.buildinfo

100755100644
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Sphinx build info version 1
2-
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: c0de0a492b7c6b6fece0238c2b395a11
4-
tags: 645f666f9bcd5a90fca523b33c5a78b7
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: f33d73ab3b0af3bebc609abb885db577
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎apidoc/_sources/arcgis.apps.hub.toc.rst.txt

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
arcgis.apps.hub module
2+
=======================
3+
4+
.. automodule:: arcgis.apps.hub
5+
6+
The :class:`~arcgis.apps.hub.Hub` is the main entry point into the Hub module.
7+
It can be used as shown in the following code example.
8+
9+
.. code-block:: python
10+
11+
from arcgis.gis import GIS
12+
gis = GIS("https://arcgis.com", "<username>", "<password>")
13+
myHub = gis.hub
14+
a_Initiative = myHub.initiatives.get(itemId)
15+
a_Indicators = a_Initiative.indicators.search()
16+
myEvents = myHub.events.search()
17+
18+
Hub
19+
--------------------------
20+
.. autoclass:: arcgis.apps.hub.Hub
21+
:members:
22+
:undoc-members:
23+
24+
Initiative
25+
--------------------------
26+
.. autoclass:: arcgis.apps.hub.Initiative
27+
:members:
28+
:undoc-members:
29+
30+
Indicator
31+
--------------------------
32+
.. autoclass:: arcgis.apps.hub.Indicator
33+
:members:
34+
:undoc-members:
35+
36+
Event
37+
--------------------------
38+
.. autoclass:: arcgis.apps.hub.Event
39+
:members:
40+
:undoc-members:
41+
42+
InitiativeManager
43+
--------------------------
44+
.. autoclass:: arcgis.apps.hub.InitiativeManager
45+
:members:
46+
:undoc-members:
47+
48+
IndicatorManager
49+
--------------------------
50+
.. autoclass:: arcgis.apps.hub.IndicatorManager
51+
:members:
52+
:undoc-members:
53+
54+
EventManager
55+
--------------------------
56+
.. autoclass:: arcgis.apps.hub.EventManager
57+
:members:
58+
:undoc-members:

‎apidoc/_sources/arcgis.apps.rst.txt

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
arcgis.apps module
2+
==================
3+
4+
.. automodule:: arcgis.apps
5+
6+
build_collector_url
7+
--------------
8+
.. automethod:: arcgis.apps.build_collector_url
9+
10+
build_explorer_url
11+
--------------
12+
.. automethod:: arcgis.apps.build_explorer_url
13+
14+
build_navigator_url
15+
--------------
16+
.. automethod:: arcgis.apps.build_navigator_url
17+
18+
build_survey123_url
19+
--------------
20+
.. automethod:: arcgis.apps.build_survey123_url
21+
22+
build_tracker_url
23+
--------------
24+
.. automethod:: arcgis.apps.build_tracker_url
25+
26+
Submodules
27+
----------
28+
.. toctree::
29+
:maxdepth: 3
30+
31+
arcgis.apps.hub
32+
arcgis.apps.workforce
33+
arcgis.apps.storymap
34+
arcgis.apps.survey123
35+
arcgis.apps.tracker

‎apidoc/_sources/arcgis.apps.storymap.rst.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
arcgis\.apps\.storymap module
2+
==============================
3+
4+
.. automodule:: arcgis.apps.storymap
5+
6+
JournalStoryMap
7+
----------------
8+
.. autoclass:: arcgis.apps.storymap.JournalStoryMap
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+

‎apidoc/_sources/arcgis.apps.survey123.rst.txt

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
arcgis\.apps\.survey123 module
2+
==============================
3+
4+
.. automodule:: arcgis.apps.survey123
5+
6+
SurveyManager
7+
----------------
8+
.. autoclass:: arcgis.apps.survey123.SurveyManager
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
Survey
14+
----------------
15+
.. autoclass:: arcgis.apps.survey123.Survey
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+

‎apidoc/_sources/arcgis.apps.tracker.rst.txt

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
arcgis.apps.tracker module
2+
============================
3+
4+
.. automodule:: arcgis.apps.tracker
5+
6+
7+
The :class:`~arcgis.apps.tracker.LocationTrackingManager` is the main entry point into the Workforce module.
8+
It can be used as shown in the following code example.
9+
10+
11+
.. code-block:: python
12+
13+
# Access the location tracking manager and check the status
14+
15+
import arcgis
16+
gis = arcgis.gis.GIS("https://arcgis.com", "<username>", "<password>")
17+
print(gis.admin.location_tracking.status)
18+
19+
LocationTrackingManager
20+
----------
21+
.. autoclass:: arcgis.apps.tracker.LocationTrackingManager
22+
:members:
23+
:undoc-members:
24+
:inherited-members:
25+
26+
TrackView
27+
--------------
28+
.. autoclass:: arcgis.apps.tracker.TrackView
29+
:members:
30+
:undoc-members:
31+
:inherited-members:
32+
33+
TrackViewerManager
34+
-------------
35+
.. autoclass:: arcgis.apps.tracker.TrackViewerManager
36+
:members:
37+
:undoc-members:
38+
:inherited-members:
39+
40+
MobileUserManager
41+
-------------
42+
.. autoclass:: arcgis.apps.tracker.MobileUserManager
43+
:members:
44+
:inherited-members:

0 commit comments

Comments
 (0)