refactor(plot)!: put plotting behind a feature flag

Author: tversteeg

README.md

@@ -5,21 +5,26 @@
 [![GitHub stars](https://img.shields.io/github/stars/ritchie46/pygef.svg?logo=github&label=Stars&logoColor=white)](https://github.com/ritchie46/pygef)
 [![Coverage Status](https://coveralls.io/repos/github/cemsbv/pygef/badge.svg?branch=master)](https://coveralls.io/github/cemsbv/pygef?branch=master)
 
-Simple parser for \*.gef files. These are ASCII based files used for soil properties measurements.
-Compatible with Python 3.9.
+Simple parser for \*.gef files. These are ASCII based files used for soil
+properties measurements. Compatible with Python 3.9.
 
-Recently added the parsing of xml boreholes file, the xml parsing is still in a preliminary phase,
-not all the files are supported. If you find a file that doesn't work with pygef, please make an issue about it or PR :)
+Recently added the parsing of xml boreholes file, the xml parsing is still in a
+preliminary phase, not all the files are supported. If you find a file that
+doesn't work with pygef, please make an issue about it or PR :)
 
 ## Installation
 
 Latest stable version:
 
-`$ pip install pygef`
+```sh
+pip install pygef
+```
 
 Cutting-edge version (might break):
 
-`$ pip install git+https://github.com/cemsbv/pygef.git`
+```sh
+pip install git+https://github.com/cemsbv/pygef.git
+```
 
 ## CPT files
 
@@ -116,11 +121,17 @@ tot630u ┆ 0.0,    │
 │            ┆            ┆            ┆          ┆            ┆            ┆            ┆ ...     │
 │            ┆            ┆            ┆          ┆            ┆            ┆            ┆ 0.0]    │
 └────────────┴────────────┴────────────┴──────────┴────────────┴────────────┴────────────┴─────────┘
-
 ```
 
 ## Plotting
 
+To use the plotting functionality pygef needs to be installed with the `[plot]`
+feature.
+
+```sh
+pip install pygef[plot]
+```
+
 ```python
 from pygef import read_cpt, read_bore
 from pygef.plotting import plot_cpt, plot_bore
@@ -157,7 +168,8 @@ isort --settings-path "pyproject.toml" .
 
 To maintain code quality we use the GitHub super-linter.
 
-To run the linters locally, run the following bash script from the root directory:
+To run the linters locally, run the following bash script from the root
+directory:
 
 ```bash
 docker run \
@@ -195,11 +207,11 @@ coverage run -m pytest
 Requirements are autogenerated by `pip-compile` with python 3.9
 
 ```bash
-pip-compile --extra=test --extra=docs --extra=lint --extra=map --output-file=requirements.txt pyproject.toml
+pip-compile --extra=plot --extra=test --extra=docs --extra=lint --extra=map --output-file=requirements.txt pyproject.toml
 ```
 
 To update the requirements within the defined ranges, run:
 
 ```bash
-pip-compile --upgrade --extra=test --extra=docs --extra=lint --extra=map --output-file=requirements.txt pyproject.toml
+pip-compile --upgrade --extra=plot --extra=test --extra=docs --extra=lint --extra=map --output-file=requirements.txt pyproject.toml
 ```

cemsdev.toml

@@ -0,0 +1,3 @@
+[python.env]
+MODULES = "src"
+EXTRA_REQUIREMENTS = "docs --extra=plot --extra=lint --extra=map --extra=test"

pyproject.toml

@@ -8,7 +8,6 @@ version = "0.11.0"
 description = "Parse soil measurument data."
 dependencies = [
     "polars>=1,<2",
-    "matplotlib>=3.6,<4.0",
     "lxml>=5,<6.0",
     "gef-file-to-map>=0.2,<0.3",
 ]
@@ -21,6 +20,9 @@ keywords = ["gef"]
 repository = "https://github.com/cemsbv/pygef"
 
 [project.optional-dependencies]
+plot = [
+    "matplotlib>=3.6,<4.0",
+]
 test = [
     "coveralls",
     "pytest"
@@ -62,13 +64,6 @@ warn_unused_ignores = true
 warn_unused_configs = true
 disallow_subclassing_any = true
 no_implicit_optional = true
-#disallow_untyped_defs = true
-#strict_concatenate = true
-#disallow_any_generics = true
-#disallow_untyped_calls = true
-#warn_return_any = true
-#no_implicit_reexport = true
-#strict_equality = true
 
 [[tool.mypy.overrides]]
 module = [

requirements.txt

@@ -1,5 +1,5 @@
 # This file was autogenerated by uv via the following command:
-#    uv pip compile --extra=docs --extra=lint --extra=map --extra=test --output-file=requirements.txt pyproject.toml
+#    uv pip compile --extra=plot --extra=docs --extra=lint --extra=map --extra=test --output-file=requirements.txt pyproject.toml
 affine==2.4.0
     # via rasterio
 alabaster==1.0.0

src/pygef/gef/utils.py

@@ -3,7 +3,7 @@
 import logging
 import re
 from datetime import date
-from typing import Dict, List, Optional, Tuple, Union
+from typing import Dict, List, Tuple, Union, Optional
 
 import numpy as np