georest 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. georest-0.1.0/.gitignore +135 -0
  2. georest-0.1.0/CHANGELOG.md +64 -0
  3. georest-0.1.0/CONTRIBUTING.md +98 -0
  4. georest-0.1.0/LICENSE +201 -0
  5. georest-0.1.0/PKG-INFO +158 -0
  6. georest-0.1.0/README.md +116 -0
  7. georest-0.1.0/docs/api.md +80 -0
  8. georest-0.1.0/examples/edw_examples.ipynb +505 -0
  9. georest-0.1.0/examples/lcms_2020_change.png +0 -0
  10. georest-0.1.0/examples/services_examples.ipynb +509 -0
  11. georest-0.1.0/pyproject.toml +178 -0
  12. georest-0.1.0/src/georest/__init__.py +73 -0
  13. georest-0.1.0/src/georest/py.typed +0 -0
  14. georest-0.1.0/src/georest/restesri/__init__.py +33 -0
  15. georest-0.1.0/src/georest/restesri/_http.py +179 -0
  16. georest-0.1.0/src/georest/restesri/cli/__init__.py +14 -0
  17. georest-0.1.0/src/georest/restesri/cli/check_themes.py +142 -0
  18. georest-0.1.0/src/georest/restesri/edw.py +1464 -0
  19. georest-0.1.0/src/georest/restesri/portal.py +438 -0
  20. georest-0.1.0/src/georest/restesri/services.py +1144 -0
  21. georest-0.1.0/tests/README.md +154 -0
  22. georest-0.1.0/tests/__init__.py +1 -0
  23. georest-0.1.0/tests/fixtures/layer_cache.json +1 -0
  24. georest-0.1.0/tests/support.py +213 -0
  25. georest-0.1.0/tests/test_analytics.py +169 -0
  26. georest-0.1.0/tests/test_geometry.py +182 -0
  27. georest-0.1.0/tests/test_layers.py +239 -0
  28. georest-0.1.0/tests/test_live_catalog.py +176 -0
  29. georest-0.1.0/tests/test_live_examples.py +94 -0
  30. georest-0.1.0/tests/test_live_services.py +355 -0
  31. georest-0.1.0/tests/test_packaging.py +172 -0
  32. georest-0.1.0/tests/test_pagination.py +193 -0
  33. georest-0.1.0/tests/test_portal.py +239 -0
  34. georest-0.1.0/tests/test_search.py +158 -0
  35. georest-0.1.0/tests/test_services.py +885 -0
  36. georest-0.1.0/tools/refresh_fixtures.py +85 -0
