initial commit

Author: knu2xs

.bumpversion.cfg

@@ -0,0 +1,26 @@
+[bumpversion]
+current_version = 0.0.0
+commit = True
+tag = False
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<build>\d+))?
+serialize = 
+	{major}.{minor}.{patch}.{release}{build}
+	{major}.{minor}.{patch}
+
+[bumpversion:part:release]
+optional_value = prod
+first_value = dev
+values = 
+	dev
+	prod
+
+[bumpversion:part:build]
+
+[bumpversion:file:VERSION]
+
+[bumpversion:file:./pyproject.toml]
+
+[bumpversion:file:./src/overture_to_arcgis/__init__.py]
+
+[bumpversion:file:./docsrc/mkdocs.yml]
+[bumpversion:file:./docsrc/mkdocs/index.md]

.github/workflows/make-mkdocs.yml

@@ -0,0 +1,82 @@
+name: Make docs using MkDocs
+
+on:
+
+  # when any pushes are made to any branch with changes to the source, notebooks or docs directory
+  push:
+    branches:
+      - main
+    paths:
+      - "src/**/*.py"
+#      - "notebooks/**/*.ipynb"
+      - "docsrc/**/*"
+      - ".github/workflows/**/*"
+
+  # test workflow as well...
+  workflow_dispatch:
+
+# allow one concurrent deployment
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+
+  build:
+
+    # run on linux since simplest environment and no operating system dependencies are required
+    runs-on: ubuntu-latest
+
+    steps:
+
+    # get the repo contents
+    - uses: actions/checkout@v4
+
+    # Install Python
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+
+    # install python packages
+    - name: Install Python Packages
+      run: pip install -r docsrc/requirements.txt
+
+    # build docs
+    - name: Build Documentation using MkDocs
+      run: mkdocs build -f docsrc/mkdocs.yml
+
+    # ensure permissions correctly configured
+    - name: Check Permissions
+      run: |
+        chmod -c -R +rX "docs/" | while read line; do
+          echo "::warning title=Invalid file permissions automatically fixed::$line"
+        done
+
+    # upload docs directory
+    - uses: actions/upload-pages-artifact@v4
+      with:
+        # Upload contents of docs directory
+        path: "docs"
+
+  deploy:
+
+    # wait for build before running
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,97 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+**/*.egg-info/
+.installed.cfg
+**/*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+**/*.tox/
+**/*.coverage
+**/*.coverage.*
+**/*.cache
+**/*nosetests.xml
+**/*coverage.xml
+**/*.cover
+**/*.pytest_cache
+
+# Translations
+**/*.mo
+**/*.pot
+
+# Django stuff:
+**/*.log
+
+# Sphinx documentation
+docsrc/_build/
+docsrc/build/
+
+# PyBuilder
+target/
+
+# configuration files
+**/secrets.ini
+.env
+
+# Database
+**/*.db
+**/*.rdb
+
+# Pycharm
+.idea
+
+# VS Code
+.vscode/
+
+# Spyder
+.spyproject/
+
+# Jupyter NB Checkpoints
+.ipynb_checkpoints/
+
+# exclude data from source control by default
+data/
+models/
+
+# Mac OS-specific storage files
+**/*.DS_Store
+
+# ignore the caches created for ArcMap
+arcgis/Index
+arcgis/ImportLog
+arcgis/.backups
+
+# make sure the environment is not included
+env/
+
+# exclude the docs build directory
+docs/