Skip to content

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

License

Notifications You must be signed in to change notification settings

mikeqfu/pydriosm

Repository files navigation

PyDriosm

PyPI Python Version Documentation Status License Codacy Badge DOI

PyDriosm is an open-source tool that provides an effortless way to download and access OpenStreetMap (OSM) data in popular file formats, such as shapefile and protobuf binary format (PBF), which are freely available from Geofabrik and BBBike. Additionally, the package offers a comprehensive solution for convenient I/O operations and efficient storage capabilities for parsed OSM data within PostgreSQL databases. This means that users can easily read from and write to PostgreSQL databases, enabling efficient data manipulation, querying, and other essential tasks. Whether you are a researcher, practitioner, or simply interested in working with OSM data, PyDriosm can be useful and helpful to streamline your workflow and enhance your experience.

Installation

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

pip install --upgrade pydriosm

Please also refer to Installation for more information.

Quick start

For a concise guide with practical examples, please check out the quick-start tutorial. This tutorial showcases how to utilise PyDriosm for various tasks, such as downloading, parsing, and performing storage I/O operations on OSM data using a PostgreSQL database.

Documentation

The complete PyDriosm documentation: [HTML] [PDF]

It is hosted on ReadTheDocs and provides a wealth of detailed examples.

License

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.

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    = {Qian Fu},
  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.4718623},
  url       = {https://doi.org/10.5281/zenodo.4281194}
}

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

Contributors

Qian Fu
Qian Fu

🌱 💻 🧪 📖