Skip to content

Commit

Permalink
Merge branch 'main' of github.com:hotosm/osm-rawdata
Browse files Browse the repository at this point in the history
Synv with upstream
  • Loading branch information
rsavoye committed Oct 23, 2023
2 parents f222941 + f3698ee commit 85e8b30
Show file tree
Hide file tree
Showing 14 changed files with 86 additions and 76 deletions.
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
!pdm.lock
!entrypoint.sh
!README.md
!LICENSE.md
!LICENSE
4 changes: 1 addition & 3 deletions .github/workflows/build-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@ on:

jobs:
backend-ci-build:
uses: hotosm/gh-workflows/.github/workflows/image_build.yml@main
uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.0.1
with:
build_target: ci
image_tags: |
"ghcr.io/hotosm/osm-rawdata:ci"
build_args: |
COMMIT_REF=${{ github.sha }}
4 changes: 1 addition & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ on:

jobs:
ci-build:
uses: hotosm/gh-workflows/.github/workflows/image_build.yml@main
uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.0.1
with:
build_target: prod
image_name: "ghcr.io/${{ github.repository }}"
build_args: |
COMMIT_REF=${{ github.sha }}
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ on:

jobs:
build_doxygen:
uses: hotosm/gh-workflows/.github/workflows/doxygen_build.yml@main
uses: hotosm/gh-workflows/.github/workflows/doxygen_build.yml@1.0.1
with:
output_path: docs/apidocs

publish_docs:
uses: hotosm/gh-workflows/.github/workflows/mkdocs_build.yml@main
uses: hotosm/gh-workflows/.github/workflows/mkdocs_build.yml@1.0.1
needs: [build_doxygen]
with:
image: ghcr.io/${{ github.repository }}:ci
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ on:

jobs:
publish_to_pypi:
uses: hotosm/gh-workflows/.github/workflows/pypi_publish.yml@main
uses: hotosm/gh-workflows/.github/workflows/pypi_publish.yml@1.0.1
secrets:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
6 changes: 2 additions & 4 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: pytest
name: PyTest

on:
# Run tests on all pushed branches
Expand All @@ -12,9 +12,7 @@ on:

jobs:
pytest:
uses: hotosm/gh-workflows/.github/workflows/test_pytest.yml@main
uses: hotosm/gh-workflows/.github/workflows/test_pytest.yml@1.0.1
with:
image_name: ghcr.io/${{ github.repository }}
build_args: |
COMMIT_REF=${{ github.sha }}
tag_override: ${{ github.event_name == 'push' && 'ci' || '' }}
21 changes: 21 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
## 0.1.4 (2023-10-23)

### Fix

- Parser for Overture data files V2
- Add importer script
- Fix spelling of parquet
- Remove extraneous timer.stop()
- Make importing parquet files from Overture multi-threaded
- Add timer for import GeoJson
- Import MS Footprints into underpass schema
- Import uriParse from rawdata instead of the local copy
- If no config file is used, return the raw results
- Add content on importing Overture data into a database
- Add simple pages for all the utilities, add doc on the Overture data files

### Refactor

- rename LICENSE.md --> LICENSE
- update version in Makefile & track

## 0.1.3 (2023-10-09)

### Fix
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

PACKAGE := org.osm_rawdata.py
NAME := osm-rawdata
VERSION := 0.1.3
VERSION := 0.1.4

# All python source files
# MDS := $(wildcard ./docs/*.md)
Expand Down
56 changes: 49 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,48 @@
# osm-rawdata

