raster2poly 0.1.0__tar.gz

raster2poly-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        run: pip install ".[dev]"
+
+      - name: Run tests
+        run: pytest --tb=short -q
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install ruff
+        run: pip install ruff
+
+      - name: Lint
+        run: ruff check src/

raster2poly-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,176 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+a[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+b[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
+
+env:
+  PACKAGE_NAME: "raster2poly"
+  OWNER: "geoharkat"
+
+jobs:
+  # ── 1. Extract version from git tag ──
+  details:
+    runs-on: ubuntu-latest
+    outputs:
+      new_version: ${{ steps.release.outputs.new_version }}
+      suffix: ${{ steps.release.outputs.suffix }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+      is_prerelease: ${{ steps.release.outputs.is_prerelease }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Extract tag and details
+        id: release
+        run: |
+          if [ "${{ github.ref_type }}" != "tag" ]; then
+            echo "::error::No tag found"
+            exit 1
+          fi
+          TAG_NAME=${GITHUB_REF#refs/tags/}
+          NEW_VERSION=$(echo "$TAG_NAME" | grep -oP '^[0-9]+\.[0-9]+\.[0-9]+')
+          SUFFIX=$(echo "$TAG_NAME" | grep -oP '[a-z]+[0-9]+$' || echo "")
+          IS_PRE=$( [ -n "$SUFFIX" ] && echo "true" || echo "false" )
+
+          echo "new_version=$NEW_VERSION" >> "$GITHUB_OUTPUT"
+          echo "suffix=$SUFFIX"           >> "$GITHUB_OUTPUT"
+          echo "tag_name=$TAG_NAME"       >> "$GITHUB_OUTPUT"
+          echo "is_prerelease=$IS_PRE"    >> "$GITHUB_OUTPUT"
+
+          echo "### Release details" >> "$GITHUB_STEP_SUMMARY"
+          echo "| Key | Value |" >> "$GITHUB_STEP_SUMMARY"
+          echo "|-----|-------|" >> "$GITHUB_STEP_SUMMARY"
+          echo "| Tag | \`$TAG_NAME\` |" >> "$GITHUB_STEP_SUMMARY"
+          echo "| Version | \`$NEW_VERSION\` |" >> "$GITHUB_STEP_SUMMARY"
+          echo "| Suffix | \`${SUFFIX:-none}\` |" >> "$GITHUB_STEP_SUMMARY"
+          echo "| Pre-release | $IS_PRE |" >> "$GITHUB_STEP_SUMMARY"
+
+  # ── 2. Guard: version must be newer than PyPI ──
+  check_pypi:
+    needs: details
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch latest version from PyPI
+        id: pypi
+        run: |
+          RESPONSE=$(curl -sf "https://pypi.org/pypi/${{ env.PACKAGE_NAME }}/json" || echo '{}')
+          LATEST=$(echo "$RESPONSE" | jq -r 'select(.info != null) | .info.version // "0.0.0"')
+          echo "latest=$LATEST" >> "$GITHUB_OUTPUT"
+          echo "Latest PyPI version: $LATEST"
+
+      - name: Compare versions
+        run: |
+          NEW="${{ needs.details.outputs.new_version }}"
+          OLD="${{ steps.pypi.outputs.latest }}"
+          HIGHER=$(printf '%s\n' "$OLD" "$NEW" | sort -V | tail -1)
+          if [ "$HIGHER" = "$OLD" ] && [ "$NEW" != "$OLD" ] || [ "$NEW" = "$OLD" ]; then
+            echo "::error::$NEW is not newer than $OLD on PyPI"
+            exit 1
+          fi
+          echo "$NEW > $OLD ✓"
+
+  # ── 3. Build, test, package ──
+  build:
+    needs: [details, check_pypi]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install build tools
+        run: pip install hatch hatchling build twine
+
+      - name: Install package with dev extras
+        run: pip install ".[dev]"
+
+      - name: Run tests
+        run: pytest --tb=short -q
+
+      - name: Build sdist + wheel
+        if: matrix.python-version == '3.12'
+        run: python -m build
+
+      - name: Verify distributions
+        if: matrix.python-version == '3.12'
+        run: twine check dist/*
+
+      - name: Upload build artifacts
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  # ── 4. Publish to PyPI (trusted publisher) ──
+  pypi_publish:
+    name: Publish to PyPI
+    needs: [build, details]
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/project/${{ env.PACKAGE_NAME }}/${{ needs.details.outputs.new_version }}/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  # ── 5. Create GitHub Release ──
+  github_release:
+    name: GitHub Release
+    needs: [build, details]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Generate changelog
+        id: changelog
+        run: |
+          # Get commits since last tag
+          PREV_TAG=$(git tag --sort=-v:refname | head -2 | tail -1 || echo "")
+          if [ -n "$PREV_TAG" ]; then
+            NOTES=$(git log --pretty=format:"- %s (%h)" "$PREV_TAG"..HEAD)
+          else
+            NOTES=$(git log --pretty=format:"- %s (%h)" HEAD~20..HEAD)
+          fi
+          # Write to file (handles multiline)
+          echo "$NOTES" > /tmp/changelog.md
+          echo "Generated $(echo "$NOTES" | wc -l) changelog entries"
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "${{ needs.details.outputs.tag_name }}" dist/* \
+            --title "v${{ needs.details.outputs.tag_name }}" \
+            --notes-file /tmp/changelog.md \
+            ${{ needs.details.outputs.is_prerelease == 'true' && '--prerelease' || '' }}

raster2poly-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

raster2poly-0.1.0/.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

raster2poly-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ismail Harkat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

raster2poly-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: raster2poly
+Version: 0.1.0
+Summary: Classify rasters (KMeans, Random Forest, DN rules) and vectorise to polygons.
+Project-URL: Homepage, https://github.com/geoharkat/raster2poly
+Project-URL: Documentation, https://raster2poly.readthedocs.io
+Project-URL: Issues, https://github.com/geoharkat/raster2poly/issues
+Author: Ismail Harkat
+License-Expression: MIT
+License-File: LICENSE
+Keywords: classification,geospatial,polygons,raster,remote-sensing,vectorise
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.9
+Requires-Dist: geopandas>=0.12
+Requires-Dist: numpy>=1.22
+Requires-Dist: rasterio>=1.3
+Requires-Dist: scikit-learn>=1.2
+Requires-Dist: shapely>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: myst-parser>=2.0; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# raster2poly
+
+**Classify rasters and vectorise the result to clean polygons** — in three lines of code.
+
+Supports unsupervised clustering (KMeans), supervised classification
+(Random Forest from ROI shapefiles), and rule-based DN thresholds.
+Outputs are dissolved, filtered GeoDataFrames ready for GIS.
+
+## Installation
+
+```bash
+pip install raster2poly
+```
+
+## Quick start
+
+### Unsupervised (KMeans)
+
+```python
+from raster2poly import RasterClassifier
+
+clf = RasterClassifier("satellite_image.tif")
+gdf = clf.unsupervised(n_clusters=6, algorithm="mini_batch_kmeans")
+clf.save(gdf, "classes.gpkg")
+```
+
+### Supervised (ROI shapefile)
+
+```python
+gdf = clf.supervised("training_rois.shp", class_col="class_id")
+clf.save(gdf, "supervised.shp")
+```
+
+The ROI file can contain **Points or Polygons** (or both).
+For polygons, every pixel inside the geometry is used as a training
+sample — far more robust than a single zonal mean.
+
+### Rule-based (DN ranges)
+
+```python
+rules = {
+    1: [(4, 0.15, 1.0), (5, 0.0, 0.10)],  # high Red, low NIR → built-up
+    2: [(5, 0.25, 1.0)],                     # high NIR → vegetation
+}
+gdf = clf.from_dn_ranges(rules)
+```
+
+Band numbers are **1-based**.  A pixel must satisfy *all* conditions
+in the list to be assigned that class.
+
+## Key improvements over the original script
+
+| Issue in original | Fix |
+|---|---|
+| `point_query` returns wrong shape for multi-band | Replaced with per-pixel rasterised extraction |
+| Only zonal *mean* used for polygon ROIs | Every pixel inside the polygon is a training sample |
+| Hardcoded `'class'` column name | Configurable `class_col` parameter |
+| No polygon dissolve — millions of tiny fragments | `dissolve=True` by default, plus `min_area` filter |
+| `rasterstats` dependency for simple ops | Replaced with `rasterio.features.geometry_mask` |
+| No CRS check on ROI shapefile | Auto-reprojects vector → raster CRS |
+| Output always Shapefile | Auto-detects `.shp` / `.gpkg` / `.geojson` |
+| No nodata → NaN conversion | Nodata replaced with NaN on load, masked throughout |
+
+## Output format
+
+The returned `GeoDataFrame` has two columns:
+
+- `class_id` (int) — the class label
+- `geometry` — dissolved polygons
+
+Save to any format: `.shp`, `.gpkg`, `.geojson`.
+
+## License
+
+MIT

raster2poly-0.1.0/README.md

@@ -0,0 +1,75 @@
+# raster2poly
+
+**Classify rasters and vectorise the result to clean polygons** — in three lines of code.
+
+Supports unsupervised clustering (KMeans), supervised classification
+(Random Forest from ROI shapefiles), and rule-based DN thresholds.
+Outputs are dissolved, filtered GeoDataFrames ready for GIS.
+
+## Installation
+
+```bash
+pip install raster2poly
+```
+
+## Quick start
+
+### Unsupervised (KMeans)
+
+```python
+from raster2poly import RasterClassifier
+
+clf = RasterClassifier("satellite_image.tif")
+gdf = clf.unsupervised(n_clusters=6, algorithm="mini_batch_kmeans")
+clf.save(gdf, "classes.gpkg")
+```
+
+### Supervised (ROI shapefile)
+
+```python
+gdf = clf.supervised("training_rois.shp", class_col="class_id")
+clf.save(gdf, "supervised.shp")
+```
+
+The ROI file can contain **Points or Polygons** (or both).
+For polygons, every pixel inside the geometry is used as a training
+sample — far more robust than a single zonal mean.
+
+### Rule-based (DN ranges)
+
+```python
+rules = {
+    1: [(4, 0.15, 1.0), (5, 0.0, 0.10)],  # high Red, low NIR → built-up
+    2: [(5, 0.25, 1.0)],                     # high NIR → vegetation
+}
+gdf = clf.from_dn_ranges(rules)
+```
+
+Band numbers are **1-based**.  A pixel must satisfy *all* conditions
+in the list to be assigned that class.
+
+## Key improvements over the original script
+
+| Issue in original | Fix |
+|---|---|
+| `point_query` returns wrong shape for multi-band | Replaced with per-pixel rasterised extraction |
+| Only zonal *mean* used for polygon ROIs | Every pixel inside the polygon is a training sample |
+| Hardcoded `'class'` column name | Configurable `class_col` parameter |
+| No polygon dissolve — millions of tiny fragments | `dissolve=True` by default, plus `min_area` filter |
+| `rasterstats` dependency for simple ops | Replaced with `rasterio.features.geometry_mask` |
+| No CRS check on ROI shapefile | Auto-reprojects vector → raster CRS |
+| Output always Shapefile | Auto-detects `.shp` / `.gpkg` / `.geojson` |
+| No nodata → NaN conversion | Nodata replaced with NaN on load, masked throughout |
+
+## Output format
+
+The returned `GeoDataFrame` has two columns:
+
+- `class_id` (int) — the class label
+- `geometry` — dissolved polygons
+
+Save to any format: `.shp`, `.gpkg`, `.geojson`.
+
+## License
+
+MIT