About pydriosm

PyDriosm: An open-source tool for downloading, reading and PostgreSQL-based I/O of OpenStreetMap data.

m

Published by

mikeqfu

Visit View Profile

README.md

View on GitHub

PyDriosm

A Python package for downloading, reading and PostgreSQL-based I/O of OpenStreetMap data.

PyDriosm is an open-source Python package designed to simplify the acquisition and management of OpenStreetMap (OSM) data. It provides automated utilities for downloading and parsing data extracts from Geofabrik and BBBike in several popular formats, including Protocolbuffer Binary Format (PBF), Shapefiles and GeoPackage (GPKG).

Beyond data retrieval, the package integrates a robust I/O interface for PostgreSQL databases. This allows users to import parsed OSM data directly into a relational database, facilitating complex spatial querying and efficient data manipulation. By handling the complexities of source scraping, file parsing and schema mapping, pydriosm provides a streamlined workflow for researchers and developers working with large-scale geographic datasets.

Core features:

Automated downloads: Direct access to Geofabrik and BBBike subregion extracts.
Format support: Parse regional data of PBF, Shapefiles and GeoPackage files into standard Pandas DataFrames or GeoDataFrames.
PostgreSQL integration: Streamlined geometry I/O for efficient database storage.
Multi-region processing: Tools for merging regional data layers into unified datasets.

Installation

To install the latest release of pydriosm from PyPI via pip:

$ pip install --upgrade pydriosm

For more information, see the Installation.

Quick start

For a concise guide with practical examples, please check out the Quick Start tutorial, which demonstrates how to use pydriosm to download, parse and perform storage I/O operations on OSM data using a PostgreSQL database.

Documentation

The complete PyHelpers Documentation is available in [HTML] [PDF] formats.

It is hosted on ReadTheDocs and provides detailed examples, tutorials and comprehensive references to help users get the most out of pydriosm.

Cite as

Fu, Q. (2020). PyDriosm: An open-source tool for downloading, reading and PostgreSQL-based I/O of OpenStreetMap data. Zenodo. doi:10.5281/zenodo.4281194

@software{qian_fu_pydriosm_4281194,
  author    = {Fu, Qian},
  title     = {{PyDriosm: An open-source tool for downloading, reading and PostgreSQL-based I/O of OpenStreetMap data}},
  year      = {2020},
  publisher = {Zenodo},
  doi       = {10.5281/zenodo.4281194},
  license   = {GPLv3},
  url       = {https://github.com/mikeqfu/pydriosm}
}

(Please also refer to the export options from Zenodo to reference the specific version of pydriosm as appropriate.)

License

PyDriosm is licensed under GNU General Public License v3.0 or later (GPLv3+).
The free OpenStreetMap data, which is used for the development of PyDriosm, is licensed under the Open Data Commons Open Database License (ODbL) by the OpenStreetMap Foundation (OSMF).

Acknowledgement

The development of pydriosm, including the example code that demonstrates how to use the package, heavily relies on freely available OpenStreetMap data. The author would like to express sincere gratitude to all the OpenStreetMap contributors for their invaluable contributions in making this data accessible to the community.

pydriosm