diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..62299e0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,34 @@ +# Changelog + +Update your installation to the latest version: + +=== "pip" + + ```bash + # pip show prettymapp # check currently installed version + pip install prettymapp --upgrade + ``` + +## 0.4.0 +**November 30, 2024** + +- Allow selection of landcover classes via new `landcover_classes` parameter in `get_osm_geometries` +- `drawing_settings` parameter in `Plot` now defaults to `STYLES["Peach"]` +- `pyproject.toml` replaces setup.py & requirements.txt files + +## 0.3.0 +**April 23, 2024** + +- Add get_osm_geometries_from_xml to plot OSM XML files +- Add Dockerfile + + +## 0.2.0 +**August 25, 2023** + +- Upgraded dependencies, adjust deprecated functions. + +## 0.1.0 +**December 03, 2022** + +- Initial stable release on pypi diff --git a/README.md b/README.md index 1f861f8..7430ebe 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ aoi_bounds = df.total_bounds Edit the `draw_settings` input to create your own custom styles! The map layout can be further customized with the additional arguments of the [`Plot`](plotting.py#L36) class (e.g. `shape`, `contour_width` etc.). Check the webapp [examples](streamlit-prettymapp/examples.json) for inspiration. -``` +```python from prettymapp.settings import STYLES custom_style = STYLES["Peach"].copy() @@ -108,7 +108,7 @@ fig = Plot( You can also customize the selection of OSM landcover classes that should be displayed. -``` +```python from prettymapp.settings import LANDCOVER_CLASSES custom_lc_classes = LANDCOVER_CLASSES.copy() diff --git a/pyproject.toml b/pyproject.toml index f7ab3f2..ff98228 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "prettymapp" -version = "0.3.0" +version = "0.4.0" description = "Create beautiful maps from OpenStreetMap data" readme = "README.md" requires-python = ">=3.11"