Pydriosm

(*27 February 2023*)

**Notable [changes](https://github.com/mikeqfu/pydriosm/compare/2.1.1...2.1.2) since [2.1.1](https://pypi.org/project/pydriosm/2.1.1/):**

- Improved the following methods: [SHPReadParse.merge_layer_shps()](https://github.com/mikeqfu/pydriosm/commit/392d759ae4504c5ebb9d8f1dab6471bf5743a7ff) and [BBBikeDownloader.get_subregion_index()](https://github.com/mikeqfu/pydriosm/commit/57b128310b89e40a12d72a0d72e34597d381ed2b).
- Updated requirements on dependencies to adapt to SQLAlchemy 2.0+.

**For more information and detailed specifications, check out [PyDriosm 2.1.2 documentation](https://pydriosm.readthedocs.io/en/2.1.2/).**

<br/>

(*9 January 2022*)

**Notable [changes](https://github.com/mikeqfu/pydriosm/compare/2.1.0...2.1.1) since [2.1.0](https://pypi.org/project/pydriosm/2.1.0/):**

- Improved the following methods/modules (with bug fixes):
- the methods [.write_to_shapefile()](https://github.com/mikeqfu/pydriosm/commit/57baec84a3d8366f6d8f6f324fbcbdf6e7f67fa6), [.read_layer_shps()](https://github.com/mikeqfu/pydriosm/commit/bec76cb0fc21b152849cbc8cccb2634b04dd59f8#diff-fc8bd4c3f1ee495f89956160ebf3736c1b8f8021e61f3eb14662439f8a781aacL1795-R2028), and [.merge_layer_shps()](https://github.com/mikeqfu/pydriosm/commit/bec76cb0fc21b152849cbc8cccb2634b04dd59f8#diff-fc8bd4c3f1ee495f89956160ebf3736c1b8f8021e61f3eb14662439f8a781aacR2105-R2343) of the class [SHPReadParse](https://github.com/mikeqfu/pydriosm/blob/7d2aa13c30c9df324a431567da69c7813e706c94/pydriosm/reader.py#L1030);
- the modules [downloader](https://github.com/mikeqfu/pydriosm/commit/3404a8ad46b03e921110e695005bd47510c8a4f2#diff-5b569a7b9029a0d3c195aacccacf61b1f151777568a288bbd8703a88f67fc2f3) and [_updater](https://github.com/mikeqfu/pydriosm/commit/3404a8ad46b03e921110e695005bd47510c8a4f2#diff-3464d30b2db28f204143ad7f953d55614ece799bc0ae918cc0ad42c6497b39cf).

**For more information and detailed specifications, check out [PyDriosm 2.1.1 documentation](https://pydriosm.readthedocs.io/en/2.1.1/).**

<br/>

(*20 November 2022*)

***Note that this release is a highly modified version and not compatible with any previous versions.***

**Notable [changes](https://github.com/mikeqfu/pydriosm/compare/2.0.3...2.1.0) since [2.0.3](https://pypi.org/project/pydriosm/2.0.3/):**

- Made major modifications and sweeping changes to the modules: [downloader](https://github.com/mikeqfu/pydriosm/commit/2761bc7f3cf265ca9621dc10f46ef6dcbcedf263), [reader](https://github.com/mikeqfu/pydriosm/commit/2e4befe4ea7847cba889aa4f983355db717e59e4), [ios](https://github.com/mikeqfu/pydriosm/commit/e508b11cf121d25356a02975481c4aaabf4ada56) and [utils](https://github.com/mikeqfu/pydriosm/commit/c69fe4f5a863eda4f925904afdf2daa2b6390c60).
- Removed the module [settings](https://github.com/mikeqfu/pydriosm/commit/2916dc938a5890b0a19cd4431fd00f9292c7ec65).
- Replaced the module [updater](https://github.com/mikeqfu/pydriosm/commit/ab6ec0ec4689bc719716ba36f9259834bb269a94) with [_updater](https://github.com/mikeqfu/pydriosm/commit/159ba27ff3410ff53ca4210409da02d03cdc2b7e).
- Added a new module [errors](https://github.com/mikeqfu/pydriosm/commit/d9f60388bd085c375873bfc2f8cc395a6f111de3).

**For more information and detailed specifications, check out [PyDriosm 2.1.0 documentation](https://pydriosm.readthedocs.io/en/2.1.0/).**

<br/>

(*25 April 2021*)

**Notable [changes](https://github.com/mikeqfu/pydriosm/compare/2.0.2...2.0.3) since [2.0.2](https://pypi.org/project/pydriosm/2.0.2/):**

- Renamed the function [~~get_default_shp_crs()~~](https://github.com/mikeqfu/pydriosm/commit/5786c620fee89fa2a0db4c8329f7d9cabf7ea81d#diff-fc8bd4c3f1ee495f89956160ebf3736c1b8f8021e61f3eb14662439f8a781aacL694) to [get_epsg4326_wgs84_crs_ref()](https://github.com/mikeqfu/pydriosm/commit/5786c620fee89fa2a0db4c8329f7d9cabf7ea81d#diff-fc8bd4c3f1ee495f89956160ebf3736c1b8f8021e61f3eb14662439f8a781aacR733) in the module [reader](https://github.com/mikeqfu/pydriosm/blob/924f943de08a03595b3604f71591a0c34952a54e/pydriosm/reader.py).
- Removed the function [get_osm_geom_object_dict()](https://github.com/mikeqfu/pydriosm/blob/d7cb423ae30dc3443139fc6063ea3ce24ed7afd9/pydriosm/utils.py#L145-L167) from the module [utils](https://github.com/mikeqfu/pydriosm/blob/924f943de08a03595b3604f71591a0c34952a54e/pydriosm/utils.py)
- Changed the default package for reading/writing shapefiles from [GeoPandas](https://pypi.org/project/geopandas/) to [PyShp](https://pypi.org/project/pyshp/) (Note that [GeoPandas](https://pypi.org/project/geopandas/) would not be required for installing [PyDriosm 2.0.3](https://pypi.org/project/pydriosm/2.0.3/)+ but would still be reserved as an alternative option if available.
- Modified the default download directories.
- Improved the class [PostgresOSM](https://github.com/mikeqfu/pydriosm/commit/90587bb0ab7bd26d3597481d463b280cdaf1a728) in the module [ios](https://github.com/mikeqfu/pydriosm/blob/924f943de08a03595b3604f71591a0c34952a54e/pydriosm/ios.py) and the module [downloader](https://github.com/mikeqfu/pydriosm/commit/52f76723a84cd822fc002f89bf92a744cbd88141) with bug fixes.
- Added the following new functions:
- [get_epsg4326_wgs84_prj_ref()](https://github.com/mikeqfu/pydriosm/commit/5786c620fee89fa2a0db4c8329f7d9cabf7ea81d#diff-fc8bd4c3f1ee495f89956160ebf3736c1b8f8021e61f3eb14662439f8a781aacR765-R791), [specify_pyshp_fields()](https://github.com/mikeqfu/pydriosm/commit/5786c620fee89fa2a0db4c8329f7d9cabf7ea81d#diff-fc8bd4c3f1ee495f89956160ebf3736c1b8f8021e61f3eb14662439f8a781aacR794-R834) and [write_to_shapefile()](https://github.com/mikeqfu/pydriosm/commit/5786c620fee89fa2a0db4c8329f7d9cabf7ea81d#diff-fc8bd4c3f1ee495f89956160ebf3736c1b8f8021e61f3eb14662439f8a781aacR837-R917) to the module [reader](https://github.com/mikeqfu/pydriosm/blob/924f943de08a03595b3604f71591a0c34952a54e/pydriosm/reader.py);
- [shp_shape_types_dict()](https://github.com/mikeqfu/pydriosm/commit/1a82b3d96383500898af13f6a49023f6c88f4c06#diff-262651b10b835e2d78c1c6d4157b36f97721b7a10a13f197715ee984266c3882R147-R172) and [shp_shape_types_geom_dict()](https://github.com/mikeqfu/pydriosm/commit/1a82b3d96383500898af13f6a49023f6c88f4c06#diff-262651b10b835e2d78c1c6d4157b36f97721b7a10a13f197715ee984266c3882R175-R192) to the module [utils](https://github.com/mikeqfu/pydriosm/blob/924f943de08a03595b3604f71591a0c34952a54e/pydriosm/utils.py).

**For more information and detailed specifications, check out [PyDriosm 2.0.3 documentation](https://pydriosm.readthedocs.io/en/2.0.3/).**

<br/>

(*24 November 2020*)

**Notable [changes](https://github.com/mikeqfu/pydriosm/compare/2.0.1...2.0.2) since [2.0.1](https://pypi.org/project/pydriosm/2.0.1/):**

- Added [a new parameter](https://github.com/mikeqfu/pydriosm/commit/3b4d8c3c58f40f4a405586594fa57524a8e825e8) `max_tmpfile_size` for setting the maximum size of in-memory temporary file while instantiating the classes [GeofabrikReader](https://github.com/mikeqfu/pydriosm/commit/3b4d8c3c58f40f4a405586594fa57524a8e825e8#diff-fc8bd4c3f1ee495f89956160ebf3736c1b8f8021e61f3eb14662439f8a781aacR1259) and [BBBikeReader](https://github.com/mikeqfu/pydriosm/commit/3b4d8c3c58f40f4a405586594fa57524a8e825e8#diff-fc8bd4c3f1ee495f89956160ebf3736c1b8f8021e61f3eb14662439f8a781aacR2123) for reading OSM data.
- Added a new function [validate_shp_layer_names()](https://pydriosm.readthedocs.io/en/2.0.2/_generated/pydriosm.utils.validate_shp_layer_names.html) to the module [utils](https://pydriosm.readthedocs.io/en/2.0.2/utils.html).
- Optimized import statements for all modules.

**For more information and detailed specifications, check out [PyDriosm 2.0.2 documentation](https://pydriosm.readthedocs.io/en/2.0.2/).**

<br/>

(*19 November 2020*)

**Notable [changes](https://github.com/mikeqfu/pydriosm/compare/2.0.0...2.0.1) since [2.0.0](https://pypi.org/project/pydriosm/2.0.0/):**

- Optimized import statements for the modules [downloader](https://github.com/mikeqfu/pydriosm/commit/a4d000a9f0e435e283e15c0a0db45049335e286c) and [reader](https://github.com/mikeqfu/pydriosm/commit/09ff2fc65986105566ee923b96284a78f503b3ba).

<br/>