Skip to content

KAMI911/osm_poi_matchmaker

osm_poi_matchmaker - OSM POI ⌘ 🎔 MatchMaker

Build Status Codacy Badge Maintainability Scrutinizer Code Quality Build Status Percentage of issues still open GitHub stars

Table of Contents

  1. About
  2. Licensing
  3. Installation
  4. Environment variables
  5. Documentation
  6. Support
  7. Contributing
  8. Donation

About

The osm_poi_matchmaker is an open source OpenStreetMap import tool that try to import data from external sources to OpenStreetMap database. The command line util creates OSM files that can be imported with JOSM application.

Since this is a mass data import tool, before any importation task, please refer and follow the OpenStreetMap Import Guidlines.

This project has created by OpenStreetMap Contributors. You can follow current imports related to this project.

NOTE: The osm_poi_matchmaker using manually created importers (called data provider). Currenty osm_poi_matchmaker has only Hungarian data sources. You can use these data providers as examle to create your own data providers.

BIG FAT WARNING: You must obtain proper permissions and licenses to use the data in OSM from the data owner. If the license of the data is not compatible with the OpenStreetMap Open Database License, you can not use the data. Many localities already have progressive open data policies. Others have data policies that are almost open, but have conflicts with issues like prohibitions on commercial use or requirements for attribution. Sometimes, getting permission to use data, even if the existing license might seem prohibitive, is as simple as asking the appropriate authority if they are willing to comply with the terms of the OpenStreetMap Open Database License. See Import/GettingPermission for example emails that touch on important issues. See also ODbL Compatibility for a quick view of some compatible and incompatible licenses of data to import.

Licensing

The osm_poi_matchmaker application and documantations are licensed under the terms of the GNU General Public License Version 3, you will find a copy of this license in the LICENSE file included in the source package.

Installation

You can try osm_poi_matchmaker with following steps.

  • Checkout the source code from https://github.com/KAMI911/osm_poi_matchmaker

    git clone https://github.com/KAMI911/osm_poi_matchmaker.git
    
  • Install PostgreSQL 9.6 or newer and PostGIS.

  • Download daily OpenStreetMap snapshots from here (We are using Hungarian extract):

    https://download.geofabrik.de/europe.html
    
  • Import the daily snapshot of OSM database file into PostgreSQL database (for example in Hungary):

    osm2pgsql -c -m -s -d poi --style osm2pgsql/default.style --extra-attributes --multi-geometry -C 8000 -U poi -W -H localhost ~/Downloads/hungary-latest.osm
    

Environment variables

You can specify these environment variables to use instead of configured parameters in "app.conf" file:

OPM_DIRECTORY_OUTPUT

Specify the output directory for processed and exported data (OSM and CSV files). This is the output directory.

OPM_DIRECTORY_CACHE_URL

Specify the cache directory for downloaded external data (HTML,JS,CSV files).

OPM_DATABASE_TYPE

Specify the supported a supported database for storing and matched data. Since OSM POI Matchmaker is using PostGIS, only "postgresql" is supported and tested this time. Default value is: "postgresql".

OPM_DATABASE_WRITE_HOST

Hostname or IP address of database server. Default value is "localhost".

OPM_DATABASE_WRITE_PORT

The connection port of database server. Default value is "5432".

OPM_DATABASE_WRITE_USERNAME

The user name of wrinting user for the database connection. Default value is "poi".

OPM_DATABASE_WRITE_PASSWORD

The password of wrinting user for the database connection. Default value is "poitest".

OPM_DATABASE_POI_DATABASE

The database name where wrinting user will connect to the database connection. Default value is "poi".

OPM_DATAPROVIDERS_MODULES_AVAILABLE

Comma separated list of available data providers module from "dataprovider" folder. Default values are: hu_aldi,hu_avia,hu_benu,hu_budapest_bank,hu_cba,hu_cib_bank,hu_dm,hu_foxpost,hu_kh_bank,hu_kulcs_patika,hu_mobil_petrol, hu_mol_bubi,hu_mol,hu_omv,hu_penny_market,hu_pepco,hu_posta_json,hu_posta,hu_rossmann,hu_shell,hu_spar,hu_tesco,hu_tom_market

OPM_DATAPROVIDERS_MODULES_ENABLE

Comma separated list of available data providers module from "dataprovider" folder. Only the enabled data providers will have import during the run,but all imported files will be exported. Default values are: hu_posta,hu_aldi,hu_avia,hu_benu,hu_budapest_bank,hu_cba,hu_cib_bank,hu_dm,hu_foxpost,hu_kh_bank,hu_kulcs_patika,hu_mobil_petrol, hu_mol_bubi,hu_mol,hu_omv,hu_penny_market,hu_pepco,hu_posta_json,hu_rossmann,hu_shell,hu_spar,hu_tesco,hu_tom_market

Importing with this tool

You can import the created OSM files to JOSM then upload to OpenStreetMap database. Since this is a mass data import tool, before any importation task, please refer and follow the OpenStreetMap Import Guidlines.

Please use these import tags for changeset and change them accordingly:

comment=Import Hungarian POIs of something
source=import;website
import:tool:url=https://github.com/KAMI911/osm_poi_matchmaker
import:tool:version=0.8.0
import:tool=osm_poi_matchmaker
import:area=hungary
mechanical=yes
is_in:country_code=HU
is_in:country=Hungary
import:discussion:url=https://groups.google.com/forum/#!topic/openstreetmap-hungary/GF8hYXD5wU0

An example

Documentation

The documentation is located in the doc/ directory.

Support

If you have any question, do not hesitate and drop me a line. If you found a bug, or have a feature request, you can fill an issue.

Contributing

There are many ways to contribute to osm_poi_matchmaker -- whether it be sending patches, testing, reporting bugs, or reviewing and updating the documentation. Every contribution is appreciated!

Please continue reading in the contributing chapter.

Fork me on Github

https://github.com/KAMI911/osm_poi_matchmaker

Donation

If you find this useful, please consider a donation:

paypal

About

OSM POI Matchmaker

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages