move to github pages etc.

Author: soodoku

.github/workflows/python-app.yml .github/workflows/ci.yml.github/workflows/python-app.yml renamed to .github/workflows/ci.yml

@@ -1,7 +1,4 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
-name: Python application
+name: CI
 
 on:
   push:
@@ -13,27 +10,36 @@ permissions:
   contents: read
 
 jobs:
-  build:
-
+  test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.11"
+        python-version: ${{ matrix.python-version }}
+    
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest
+        pip install flake8 pytest pylint
         pip install -e .
+    
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    
+    - name: Lint with pylint
+      run: |
+        pylint $(git ls-files '*.py')
+    
     - name: Test with pytest
       run: |
-        pytest
+        pytest

.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ "public" ]
+  pull_request:
+    branches: [ "public" ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[docs]"
+    
+    - name: Setup Pages
+      id: pages
+      uses: actions/configure-pages@v5
+    
+    - name: Build documentation
+      run: |
+        cd docs
+        make html
+    
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs/_build/html
+
+  deploy:
+    # Only deploy on pushes to main branch, not on PRs
+    if: github.ref == 'refs/heads/public' && github.event_name == 'push'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/pylint.yml

@@ -20,17 +20,17 @@ jobs:
       id-token: write  # required for trusted publishing
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
 
-      - name: Install build & publish tools
+      - name: Install build tools
         run: |
           python -m pip install --upgrade pip
-          pip install build twine
+          pip install build
 
       - name: Build package
         run: |

.github/workflows/python-publish.yml

@@ -7,6 +7,21 @@
 project.
 """
 
+from pathlib import Path
+try:
+    import tomllib
+except ImportError:
+    import tomli as tomllib
+
+# Read project metadata from pyproject.toml
+project_root = Path(__file__).parent.parent
+pyproject_path = project_root / "pyproject.toml"
+
+with open(pyproject_path, "rb") as f:
+    pyproject_data = tomllib.load(f)
+
+project_meta = pyproject_data["project"]
+
 # -- General configuration ------------------------------------------------
 
 extensions = ["sphinx.ext.autodoc"]
@@ -17,12 +32,13 @@
 
 MASTER_DOC = "index"
 
-PROJECT = "Geo sampling"
-COPYRIGHT_INFO = "2016--2025, Suriyan Laohaprapanon, Gaurav Sood"
-AUTHOR = "Suriyan Laohaprapanon, Gaurav Sood"
+PROJECT = project_meta["name"].replace("-", " ").title()
+AUTHORS = ", ".join([author["name"] for author in project_meta["authors"]])
+COPYRIGHT_INFO = f"2016--2025, {AUTHORS}"
+AUTHOR = AUTHORS
 
-VERSION = "0.2.1"
-RELEASE = "0.2.1"
+VERSION = project_meta["version"]
+RELEASE = project_meta["version"]
 
 LANGUAGE = None
 

docs/conf.py

@@ -413,7 +413,7 @@ def bbbike_submit_extract_link(args):
     Returns:
         bool: True if submission is successful, False otherwise.
     """
-    response = requests.get(args.bbbike_url + "&submit=1")
+    response = requests.get(args.bbbike_url + "&submit=1", timeout=30)
     if response.status_code == 200:
         print("Extract link submitted")
         return True
@@ -434,7 +434,8 @@ def bbbike_check_download_link(args):
     while wait_time < BBBIKE_MAX_WAIT:
         try:
             response = requests.get(
-                "https://download.bbbike.org/osm/extract/?date=all"
+                "https://download.bbbike.org/osm/extract/?date=all",
+                timeout=30
             )
             if response.status_code == 200:
                 soup = BeautifulSoup(response.text, "html.parser")

geo_sampling/geo_roads.py

@@ -36,7 +36,8 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = ["check-manifest"]
-test = ["coverage"]
+test = ["coverage", "pytest"]
+docs = ["sphinx>=4.0", "sphinx_rtd_theme", "tomli>=1.2.0;python_version<'3.11'"]
 
 [project.urls]
 Homepage = "https://github.com/geosensing/geo_sampling"