Merge #39

39: specify versions for all dependencies r=michaelmattig a=ChristianBeilschmidt



Co-authored-by: Christian Beilschmidt <[email protected]>

Author: bors[bot]

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday" # to be checked before Monday

.github/workflows/ci.yml

@@ -30,17 +30,22 @@ jobs:
       - name: Install build dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
           pip install -e .
+          pip install -e .[dev]
       - name: Check Formatting
         run: |
           python -m pycodestyle
-      - name: Linter
+      - name: Lint code
         run: |
           python -m pylint geoengine
-          python -m pylint tests
       - name: Build
         run: python -m build .
+      - name: Install test dependencies
+        run: |
+          pip install -e .[test]
+      - name: Lint tests
+        run: |
+          python -m pylint tests
       - name: Test
         run: pytest
       # - name: Publish

.github/workflows/docs.yml

@@ -26,8 +26,8 @@ jobs:
       - name: Install build dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
           pip install -e .
+          pip install -e .[dev]
 
       - name: Generate Python Docs
         run: pdoc --html --output-dir docs geoengine

README.md

@@ -10,8 +10,8 @@ Create a virtual environment (e.g., `python3 -m venv env`).
 Then, install the dependencies with:
 
 ```bash
-python3 -m pip install -r requirements.txt
 python3 -m pip install -e .
+python3 -m pip install -e .[test]
 ```
 
 Run tests with:
@@ -38,7 +38,7 @@ sudo apt-get install libgeos-dev libproj-dev
 You can build the package with:
 
 ```bash
-python3 -m pip install --upgrade build
+python3 -m pip install -e .[dev]
 python3 -m build
 ```
 
@@ -74,6 +74,15 @@ Generate documentation HTML with:
 pdoc3 --html --output-dir docs geoengine
 ```
 
+## Examples
+
+There are several examples in the `examples` folder.
+It is necessary to install the dependencies with:
+
+```bash
+python3 -m pip install -e .[examples]
+```
+
 ## Distribute to PyPI
 
 ### Test-PyPI

requirements.txt

@@ -6,7 +6,7 @@ author_email = [email protected]
 description = A package for easy access to Geo Engine instances
 long_description = file: README.md
 long_description_content_type = text/markdown
-url = https://www.geoengine.de
+url = https://github.com/geo-engine/geoengine-python
 project_urls =
     Bug Tracker = https://github.com/geo-engine/geoengine-python
 classifiers =
@@ -18,15 +18,34 @@ package_dir =
 packages = find:
 python_requires = >=3.7
 install_requires =
-    geopandas
-    numpy
-    owslib
-    pillow
-    python-dotenv
-    rasterio
-    requests
-    vega
-    xarray
+    geopandas >=0.9,<0.11
+    numpy >=1.21,<2
+    owslib >=0.25,<0.26
+    pillow >=9.0,<10
+    python-dotenv >=0.19,<0.20
+    rasterio >=1.2,<2
+    requests >= 2.26,<3
+    vega >= 3.5,<4
+    xarray >=0.19,<0.20
+
+[options.extras_require]
+dev =
+    build >=0.7,<0.8
+    pdoc3 >=0.10,<0.11
+    pycodestyle >=2.8,<3 # formatter
+    pylint >=2.11,<3 # code linter
+    setuptools >=42,<61
+    twine >=3.4,<4 # PyPI
+    wheel >=0.37,<0.38
+test =
+    matplotlib >=3.4,<4
+    pytest >=6.2,<7
+    requests_mock >=1.9,<2
+examples =
+    cartopy==0.19.0.post1  # for WMS example
+    matplotlib >=3.4,<4
+    scipy >=1.7,<2 # for WMS example
+
 
 [options.packages.find]
 where = .