chore: consolidate history

Author: AmmarYasser455

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    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 dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: |
+          ruff check geoqa/
+
+      - name: Format check with black
+        run: |
+          black --check geoqa/ tests/
+
+      - name: Run tests
+        run: |
+          pytest --cov=geoqa --cov-report=xml
+
+      - name: Upload coverage
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11'
+        uses: codecov/codecov-action@v3
+        with:
+          file: ./coverage.xml

.github/workflows/pages.yml

@@ -0,0 +1,31 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+    paths: [docs/**]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/configure-pages@v5
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,40 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Documentation
+site/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Output
+outputs/
+*.html
+!docs/**/*.html

CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to GeoQA will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1] - 2026-02-12
+
+### Fixed
+- **Security**: Enable Jinja2 autoescape in HTML report generation to prevent XSS when dataset names or attribute values contain HTML/script content. (GeoQA-002 from audit)
+- **UX**: Log a warning when loading files larger than 500 MB or datasets with more than 100,000 features, so users know to expect longer runtimes.
+
+### Added
+- 3 new tests: XSS prevention, special characters in dataset name, and large-file warning validation.
+
+## [0.1.0] - 2026-02-11
+
+### Added
+
+- **Core profiling**: `geoqa.profile()` one-liner for dataset analysis
+- **GeoProfile class**: Complete dataset profiling with quality scoring
+- **Geometry checks**: Validity, empty, null, duplicate, mixed-type detection
+- **Attribute profiling**: Data types, null analysis, statistics, top values
+- **Spatial analysis**: CRS info, bounds, area/length/perimeter statistics
+- **Interactive maps**: Folium-based visualization with quality highlighting
+- **HTML reports**: Self-contained quality reports with Jinja2 templates
+- **CLI interface**: `geoqa profile`, `geoqa report`, `geoqa check`, `geoqa show`
+- **Rich output**: Beautiful terminal output with tables and colors
+- **Quality scoring**: Weighted 0-100 score based on multiple criteria
+- **Format support**: All Fiona/GDAL-supported vector formats
+- **Auto-fix**: `GeometryChecker.fix_invalid()` for geometry repair
+- **Comprehensive docs**: README, CONTRIBUTING, API docs, example notebooks
+- **Test suite**: pytest-based tests for all modules

CONTRIBUTING.md

