# PyDriosm
[](https://docs.python.org/3/) [](https://pydriosm.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/mikeqfu/pydriosm/blob/master/LICENSE)
[](https://www.codacy.com/gh/mikeqfu/pydriosm/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mikeqfu/pydriosm&utm_campaign=Badge_Grade)
[](https://zenodo.org/badge/latestdoi/92493726)
PyDriosm is an open-source tool that provides an effortless way to download and access [OpenStreetMap](https://www.openstreetmap.org/) (OSM) data in popular file formats, such as [shapefile](https://wiki.openstreetmap.org/wiki/Shapefiles) and [protobuf binary format](https://wiki.openstreetmap.org/wiki/PBF_Format) (PBF), which are freely available from [Geofabrik](https://download.geofabrik.de/) and [BBBike](https://download.bbbike.org/). Additionally, the package offers a comprehensive solution for convenient I/O operations and efficient storage capabilities for parsed OSM data within [PostgreSQL](https://www.postgresql.org/) 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 is a valuable tool to streamline your workflow and enhance your experience.
## Installation
To install the latest release of PyDriosm from [PyPI](https://pypi.org/project/pydriosm/) via [pip](https://pip.pypa.io/en/stable/cli/pip/):
```bash
pip install --upgrade pydriosm
```
Please also refer to [Installation](https://pydriosm.readthedocs.io/en/latest/installation.html) for more information.
## Quick start
For a comprehensive guide with practical examples, please check out the [quick-start tutorial](https://pydriosm.readthedocs.io/en/latest/quick-start.html). This tutorial showcases how to use the package for various tasks, such as downloading, parsing, and performing storage I/O operations on OSM data using a PostgreSQL database.
## Documentation
The full PyDriosm documentation [[HTML](https://pydriosm.readthedocs.io/en/latest/)\] \[[PDF](https://pydriosm.readthedocs.io/_/downloads/en/latest/pdf/)], which includes more detailed examples, is hosted on [ReadTheDocs](https://readthedocs.org/projects/pydriosm/).
## License
- PyDriosm is licensed under [GNU General Public License v3.0](https://github.com/mikeqfu/pydriosm/blob/master/LICENSE) or later (GPLv3+).
- The free [OpenStreetMap](https://www.openstreetmap.org/) data, which is used for the development of PyDriosm, is licensed under the [Open Data Commons Open Database License](https://opendatacommons.org/licenses/odbl/) (ODbL) by the [OpenStreetMap Foundation](https://osmfoundation.org/) (OSMF).
## Acknowledgement
The development of PyDriosm, including the example code that demonstrates how to use the package, heavily relies on freely available [OpenStreetMap](https://www.openstreetmap.org/) data. The author would like to express sincere gratitude to all the [OpenStreetMap contributors](https://wiki.openstreetmap.org/wiki/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](https://doi.org/10.5281/zenodo.4281194)
```bibtex
@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](https://zenodo.org/search?page=1&size=20&q=conceptrecid:4281194&all_versions&sort=-version) to reference the specific version of PyDriosm as appropriate.)
## Contributors
<!--suppress HtmlDeprecatedAttribute -->
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/mikeqfu" target="_blank"><img src="https://avatars.githubusercontent.com/u/1729711?v=4?s=100" width="100px;" alt="Qian Fu"/><br><sub><b>Qian Fu</b></sub></a><br>
<a href="https://github.com/mikeqfu/pydriosm" target="_blank" title="Seeding">🌱</a>
<a href="https://github.com/mikeqfu/pydriosm/commits?author=mikeqfu" target="_blank" title="Code">💻</a>
<a href="https://github.com/mikeqfu/pydriosm/tree/master/tests" target="_blank" title="Tests">🧪</a>
<a href="https://pydriosm.readthedocs.io/en/latest/" target="_blank" title="Documentation">📖</a>
</td>
</tbody>
</table>
Raw data
{
"_id": null,
"home_page": "https://github.com/mikeqfu/pydriosm",
"name": "pydriosm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "Python,OpenStreetMap,OSM,Geofabrik,BBBike,Protocolbuffer Binary Format,PBF,Shapefile,PostgreSQL",
"author": "Qian Fu",
"author_email": "q.fu@bham.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/d5/9c/f89bfad7dff1f63f0c2af6543e9b76cd8f1ee025ef742e37d01b181302a9/pydriosm-2.2.0.tar.gz",
"platform": "nt",
"description": "# PyDriosm\r\n\r\n[](https://docs.python.org/3/) [](https://pydriosm.readthedocs.io/en/latest/?badge=latest) \r\n[](https://github.com/mikeqfu/pydriosm/blob/master/LICENSE) \r\n[](https://www.codacy.com/gh/mikeqfu/pydriosm/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mikeqfu/pydriosm&utm_campaign=Badge_Grade) \r\n[](https://zenodo.org/badge/latestdoi/92493726)\r\n\r\nPyDriosm is an open-source tool that provides an effortless way to download and access [OpenStreetMap](https://www.openstreetmap.org/) (OSM) data in popular file formats, such as [shapefile](https://wiki.openstreetmap.org/wiki/Shapefiles) and [protobuf binary format](https://wiki.openstreetmap.org/wiki/PBF_Format) (PBF), which are freely available from [Geofabrik](https://download.geofabrik.de/) and [BBBike](https://download.bbbike.org/). Additionally, the package offers a comprehensive solution for convenient I/O operations and efficient storage capabilities for parsed OSM data within [PostgreSQL](https://www.postgresql.org/) 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 is a valuable tool to streamline your workflow and enhance your experience. \r\n\r\n## Installation\r\n\r\nTo install the latest release of PyDriosm from [PyPI](https://pypi.org/project/pydriosm/) via [pip](https://pip.pypa.io/en/stable/cli/pip/):\r\n\r\n```bash\r\npip install --upgrade pydriosm\r\n```\r\n\r\nPlease also refer to [Installation](https://pydriosm.readthedocs.io/en/latest/installation.html) for more information. \r\n\r\n## Quick start\r\n\r\nFor a comprehensive guide with practical examples, please check out the [quick-start tutorial](https://pydriosm.readthedocs.io/en/latest/quick-start.html). This tutorial showcases how to use the package for various tasks, such as downloading, parsing, and performing storage I/O operations on OSM data using a PostgreSQL database.\r\n\r\n## Documentation\r\n\r\nThe full PyDriosm documentation [[HTML](https://pydriosm.readthedocs.io/en/latest/)\\] \\[[PDF](https://pydriosm.readthedocs.io/_/downloads/en/latest/pdf/)], which includes more detailed examples, is hosted on [ReadTheDocs](https://readthedocs.org/projects/pydriosm/).\r\n\r\n## License\r\n\r\n- PyDriosm is licensed under [GNU General Public License v3.0](https://github.com/mikeqfu/pydriosm/blob/master/LICENSE) or later (GPLv3+).\r\n- The free [OpenStreetMap](https://www.openstreetmap.org/) data, which is used for the development of PyDriosm, is licensed under the [Open Data Commons Open Database License](https://opendatacommons.org/licenses/odbl/) (ODbL) by the [OpenStreetMap Foundation](https://osmfoundation.org/) (OSMF).\r\n\r\n## Acknowledgement\r\n\r\nThe development of PyDriosm, including the example code that demonstrates how to use the package, heavily relies on freely available [OpenStreetMap](https://www.openstreetmap.org/) data. The author would like to express sincere gratitude to all the [OpenStreetMap contributors](https://wiki.openstreetmap.org/wiki/Contributors) for their invaluable contributions in making this data accessible to the community.\r\n\r\n## Cite as\r\n\r\nFu, Q. (2020). PyDriosm: an open-source tool for downloading, reading and PostgreSQL-based I/O of OpenStreetMap data. Zenodo. [doi:10.5281/zenodo.4281194](https://doi.org/10.5281/zenodo.4281194)\r\n\r\n```bibtex\r\n@software{qian_fu_pydriosm_4281194,\r\n author = {Qian Fu},\r\n title = {{PyDriosm: an open-source tool for downloading, reading\r\n and PostgreSQL-based I/O of OpenStreetMap data}},\r\n year = 2020,\r\n publisher = {Zenodo},\r\n doi = {10.5281/zenodo.4718623},\r\n url = {https://doi.org/10.5281/zenodo.4281194}\r\n}\r\n```\r\n\r\n(Please also refer to the export options from [Zenodo](https://zenodo.org/search?page=1&size=20&q=conceptrecid:4281194&all_versions&sort=-version) to reference the specific version of PyDriosm as appropriate.)\r\n\r\n## Contributors\r\n\r\n<!--suppress HtmlDeprecatedAttribute -->\r\n<table>\r\n <tbody>\r\n <tr>\r\n <td align=\"center\">\r\n <a href=\"https://github.com/mikeqfu\" target=\"_blank\"><img src=\"https://avatars.githubusercontent.com/u/1729711?v=4?s=100\" width=\"100px;\" alt=\"Qian Fu\"/><br><sub><b>Qian Fu</b></sub></a><br>\r\n <a href=\"https://github.com/mikeqfu/pydriosm\" target=\"_blank\" title=\"Seeding\">🌱</a>\r\n <a href=\"https://github.com/mikeqfu/pydriosm/commits?author=mikeqfu\" target=\"_blank\" title=\"Code\">💻</a>\r\n <a href=\"https://github.com/mikeqfu/pydriosm/tree/master/tests\" target=\"_blank\" title=\"Tests\">🧪</a>\r\n <a href=\"https://pydriosm.readthedocs.io/en/latest/\" target=\"_blank\" title=\"Documentation\">📖</a>\r\n </td>\r\n </tbody>\r\n</table>\r\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "An open-source tool for downloading, reading and PostgreSQL-based I/O of OpenStreetMap data.",
"version": "2.2.0",
"project_urls": {
"Documentation": "https://pydriosm.readthedocs.io/en/2.2.0/",
"Homepage": "https://github.com/mikeqfu/pydriosm",
"Issue Tracker": "https://github.com/mikeqfu/pydriosm/issues",
"Source": "https://github.com/mikeqfu/pydriosm"
},
"split_keywords": [
"python",
"openstreetmap",
"osm",
"geofabrik",
"bbbike",
"protocolbuffer binary format",
"pbf",
"shapefile",
"postgresql"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d6840e405230b94bc347de1a0b0f5c18884680084612519446ecc3fe550b85f",
"md5": "c10265d32de9f3902f1e25932ddb73a5",
"sha256": "7ef7e42dfcd9f3e9e8bc53fde86b483e8b01b22082cc1804bf9a5e0e901d703b"
},
"downloads": -1,
"filename": "pydriosm-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c10265d32de9f3902f1e25932ddb73a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1570554,
"upload_time": "2023-06-19T10:27:15",
"upload_time_iso_8601": "2023-06-19T10:27:15.475294Z",
"url": "https://files.pythonhosted.org/packages/9d/68/40e405230b94bc347de1a0b0f5c18884680084612519446ecc3fe550b85f/pydriosm-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d59cf89bfad7dff1f63f0c2af6543e9b76cd8f1ee025ef742e37d01b181302a9",
"md5": "46d0d95064719c1e707d8b8e730e5243",
"sha256": "0691f2caa8e675553e9e942b06384826c3ad322c068232d47d20f7137b9bd197"
},
"downloads": -1,
"filename": "pydriosm-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "46d0d95064719c1e707d8b8e730e5243",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1557971,
"upload_time": "2023-06-19T10:27:19",
"upload_time_iso_8601": "2023-06-19T10:27:19.246102Z",
"url": "https://files.pythonhosted.org/packages/d5/9c/f89bfad7dff1f63f0c2af6543e9b76cd8f1ee025ef742e37d01b181302a9/pydriosm-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 10:27:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mikeqfu",
"github_project": "pydriosm",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "build",
"specs": [
[
"==",
"0.10.0"
]
]
},
{
"name": "fqdn",
"specs": [
[
"==",
"1.5.1"
]
]
},
{
"name": "gdal",
"specs": [
[
"==",
"3.4.3"
]
]
},
{
"name": "geopandas",
"specs": [
[
"==",
"0.13.2"
]
]
},
{
"name": "ipympl",
"specs": [
[
"==",
"0.9.3"
]
]
},
{
"name": "isoduration",
"specs": [
[
"==",
"20.11.0"
]
]
},
{
"name": "jsonpointer",
"specs": [
[
"==",
"2.4"
]
]
},
{
"name": "jupyterlab",
"specs": [
[
"==",
"4.0.2"
]
]
},
{
"name": "notebook",
"specs": [
[
"==",
"6.5.4"
]
]
},
{
"name": "orjson",
"specs": [
[
"==",
"3.9.1"
]
]
},
{
"name": "pip-chill",
"specs": [
[
"==",
"1.0.3"
]
]
},
{
"name": "pyrcs",
"specs": [
[
"==",
"0.3.6"
]
]
},
{
"name": "pyshp",
"specs": [
[
"==",
"2.3.1"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
"==",
"4.1.0"
]
]
},
{
"name": "python-rapidjson",
"specs": [
[
"==",
"1.10"
]
]
},
{
"name": "sphinx-copybutton",
"specs": [
[
"==",
"0.5.2"
]
]
},
{
"name": "sphinx-rtd-theme",
"specs": [
[
"==",
"1.2.2"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.65.0"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"4.0.2"
]
]
},
{
"name": "ujson",
"specs": [
[
"==",
"5.8.0"
]
]
},
{
"name": "uri-template",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "webcolors",
"specs": [
[
"==",
"1.13"
]
]
}
],
"lcname": "pydriosm"
}
JSON
