Merge pull request #6 from nextmv-io/merschformann/fix-links

Fixes broken links

Author: merschformann

.github/workflows/build.yml

@@ -8,7 +8,9 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                python-version: ["3.10", "3.11", "3.12"]
+                # Tests are currently stable only for python 3.11
+                # due to the way we are testing
+                python-version: ["3.11"]
         steps:
             - uses: actions/checkout@v4
 

README.md

@@ -125,16 +125,16 @@ Then, add the following line to your `~/.bashrc`:
 eval "$(register-python-argcomplete nextplot)"
 ```
 
-## Development setup
+## Tests
 
-### Install development dependencies
+Tests are located in `tests/` and can be run via `python -m pytest`. Update test
+expectations (golden files) by running `UPDATE=1 python test_cli.py` from the
+test directory. Tests require specific versions of the dependencies to be
+installed. These can be installed via `pip install -r requirements-dev.txt`.
+It is recommended to update the expectations in a docker container to avoid
+messing up local dependencies. This can be done by running the following
+commands:
 
 ```bash
-pip install -r requirements-dev.txt
+docker run --rm -it -v $(pwd):/app -w /app python:3.11 bash -c "pip install -r requirements-dev.txt && cd tests && UPDATE=1 python test_cli.py"
 ```
-
-### Tests
-
-Tests are located in `tests/` and can be run via `python -m pytest`. Update test
-expectations (golden files) by running `UPDATE=1 python test_cli.py` from the
-test directory.

examples/README.md

@@ -252,7 +252,7 @@ handle certain data formats. Find an outline of these options here:
   (more details) and CartoDB Dark Matter (black to focus colored
   routes/cluster). Additional custom map tiles can be added via
   `--custom_map_tile [CUSTOM_MAP_TILE]`. An overview can be found here:
-  https://deparkes.co.uk/2016/06/10/folium-map-tiles/
+  [folium-tiles][folium-tiles].
   - Custom tile providers can even be used by supplying them in the format
     `"<tile-url>,<layer-name>,<attribution>"`.
     Example:
@@ -261,7 +261,7 @@ handle certain data formats. Find an outline of these options here:
       --custom_map_tile "https://{s}.basemaps.cartocdn.com/dark_nolabels/{z}/{x}/{y}{r}.png,DarkMatter no labels,OpenStreetMap authors"
       ```
 
-    (an overview of custom tile providers can be found [here](custom-layers))
+    (an overview of custom tile providers can be found [here][custom-layers])
 - `--jpath_x` & `--jpath_y`:
   `nextplot` expects to find arrays of points or indices, if a path like
   `state.drivers[*].geometry.coordinates` is given. I.e., either
@@ -300,9 +300,9 @@ handle certain data formats. Find an outline of these options here:
   If provided, statistics will be written to the given file in addition to
   stdout.
 - `rk_bin` (route only):
-  Path to the [go-routingkit](go-rk) standalone binary. Alternatively,
+  Path to the [go-routingkit][go-rk] standalone binary. Alternatively,
   `routingkit` command will be used at default (requires go-routingkit
-  [installation](go-rk-install)).
+  [installation][go-rk-install]).
 - `rk_osm` (route only):
   Path to the OpenStreetMap data file to be used for routing. All points must be
   contained within the region of the file. This file is mandatory when using
@@ -316,3 +316,4 @@ handle certain data formats. Find an outline of these options here:
 [go-rk]: https://github.com/nextmv-io/go-routingkit/tree/stable/cmd/routingkit
 [go-rk-install]: https://github.com/nextmv-io/go-routingkit/tree/stable/cmd/routingkit#install
 [custom-layers]: http://leaflet-extras.github.io/leaflet-providers/preview/
+[folium-tiles]: https://deparkes.co.uk/2016/06/10/folium-map-tiles/

requirements-dev.txt

@@ -1,12 +1,12 @@
-argcomplete>=2.0.0
-colorutils>=0.3.0
-folium>=0.12.1
-jsonpath_ng>=1.5.3
-kaleido>=0.2.1
-numpy>=1.22.3
-plotly>=5.7.0
-scipy>=1.8.0
-pytest>=7.1.1
-imagehash>=4.2.1
-ruff>=0.1.7
-hatch>=1.9.1
+argcomplete==2.0.0
+colorutils==0.3.0
+folium==0.16.0
+jsonpath_ng==1.6.1
+kaleido==0.2.1
+numpy==1.26.4
+plotly==5.21.0
+scipy==1.13.0
+pytest==7.1.1
+imagehash==4.3.1
+ruff==0.1.7
+hatch==1.9.1

tests/testdata/fleet-cloud-comparison.html.golden

@@ -1 +1 @@
-f0f081e3796a039f
+f0f281e3796a031f

tests/testdata/fleet-cloud-comparison.png.golden

@@ -1 +1 @@
-ff2a8536d604d172
+ff228137dc05d172