qgis-project 0.0.2__tar.gz

qgis_project-0.0.2/.github/workflows/publish.yml

@@ -0,0 +1,49 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Build package
+        run: |
+          rm -rf dist/
+          hatch build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/qgis-project
+    permissions:
+      id-token: write  # required for Trusted Publisher (OIDC)
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

qgis_project-0.0.2/.github/workflows/test.yml

@@ -0,0 +1,65 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  # Fast job: tests that don't require QGIS (imports, dataclasses, utilities).
+  # Runs on standard GitHub runners with plain pip.
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package with dev dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        # -p no:qgis: don't load pytest-qgis even if somehow installed;
+        # it imports qgis at plugin load time and would crash without QGIS.
+        run: pytest tests/ -v --tb=short -m "not qgis" -p no:qgis
+
+  # Slow job: full integration tests using a conda QGIS environment.
+  # Triggered manually or on pushes to main; allowed to fail until
+  # a stable QGIS test suite is established.
+  test-qgis:
+    name: Test with QGIS (conda)
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          environment-file: environment_platform_independent.yml
+          activate-environment: qgis-env-pi
+          auto-activate-base: false
+
+      - name: Install package into QGIS environment
+        shell: bash -el {0}
+        run: pip install -e ".[dev,qgis-dev]"
+
+      - name: Configure QGIS PYTHONPATH
+        shell: bash -el {0}
+        run: |
+          echo "PYTHONPATH=$CONDA_PREFIX/share/qgis/python:$CONDA_PREFIX/share/qgis/python/plugins:$PYTHONPATH" >> $GITHUB_ENV
+          echo "QT_QPA_PLATFORM=offscreen" >> $GITHUB_ENV
+
+      - name: Run QGIS tests
+        shell: bash -el {0}
+        run: pytest tests/ -v --tb=short -m "qgis"
+        continue-on-error: true

qgis_project-0.0.2/.gitignore

