REST feature layer extractor

.github/workflows/ci.yml → .github/workflows/push.yml

@@ -1,4 +1,4 @@
-name: Build and Test
+name: Push Events
 
 on: [push, pull_request]
 
@@ -23,7 +23,7 @@ jobs:
       uses: actions/checkout@v2
 
     - name: Install module
-      run: pip install .[tests]
+      run: pip install .[tests,nopro]
 
     - name: Test with pytest
       run: pytest

.github/workflows/release.yml

@@ -38,3 +38,13 @@ jobs:
         with:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: 🔔 Create deployment notification
+        uses: agrc/service-now-worknote-action@v1
+        with:
+          repo-token: ${{ github.token }}
+          username: ${{ secrets.SN_USERNAME }}
+          password: ${{ secrets.SN_PASSWORD }}
+          instance-name: ${{ secrets.SN_INSTANCE }}
+          table-name: ${{ secrets.SN_TABLE }}
+          system-id: ${{ secrets.SN_SYS_ID }}

README.md

@@ -68,3 +68,15 @@ Now that you've got the token string, you can build the status query:
 `https://services1.arcgis.com/<unique string>/arcgis/rest/services/<feature layer name>/FeatureServer/<layer id>/append/jobs/<job guid>?f=json&<token from agol>`
 
 Calling this URL in a browser should return a message that will hopefully give you more info as to why it failed.
+
+### Updating Docs
+
+palletjack uses `pdoc` to generate HTML docs in `docs/palletjack` from the docstrings within the code itself. These are then served up via github pages.
+
+The github pages are served from the `gh-pages` branch. After you make edits to the code and update the docstrings, rebase this branch onto the updated `main` branch. To prevent github pages from trying to generate a site from the contents of `docs/palletjack` with jekyll, add a `.nojekyll` file to `docs/palletjack`.
+
+To generate the docs, run `pdoc --html -o docs\ c:\palletjack\repo\src\palletjack --force`. The code's docstrings should be Google-style docstrings with proper indentation to ensure the argument lists, etc are parsed and displayed correctly.
+
+`docs/README.md` is included at the top package level by adding the line `.. include:: ../../docs/README.md` in `__init__.py`'s docstring. This tells pdoc to insert that markdown into the HTML generated for that docstring, and the include directive can be used for more in-depth documentation anywhere else as well. Note that `pdoc` tries to create links for anything surrounded by backticks, which are also used for coad blocks. You may need to manually edit the HTML to remove the links if they change the content of your code blocks (such as in the example import statement).
+
+Once the contents of `docs/palletjack` look correct, force push the `gh-pages` branch to github. This will trigger the action to republish the site. The docs are then accessible at [agrc.github.io/palletjack/palletjack/index.html].

docs/examples.py

@@ -1,3 +1,5 @@
+import logging
+import sys
 from pathlib import Path
 from tempfile import TemporaryDirectory
 

setup.py

@@ -15,7 +15,7 @@
 setup(
     name='ugrc-palletjack',
     version=version['__version__'],
-    description='Updating AGOL feature services with data from SFTP shares.',
+    description='Updating AGOL feature services with data from external tables.',
     long_description=(Path(__file__).parent / 'README.md').read_text(),
     long_description_content_type='text/markdown',
     author='Jake Adams, UGRC',
@@ -44,9 +44,16 @@
         'SQLAlchemy==1.4.*',
         'pg8000==1.29.*',
         'psycopg2-binary==2.9.*',
-        'numpy==1.23.*',  #: Pinned to 1.23.* to fix "module 'numpy' has no attribute 'str'" error
+        'numpy<=1.23.5',  #: Pinned to < 1.24 to fix "module 'numpy' has no attribute 'str'" error
     ],
     extras_require={
+        'nopro': [
+            #: pinned versions to avoid backtracking if pro (and thus arcgis) aren't already installed
+            'jupyterlab==3.6.5',
+            'jupyter-server==1.24.0',
+            'ipykernel==6.24.0',
+            'ypy-websocket==0.8.2'
+        ],
         'tests': [
             'pylint-quotes==0.2.*',
             'pylint==2.15.*',