🕮 [Documentation](https://hotosm.github.io/osm-rawdata/)
# OSM RawData

<!-- markdownlint-disable -->
<p align="center">
<img src="https://github.com/hotosm/fmtm/blob/main/images/hot_logo.png?raw=true" style="width: 200px;" alt="HOT"></a>
</p>
<p align="center">
<em>A python module for accessing OSM data in a postgres database.</em>
</p>
<p align="center">
<a href="https://github.com/hotosm/osm-rawdata/actions/workflows/build.yml" target="_blank">
<img src="https://github.com/hotosm/osm-rawdata/workflows/Build/badge.svg" alt="Build">
</a>
<a href="https://github.com/hotosm/osm-rawdata/actions/workflows/build-ci.yml" target="_blank">
<img src="https://github.com/hotosm/osm-rawdata/workflows/Build CI Img/badge.svg" alt="CI Build">
</a>
<a href="https://github.com/hotosm/osm-rawdata/actions/workflows/docs.yml" target="_blank">
<img src="https://github.com/hotosm/osm-rawdata/workflows/Publish Docs/badge.svg" alt="Publish Docs">
</a>
<a href="https://github.com/hotosm/osm-rawdata/actions/workflows/publish.yml" target="_blank">
<img src="https://github.com/hotosm/osm-rawdata/workflows/Publish to PyPi.org/badge.svg" alt="Publish">
</a>
<a href="https://github.com/hotosm/osm-rawdata/actions/workflows/pytest.yml" target="_blank">
<img src="https://github.com/hotosm/osm-rawdata/workflows/PyTest/badge.svg" alt="Test">
</a>
<a href="https://pypi.org/project/osm-rawdata" target="_blank">
<img src="https://img.shields.io/pypi/v/osm-rawdata?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<a href="https://pypistats.org/packages/osm-rawdata" target="_blank">
<img src="https://img.shields.io/pypi/dm/osm-rawdata.svg" alt="Downloads">
</a>
<a href="https://github.com/hotosm/osm-rawdata/blob/main/LICENSE" target="_blank">
<img src="https://img.shields.io/github/license/hotosm/osm-rawdata.svg" alt="License">
</a>
</p>

---

🕮 **Documentation**: <a href="https://hotosm.github.io/osm-rawdata/" target="_blank">https://hotosm.github.io/osm-rawdata/</a>

🖥️ **Source Code**: <a href="https://github.com/hotosm/osm-rawdata" target="_blank">https://github.com/hotosm/osm-rawdata</a>

---

<!-- markdownlint-enable -->

These is a module to work with
[OpenStreetMap](https://www.openstreetmap.org) data using postgres and
Expand Down Expand Up @@ -80,19 +122,19 @@ enhanced version to define the queries.
The JSON format is also supported, both parsing the config file and
also generating that query from a YAML config file.

# The files
## The Files

## geofabrik.py
### geofabrik.py

This is a simple utility to download a file from GeoGFabrik.

## config.py
### config.py

This class parses either then JSON or YAML config file formatted
files, and creates a data structure used later to generater the
database query.

## postgres.py
### postgres.py

This class handles working with the postgres database. It sets up the
connections, and handles processing the results from the queries.
1 change: 1 addition & 0 deletions docs/CHANGELOG.md
50 changes: 0 additions & 50 deletions docs/index.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/index.md
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,5 @@ nav:
- YAML: yaml.md
- Overture: overture.md
- API: api.md
- License: LICENSE.md
- License: LICENSE
- Changelog: CHANGELOG.md
2 changes: 1 addition & 1 deletion osm_rawdata/__version__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
"""Project version"""
__version__ = "0.1.3"
__version__ = "0.1.4"
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ pythonpath = "osm_rawdata"

[tool.commitizen]
name = "cz_conventional_commits"
version = "0.1.3"
version = "0.1.4"
version_files = [
"pyproject.toml:version",
"osm_rawdata/__version__.py",
Expand All @@ -59,7 +59,7 @@ version_files = [
version = {from = "osm_rawdata/__version__.py"}
[tool.pdm.build]
includes = ["osm_rawdata"]
source-includes = ["tests", "LICENSE.md", "README.md"]
source-includes = ["tests", "LICENSE", "README.md"]
[tool.pdm.dev-dependencies]
dev = [
"black>=23.7.0",
Expand Down

0 comments on commit 85e8b30

Please sign in to comment.