@@ -0,0 +1,7 @@
+.vscode
+**/__pycache__/**
+
+dump.py
+dist/
+# generated by hatch-vcs at build/install time
+src/qgis_project/__about__.py

qgis_project-0.0.2/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

qgis_project-0.0.2/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025-present Colin Moldenhauer <colin.moldenhauer@posteo.de>
+
+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.

qgis_project-0.0.2/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: qgis-project
+Version: 0.0.2
+Summary: Create QGIS projects programmatically using Python
+Project-URL: Documentation, https://github.com/ColinMoldenhauer/qgis-project#readme
+Project-URL: Issues, https://github.com/ColinMoldenhauer/qgis-project/issues
+Project-URL: Source, https://github.com/ColinMoldenhauer/qgis-project
+Author-email: Colin Moldenhauer <colin.moldenhauer@posteo.de>
+License-Expression: MIT
+License-File: LICENSE.txt
+Keywords: cartography,geospatial,gis,mapping,qgis
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.9
+Requires-Dist: loguru
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material; extra == 'docs'
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
+Provides-Extra: qgis-dev
+Requires-Dist: pytest-qgis; extra == 'qgis-dev'
+Description-Content-Type: text/markdown
+
+# qgis-project
+
+Create QGIS projects programmatically using Python.
+
+```python
+from qgis_project import Project, RasterLayer, RasterStyleBW
+
+proj = Project()
+proj.add_layer("dem.tif")                                    # raster, auto-detected
+proj.add_layer("boundaries.geojson")                         # vector, auto-detected
+proj.add_layer(RasterLayer("dem.tif", style=RasterStyleBW(vmin=0, vmax=3000)))
+proj.save("output.qgz")
+proj.open()     # launch QGIS for visual inspection
+```
+
+
+## Installation
+
+Install the package:
+
+```bash
+pip install qgis-project
+```
+
+QGIS is not on PyPI and must be available separately. The recommended approach is a dedicated conda environment:
+
+```bash
+conda env create -f environment_platform_independent.yml
+conda activate qgis-env-pi
+pip install qgis-project
+```
+
+Or install QGIS from conda-forge into an existing environment:
+
+```bash
+conda install -c conda-forge qgis
+pip install qgis-project
+```
+
+> **Note:** All QGIS imports are lazy — `import qgis_project` works without QGIS installed. Errors only surface when a QGIS-backed method is actually called.
+
+
+## Usage
+
+### Basic project
+
+```python
+from qgis_project import Project
+
+proj = Project()
+proj.add_layer("dem.tif")
+proj.add_layer("roads.geojson")
+proj.save("my_project.qgz")
+proj.exit()
+```
+
+### Layer groups
+
+```python
+proj.add_layer(RasterLayer("dem.tif", group="terrain"))
+proj.add_layer(RasterLayer("slope.tif", group=["terrain", "derived"]))
+```
+
+### Raster styling
+
+```python
+from qgis_project import RasterLayer, RasterStyleBW
+
+layer = RasterLayer(
+    file="dem.tif",
+    name="Elevation",
+    group="terrain",
+    style=RasterStyleBW(vmin=0, vmax=3000),
+)
+proj.add_layer(layer)
+```
+
+### Open in QGIS
+
+```python
+proj.open("output.qgz")      # saves and launches QGIS
+proj.print_layer_tree()      # inspect the layer tree in the terminal
+```
+
+
+## Development
+
+Install with dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Run unit tests (no QGIS required):
+
+```bash
+pytest -m "not qgis"
+```
+
+Run integration tests (QGIS environment required):
+
+```bash
+pytest -m qgis
+```
+
+Run the manual visual test:
+
+```bash
+python scripts/manual_test.py
+```

qgis_project-0.0.2/README.md

@@ -0,0 +1,110 @@
+# qgis-project
+
+Create QGIS projects programmatically using Python.
+
+```python
+from qgis_project import Project, RasterLayer, RasterStyleBW
+
+proj = Project()
+proj.add_layer("dem.tif")                                    # raster, auto-detected
+proj.add_layer("boundaries.geojson")                         # vector, auto-detected
+proj.add_layer(RasterLayer("dem.tif", style=RasterStyleBW(vmin=0, vmax=3000)))
+proj.save("output.qgz")
+proj.open()     # launch QGIS for visual inspection
+```
+
+
+## Installation
+
+Install the package:
+
+```bash
+pip install qgis-project
+```
+
+QGIS is not on PyPI and must be available separately. The recommended approach is a dedicated conda environment:
+
+```bash
+conda env create -f environment_platform_independent.yml
+conda activate qgis-env-pi
+pip install qgis-project
+```
+
+Or install QGIS from conda-forge into an existing environment:
+
+```bash
+conda install -c conda-forge qgis
+pip install qgis-project
+```
+
+> **Note:** All QGIS imports are lazy — `import qgis_project` works without QGIS installed. Errors only surface when a QGIS-backed method is actually called.
+
+
+## Usage
+
+### Basic project
+
+```python
+from qgis_project import Project
+
+proj = Project()
+proj.add_layer("dem.tif")
+proj.add_layer("roads.geojson")
+proj.save("my_project.qgz")
+proj.exit()
+```
+
+### Layer groups
+
+```python
+proj.add_layer(RasterLayer("dem.tif", group="terrain"))
+proj.add_layer(RasterLayer("slope.tif", group=["terrain", "derived"]))
+```
+
+### Raster styling
+
+```python
+from qgis_project import RasterLayer, RasterStyleBW
+
+layer = RasterLayer(
+    file="dem.tif",
+    name="Elevation",
+    group="terrain",
+    style=RasterStyleBW(vmin=0, vmax=3000),
+)
+proj.add_layer(layer)
+```
+
+### Open in QGIS
+
+```python
+proj.open("output.qgz")      # saves and launches QGIS
+proj.print_layer_tree()      # inspect the layer tree in the terminal
+```
+
+
+## Development
+
+Install with dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Run unit tests (no QGIS required):
+
+```bash
+pytest -m "not qgis"
+```
+
+Run integration tests (QGIS environment required):
+
+```bash
+pytest -m qgis
+```
+
+Run the manual visual test:
+
+```bash
+python scripts/manual_test.py
+```