@@ -0,0 +1,135 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ pip-wheel-metadata/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ MANIFEST
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ target/
76
+
77
+ # Jupyter Notebook
78
+ .ipynb_checkpoints
79
+
80
+ # IPython
81
+ profile_default/
82
+ ipython_config.py
83
+
84
+ # pyenv
85
+ .python-version
86
+
87
+ # pipenv
88
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
90
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
91
+ # install all needed dependencies.
92
+ #Pipfile.lock
93
+
94
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95
+ __pypackages__/
96
+
97
+ # Celery stuff
98
+ celerybeat-schedule
99
+ celerybeat.pid
100
+
101
+ # SageMath parsed files
102
+ *.sage.py
103
+
104
+ # Environments
105
+ .env
106
+ .venv
107
+ env/
108
+ venv/
109
+ ENV/
110
+ env.bak/
111
+ venv.bak/
112
+
113
+ # Spyder project settings
114
+ .spyderproject
115
+ .spyproject
116
+
117
+ # Rope project settings
118
+ .ropeproject
119
+
120
+ # mkdocs documentation
121
+ /site
122
+
123
+ # mypy
124
+ .mypy_cache/
125
+ .dmypy.json
126
+ dmypy.json
127
+
128
+ # Pyre type checker
129
+ .pyre/
130
+
131
+ # Claude Code local session state
132
+ .claude/
133
+
134
+ # Backup archives produced during the geoREST restructure
135
+ *.bak-*.tar.gz
@@ -0,0 +1,64 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are documented here. The format follows
4
+ [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres
5
+ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
+
7
+ ## [Unreleased]
8
+
9
+ ## [0.1.0] — 2026-09-10
10
+
11
+ First release as an installable distribution. Previously this was a loose
12
+ `RESTesri/` directory that imported only because the repository root happened to be
13
+ on `sys.path`.
14
+
15
+ ### Changed
16
+
17
+ - **BREAKING:** `RESTesri` is no longer a top-level package. It is now
18
+ `georest.restesri`, a subpackage of the new `georest` distribution — lowercase,
19
+ because a mixed-case import name resolves on Windows and macOS but fails on Linux.
20
+
21
+ ```python
22
+ from RESTesri import edw # before
23
+ from georest.restesri import edw # after — or: from georest import edw
24
+ ```
25
+
26
+ There is no compatibility shim: the package was never published, so every user
27
+ installed it by cloning, and a top-level `RESTesri` module inside the wheel would
28
+ squat a global import name.
29
+
30
+ - The `User-Agent` sent on every outbound request is now `georest/<version>` rather
31
+ than `hostedServiceTools/1.0`, a name left over from a predecessor project.
32
+
33
+ - `VALID_THEMES` and `theme_drift()` moved from `tests/support.py` into
34
+ `georest.restesri.edw`, so the shipped CLI no longer imports the test suite.
35
+ `tests.support` re-exports both, so existing test imports still work.
36
+
37
+ - The theme-drift checker moved out of `tests/` and is now installed as the
38
+ `georest-check-themes` console script.
39
+
40
+ - `refresh_fixtures.py` moved to `tools/`; it writes into `tests/fixtures/` and is
41
+ deliberately repo-only, not an entry point.
42
+
43
+ ### Added
44
+
45
+ - `pyproject.toml` (hatchling), `__version__`, PEP 561 `py.typed` marker, and an
46
+ Apache-2.0 declaration via PEP 639.
47
+ - Lazy top-level re-exports (PEP 562): `from georest import edw, portal, services`.
48
+ - `tests/test_packaging.py`, which enforces the re-export identity
49
+ (`georest.edw is georest.restesri.edw`) and the zero-runtime-dependency guarantee.
50
+ - CI: offline test matrix, a weekly live/drift run, and PyPI publishing via Trusted
51
+ Publishing.
52
+
53
+ ### Removed
54
+
55
+ - `scratch/` — both generator scripts hardcoded paths into a temporary directory
56
+ that no longer exists, so neither could run; `georest-check-themes --emit`
57
+ supersedes them.
58
+ - `esriToolsTest.ipynb` — a scratch notebook importing `arcgis.gis`, contrary to the
59
+ stdlib-only design.
60
+ - All five `sys.path.insert(...)` bootstraps (two CLIs, three notebooks), made
61
+ unnecessary by the `src/` layout plus an editable install.
62
+
63
+ [Unreleased]: https://github.com/redcastle-resources/georest/compare/v0.1.0...HEAD
64
+ [0.1.0]: https://github.com/redcastle-resources/georest/releases/tag/v0.1.0
@@ -0,0 +1,98 @@
1
+ # Contributing to georest
2
+
3
+ ## Setup
4
+
5
+ ```bash
6
+ git clone https://github.com/redcastle-resources/georest
7
+ cd georest
8
+ python -m venv .venv && . .venv/Scripts/activate # Windows; use bin/activate elsewhere
9
+ pip install -e ".[dev]"
10
+ ```
11
+
12
+ The editable install is **required**, not a convenience. This is a `src/` layout, so
13
+ `georest` is not importable from the repository root without it. That is the point:
14
+ the test suite imports the installed artifact, so a packaging mistake — a missing
15
+ `__init__.py`, a wrong `packages =` — fails loudly instead of being masked by the
16
+ working directory.
17
+
18
+ ## The one rule that matters
19
+
20
+ **georest has zero third-party runtime dependencies, and must keep it that way.**
21
+ Everything is stdlib `urllib` and `json`. This is what lets the package install into
22
+ an ArcGIS Pro `arcgispro-py3` clone or a locked-down agency environment without a
23
+ resolver fight. `tests/test_packaging.py` enforces it by AST-walking every module in
24
+ the package, so adding an import of `requests` fails the suite rather than shipping.
25
+
26
+ If you genuinely need a third-party library, it belongs in an optional extra with a
27
+ lazy import at the call site — never at module scope.
28
+
29
+ ## Tests
30
+
31
+ ```bash
32
+ python -m pytest # offline, deterministic
33
+ python -m unittest discover -s tests -t . # the same suite, stdlib runner
34
+ EDW_LIVE=1 SERVICES_LIVE=1 python -m pytest # include network tests
35
+ ruff check .
36
+ ```
37
+
38
+ `ruff format` is **not** enforced yet. The code predates any formatter, so
39
+ adopting one reformats 21 files at once; that deserves its own commit rather
40
+ than being smuggled into unrelated diffs. The lint ruleset in `pyproject.toml`
41
+ is likewise a starter set, with the deferred rules listed there as a backlog —
42
+ turn them on one at a time so each diff stays reviewable.
43
+
44
+ Tests are written as `unittest.TestCase` classes to match the package's own
45
+ stdlib-only posture; pytest collects them natively and is what CI runs. Either
46
+ runner is fine locally.
47
+
48
+ Live tests are opt-in and **skip** rather than fail when a server is unreachable.
49
+ EDW intermittently answers 404, 500, `Layer not found`, or 200-with-no-layers for
50
+ services that work moments later — a red run there says nothing about your change,
51
+ which is why CI leaves `EDW_LIVE`/`SERVICES_LIVE` unset and runs them on a weekly
52
+ schedule instead.
53
+
54
+ ## Fixtures
55
+
56
+ `tests/fixtures/layer_cache.json` holds real MapServer layer trees so the layer-role
57
+ logic runs offline against genuine data. Refresh it when EDW restructures services:
58
+
59
+ ```bash
60
+ python tools/refresh_fixtures.py
61
+ ```
62
+
63
+ Services that cannot be fetched keep their existing cached entry, so a flaky run
64
+ degrades freshness rather than destroying the fixture.
65
+
66
+ ## The theme table
67
+
68
+ `edw._SERVICE_THEMES` is hand-curated and rots as EDW publishes and retires
69
+ services. Check it with:
70
+
71
+ ```bash
72
+ georest-check-themes --emit
73
+ ```
74
+
75
+ Paste the emitted entries into `src/georest/restesri/edw.py` under the right theme
76
+ heading, replacing `THEME` with the correct category from `edw.VALID_THEMES`.
77
+
78
+ ## Notebooks
79
+
80
+ Strip outputs before committing, so diffs stay reviewable:
81
+
82
+ ```bash
83
+ jupyter nbconvert --clear-output --inplace examples/*.ipynb
84
+ ```
85
+
86
+ ## Releasing
87
+
88
+ 1. Bump `__version__` in `src/georest/__init__.py` — the single source of truth;
89
+ hatchling reads it by AST and `pyproject.toml` carries no literal version.
90
+ 2. Move the `## [Unreleased]` section of `CHANGELOG.md` under a new dated heading.
91
+ 3. Commit, then `git tag -a v0.1.0 -m "v0.1.0"` and push both.
92
+ 4. Create the GitHub Release from the tag. That fires `publish.yml`, which builds,
93
+ publishes to TestPyPI, installs from TestPyPI and smoke-tests it, and only then
94
+ publishes to PyPI behind an environment approval.
95
+
96
+ Version numbers are **immutable on PyPI and TestPyPI alike** — a bad release can be
97
+ yanked but never replaced. Use `0.1.0.dev1`, `.dev2`, … for rehearsals so the real
98
+ number stays available.
georest-0.1.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Ryan Rock and Ian Housman
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
georest-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,158 @@
1
+ Metadata-Version: 2.5
2
+ Name: georest
3
+ Version: 0.1.0
4
+ Summary: Stdlib-only Python clients for geospatial REST APIs: ArcGIS Image, Map and Feature Services, the USFS Enterprise Data Warehouse, and ArcGIS Portal search.
5
+ Project-URL: Homepage, https://github.com/redcastle-resources/georest
6
+ Project-URL: Repository, https://github.com/redcastle-resources/georest
7
+ Project-URL: Issues, https://github.com/redcastle-resources/georest/issues
8
+ Project-URL: Changelog, https://github.com/redcastle-resources/georest/blob/main/CHANGELOG.md
9
+ Project-URL: Documentation, https://github.com/redcastle-resources/georest/blob/main/docs/api.md
10
+ Author: Ryan Rock, Ian Housman
11
+ Maintainer-email: RedCastle Resources <ryan.rock@redcastleresources.com>
12
+ License-Expression: Apache-2.0
13
+ License-File: LICENSE
14
+ Keywords: agol,arcgis,edw,esri,feature-service,forest-service,geojson,geospatial,gis,image-service,map-service,portal,rest,usfs
15
+ Classifier: Development Status :: 4 - Beta
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: Intended Audience :: Science/Research
18
+ Classifier: Natural Language :: English
19
+ Classifier: Operating System :: OS Independent
20
+ Classifier: Programming Language :: Python :: 3
21
+ Classifier: Programming Language :: Python :: 3 :: Only
22
+ Classifier: Programming Language :: Python :: 3.9
23
+ Classifier: Programming Language :: Python :: 3.10
24
+ Classifier: Programming Language :: Python :: 3.11
25
+ Classifier: Programming Language :: Python :: 3.12
26
+ Classifier: Programming Language :: Python :: 3.13
27
+ Classifier: Topic :: Internet :: WWW/HTTP
28
+ Classifier: Topic :: Scientific/Engineering :: GIS
29
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
30
+ Classifier: Typing :: Typed
31
+ Requires-Python: >=3.9
32
+ Provides-Extra: dev
33
+ Requires-Dist: build>=1.0; extra == 'dev'
34
+ Requires-Dist: pytest-cov>=4.0; extra == 'dev'
35
+ Requires-Dist: pytest>=7.0; extra == 'dev'
36
+ Requires-Dist: ruff>=0.6; extra == 'dev'
37
+ Requires-Dist: twine>=6.1; extra == 'dev'
38
+ Provides-Extra: examples
39
+ Requires-Dist: ipython>=8.0; extra == 'examples'
40
+ Requires-Dist: jupyterlab>=4.0; extra == 'examples'
41
+ Description-Content-Type: text/markdown
42
+
43
+ # georest
44
+
45
+ Stdlib-only Python clients for geospatial REST APIs — ArcGIS Image, Map and Feature
46
+ Services, the USFS Enterprise Data Warehouse (EDW), and ArcGIS Portal search.
47
+
48
+ **Zero dependencies.** Everything is `urllib` and `json` from the standard library.
49
+ Nothing to resolve, nothing to pin, nothing to break — it installs cleanly into an
50
+ ArcGIS Pro `arcgispro-py3` clone, a locked-down agency environment, or a bare
51
+ `python:slim` container.
52
+
53
+ ```bash
54
+ pip install georest
55
+ ```
56
+
57
+ ## Quick start
58
+
59
+ ```python
60
+ from georest.restesri import edw, portal, services
61
+
62
+ # Search the USFS EDW catalog by keyword or theme
63
+ hits = edw.search_edw_services("fire")
64
+
65
+ # Pull features as GeoJSON (layer 63 = "Burned Area Boundaries (All Years)")
66
+ geojson = edw.query_features(
67
+ "EDW_MTBS_01", 63,
68
+ where="fire_name LIKE '%CAMERON PEAK%'",
69
+ out_fields="fire_name,acres,year",
70
+ )
71
+
72
+ # Search any ArcGIS Portal — IIPP, ArcGIS Online, USGS, NOAA, USFS, NASA,
73
+ # or any ArcGIS Enterprise install
74
+ results = portal.searchPortal("naip 2023", portal="agol")
75
+
76
+ # Generic ArcGIS service operations
77
+ tile_url = services.getImageServiceTileUrl("https://.../ImageServer")
78
+ ```
79
+
80
+ The three modules are also re-exported at the top level, so `from georest import edw`
81
+ works too. They load lazily, so `import georest` costs almost nothing.
82
+
83
+ ## Layout
84
+
85
+ | Import path | What it covers |
86
+ |---|---|
87
+ | `georest.restesri.edw` | USFS EDW: catalog search, layer-role tagging, FGDC/ISO metadata, feature and analytic queries |
88
+ | `georest.restesri.portal` | ArcGIS Portal search and service metadata |
89
+ | `georest.restesri.services` | Generic Image/Map/Feature Service queries and raster operations |
90
+
91
+ `restesri` is the Esri/ArcGIS provider. It sits under `georest` as a subpackage so
92
+ other REST providers can be added alongside it without a namespace collision.
93
+
94
+ Full per-function reference: **[docs/api.md](docs/api.md)**.
95
+ Runnable notebooks: **[examples/](examples/)**.
96
+
97
+ ## Maintenance tool
98
+
99
+ ```bash
100
+ georest-check-themes # report drift vs. the live EDW catalog
101
+ georest-check-themes --emit # + paste-ready _SERVICE_THEMES entries
102
+ ```
103
+
104
+ `edw._SERVICE_THEMES` is hand-curated and powers theme filtering and description
105
+ matching. EDW publishes and retires services without notice, so the table rots
106
+ quietly — an untyped service still appears in search results, but as theme
107
+ `uncategorized` with no description for keyword matching to reach. Exit status is
108
+ 0 in sync, 1 drifted, 2 unreachable.
109
+
110
+ ## Migrating from RESTesri
111
+
112
+ This package was previously a loose `RESTesri/` directory that worked only when the
113
+ repository root happened to be on `sys.path`. Update imports:
114
+
115
+ ```python
116
+ from RESTesri import edw # before
117
+ from georest.restesri import edw # after
118
+
119
+ from RESTesri._http import fetch_json # before
120
+ from georest.restesri._http import fetch_json # after
121
+ ```
122
+
123
+ Then delete any `sys.path.insert(...)` bootstrap — `pip install georest` (or
124
+ `pip install -e .` from a clone) makes it unnecessary.
125
+
126
+ ## Development
127
+
128
+ ```bash
129
+ git clone https://github.com/redcastle-resources/georest
130
+ cd georest
131
+ pip install -e ".[dev]"
132
+
133
+ python -m pytest # or: python -m unittest discover -s tests -t .
134
+ EDW_LIVE=1 SERVICES_LIVE=1 python -m pytest # include the network tests
135
+ ```
136
+
137
+ This is a `src/` layout, so `pip install -e .` is required before the tests can
138
+ import the package — that is deliberate. It makes the suite import the installed
139
+ artifact rather than the source directory, so a packaging mistake fails loudly
140
+ instead of being masked by the working directory.
141
+
142
+ Live tests skip rather than fail when the servers are unreachable; EDW
143
+ intermittently answers 404, 500, `Layer not found`, or 200-with-no-layers for
144
+ services that work moments later. See [tests/README.md](tests/README.md) and
145
+ [CONTRIBUTING.md](CONTRIBUTING.md).
146
+
147
+ ## Requirements
148
+
149
+ Python 3.9 or newer. The 3.9 floor is deliberate: ArcGIS Pro 3.0–3.2 ships Python
150
+ 3.9, and that is squarely this library's audience.
151
+
152
+ ## License
153
+
154
+ Apache License 2.0 — see [LICENSE](LICENSE).
155
+
156
+ `portal.py` and `services.py` were ported from
157
+ [geeViz](https://github.com/gee-community/geeViz)'s `esriLib.py`, with the
158
+ viewer-rendering functions removed; these modules fetch data rather than render it.