@@ -0,0 +1,117 @@
+# Contributing to GeoQA
+
+Thank you for your interest in contributing to GeoQA! This document provides guidelines and instructions for contributing.
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+- Python 3.9+
+- Git
+- A code editor (VS Code recommended)
+
+### Development Setup
+
+1. **Fork and clone** the repository:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/geoqa.git
+   cd geoqa
+   ```
+
+2. **Create a virtual environment**:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # Linux/Mac
+   .venv\Scripts\activate     # Windows
+   ```
+
+3. **Install in development mode**:
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+4. **Run tests** to verify setup:
+   ```bash
+   pytest
+   ```
+
+## 📋 Development Workflow
+
+1. **Create a branch** for your work:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make your changes** following the code style guidelines below.
+
+3. **Write tests** for new functionality.
+
+4. **Run the test suite**:
+   ```bash
+   pytest
+   ```
+
+5. **Format your code**:
+   ```bash
+   black geoqa/ tests/
+   isort geoqa/ tests/
+   ```
+
+6. **Commit your changes** with a clear message:
+   ```bash
+   git commit -m "feat: add new quality check for overlapping features"
+   ```
+
+7. **Push and create a Pull Request**.
+
+## 🎨 Code Style
+
+- **Formatter**: Black (line length = 100)
+- **Import sorting**: isort (black profile)
+- **Linter**: Ruff
+- **Type hints**: Required for all public functions
+- **Docstrings**: Google-style docstrings for all public modules, classes, and functions
+
+### Example
+
+```python
+def check_validity(gdf: gpd.GeoDataFrame) -> dict[str, Any]:
+    """Check geometry validity for all features.
+
+    Args:
+        gdf: The GeoDataFrame to validate.
+
+    Returns:
+        Dictionary with valid_count, invalid_count, and invalid_indices.
+
+    Raises:
+        ValueError: If the GeoDataFrame has no geometry column.
+    """
+    ...
+```
+
+## 📝 Commit Messages
+
+Follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+- `feat:` — New feature
+- `fix:` — Bug fix
+- `docs:` — Documentation changes
+- `test:` — Test additions/modifications
+- `refactor:` — Code refactoring
+- `style:` — Formatting changes
+- `chore:` — Build/CI changes
+
+## 🧪 Testing
+
+- Write tests in the `tests/` directory using pytest.
+- Aim for comprehensive coverage of new functionality.
+- Use fixtures for common test data.
+
+## 📜 Code of Conduct
+
+Be respectful and constructive. We follow the [Contributor Covenant](https://www.contributor-covenant.org/) Code of Conduct.
+
+## ❓ Questions?
+
+Open an issue or start a discussion on GitHub. We're happy to help!

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ammar Yasser Abdalazim
+
+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.

LINKEDIN_POST.md

@@ -0,0 +1,71 @@
+# LinkedIn Post — GeoQA Launch
+
+---
+
+## Post Text
+
+I'm excited to share **GeoQA** — an open-source Python package I built for **geospatial data quality assessment and interactive profiling**.
+
+As a GIS developer, I kept running into the same frustrating question: *"Is this geodata good enough to use?"* — and there was no quick, automated way to answer it.
+
+So I built GeoQA.
+
+**What it does:**
+
+- Profiles any vector dataset (Shapefile, GeoJSON, GeoPackage) with a single function call
+- Computes an overall **quality score (0–100)** based on geometry validity, attribute completeness, and CRS
+- Detects **invalid, empty, and duplicate geometries** automatically
+- Generates **interactive web maps** with quality-issue highlighting
+- Produces **self-contained HTML quality reports** with charts, tables, and spatial statistics
+
+**What makes it unique:**
+
+GeoQA is like **ydata-profiling** — but purpose-built for geodata. It understands geometry types, coordinate systems, spatial topology, and the real-world data problems that GIS professionals deal with daily.
+
+**It also powers the pre-check module in OVC (Overlap Violation Checker)** — my other open-source tool for detecting overlapping buildings, road conflicts, and topological errors. Before OVC runs its spatial QC pipeline, GeoQA profiles every input dataset to catch fundamental issues early — missing CRS, invalid geometries, empty features — saving compute time and giving clear diagnostics upfront.
+
+Together, GeoQA + OVC form a **complete geospatial quality control workflow**: GeoQA assesses data readiness, and OVC performs deep spatial validation.
+
+**Who is this for?**
+
+- GIS Analysts validating shapefiles before analysis
+- Urban Planners checking building and road datasets
+- Survey Engineers ensuring geometry integrity
+- Data Engineers building geospatial ETL pipelines
+- Government agencies auditing cadastral and infrastructure data
+- Academic researchers profiling geodata for publications
+- Anyone working with vector geospatial data who wants automated quality checks
+
+Both tools are **free, open-source, and MIT-licensed**.
+
+**Try it:**
+- GeoQA on PyPI: https://pypi.org/project/geoqa/
+- GeoQA on GitHub: https://github.com/AmmarYasser455/geoqa
+- OVC on GitHub: https://github.com/AmmarYasser455/ovc
+
+I'd love to hear your feedback — try it on your own datasets and let me know what you think!
+
+---
+
+## Recommended Media (attach to post)
+
+1. **Screenshot of `profile.summary()`** — the rich-formatted terminal output showing dataset overview, quality score, and geometry checks
+2. **Screenshot of the interactive Folium web map** — showing quality-highlighted features (valid in blue, issues in red)
+3. **Screenshot of the HTML quality report** — the gradient header with quality score badge, overview cards, and charts
+4. **Screenshot of OVC + GeoQA working together** — the pre-check output showing data readiness assessment before QC
+5. **A short GIF or video** (60–90 seconds) showing the full workflow: profile → map → report in Jupyter
+
+> Tip: LinkedIn favors **carousel posts (PDF)** and **native video**. Consider combining 3–4 screenshots into a carousel PDF for higher engagement.
+
+---
+
+## Hashtags
+
+#GIS #Geospatial #Python #OpenSource #DataQuality #GeoQA #OVC
+#GeoPandas #Mapping #SpatialData #GISDev #UrbanPlanning
+#OpenData #DataScience #QualityAssurance #QualityControl
+#SurveyEngineering #DataEngineering #WebMapping #Cartography
+#RemoteSensing #SpatialAnalysis #BuildingData #RoadNetwork
+#GISProfessionals #PythonDev #FOSS4G #Leaflet #Folium
+
+---