|
1 |
| -# osm-rawdata |
2 |
| - |
3 |
| -🕮 [Documentation](https://hotosm.github.io/osm-rawdata/) |
| 1 | +# OSM RawData |
| 2 | + |
| 3 | +<!-- markdownlint-disable --> |
| 4 | +<p align="center"> |
| 5 | + <img src="https://github.com/hotosm/fmtm/blob/main/images/hot_logo.png?raw=true" style="width: 200px;" alt="HOT"></a> |
| 6 | +</p> |
| 7 | +<p align="center"> |
| 8 | + <em>A python module for accessing OSM data in a postgres database.</em> |
| 9 | +</p> |
| 10 | +<p align="center"> |
| 11 | + <a href="https://github.com/hotosm/osm-rawdata/actions/workflows/build.yml" target="_blank"> |
| 12 | + <img src="https://github.com/hotosm/osm-rawdata/workflows/Build/badge.svg" alt="Build"> |
| 13 | + </a> |
| 14 | + <a href="https://github.com/hotosm/osm-rawdata/actions/workflows/build-ci.yml" target="_blank"> |
| 15 | + <img src="https://github.com/hotosm/osm-rawdata/workflows/Build CI Img/badge.svg" alt="CI Build"> |
| 16 | + </a> |
| 17 | + <a href="https://github.com/hotosm/osm-rawdata/actions/workflows/docs.yml" target="_blank"> |
| 18 | + <img src="https://github.com/hotosm/osm-rawdata/workflows/Publish Docs/badge.svg" alt="Publish Docs"> |
| 19 | + </a> |
| 20 | + <a href="https://github.com/hotosm/osm-rawdata/actions/workflows/publish.yml" target="_blank"> |
| 21 | + <img src="https://github.com/hotosm/osm-rawdata/workflows/Publish to PyPi.org/badge.svg" alt="Publish"> |
| 22 | + </a> |
| 23 | + <a href="https://github.com/hotosm/osm-rawdata/actions/workflows/pytest.yml" target="_blank"> |
| 24 | + <img src="https://github.com/hotosm/osm-rawdata/workflows/PyTest/badge.svg" alt="Test"> |
| 25 | + </a> |
| 26 | + <a href="https://pypi.org/project/osm-rawdata" target="_blank"> |
| 27 | + <img src="https://img.shields.io/pypi/v/osm-rawdata?color=%2334D058&label=pypi%20package" alt="Package version"> |
| 28 | + </a> |
| 29 | + <a href="https://pypistats.org/packages/osm-rawdata" target="_blank"> |
| 30 | + <img src="https://img.shields.io/pypi/dm/osm-rawdata.svg" alt="Downloads"> |
| 31 | + </a> |
| 32 | + <a href="https://github.com/hotosm/osm-rawdata/blob/main/LICENSE" target="_blank"> |
| 33 | + <img src="https://img.shields.io/github/license/hotosm/osm-rawdata.svg" alt="License"> |
| 34 | + </a> |
| 35 | +</p> |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +🕮 **Documentation**: <a href="https://hotosm.github.io/osm-rawdata/" target="_blank">https://hotosm.github.io/osm-rawdata/</a> |
| 40 | + |
| 41 | +🖥️ **Source Code**: <a href="https://github.com/hotosm/osm-rawdata" target="_blank">https://github.com/hotosm/osm-rawdata</a> |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +<!-- markdownlint-enable --> |
4 | 46 |
|
5 | 47 | These is a module to work with
|
6 | 48 | [OpenStreetMap](https://www.openstreetmap.org) data using postgres and
|
@@ -80,19 +122,19 @@ enhanced version to define the queries.
|
80 | 122 | The JSON format is also supported, both parsing the config file and
|
81 | 123 | also generating that query from a YAML config file.
|
82 | 124 |
|
83 |
| -# The files |
| 125 | +## The Files |
84 | 126 |
|
85 |
| -## geofabrik.py |
| 127 | +### geofabrik.py |
86 | 128 |
|
87 | 129 | This is a simple utility to download a file from GeoGFabrik.
|
88 | 130 |
|
89 |
| -## config.py |
| 131 | +### config.py |
90 | 132 |
|
91 | 133 | This class parses either then JSON or YAML config file formatted
|
92 | 134 | files, and creates a data structure used later to generater the
|
93 | 135 | database query.
|
94 | 136 |
|
95 |
| -## postgres.py |
| 137 | +### postgres.py |
96 | 138 |
|
97 | 139 | This class handles working with the postgres database. It sets up the
|
98 | 140 | connections, and handles processing the results from the queries.
|
0 commit comments