maps2zim

This scrapers creates an offline maps, based on OpenStreetMap data, in the ZIM format.

Installation

Most recommended solution to run the scraper is to use pre-built Docker container.

Prerequisites are:

• Docker (or Docker-based engine)
• amd64 architecture

Usage

# Get help
docker run -v output:/output ghcr.io/openzim/maps maps2zim --help

# Create a ZIM for Europe
docker run -v output:/output ghcr.io/openzim/maps maps2zim --include-poly=https://download.geofabrik.de/europe.poly --default-view=56.9,11.0,2.45 --name=maps_en_europe --title='Europe offline maps' --description='A ZIM with offline maps of the whole Europe area, including city search' --output=/output

Advanced installation

You can also use more advanced installation:

Developing

Use the commands below to set up the project once:

# Install hatch if it isn't installed already.
❯ pip install hatch

# Local install (in default env) / re-sync packages
❯ hatch run pip list

# Set-up pre-commit
❯ pre-commit install

The following commands can then be used to build and test the scraper:

# Show scripts
❯ hatch env show

# linting, formating, type checking
❯ hatch run qa:check-all
❯ hatch run qa:fix-all

# run tests
❯ hatch run test:run

# building packages
❯ hatch build

Contributing

This project adheres to openZIM's Contribution Guidelines.

This project has implemented openZIM's Python bootstrap, conventions and policies v2.0.0.

See details for contributions in CONTRIBUTING.md.