{"id":34723959,"url":"https://github.com/openzim/maps","last_synced_at":"2026-04-24T04:33:30.142Z","repository":{"id":288289655,"uuid":"967481965","full_name":"openzim/maps","owner":"openzim","description":"Create a ZIM file from an OpenStreetMap subset","archived":false,"fork":false,"pushed_at":"2026-04-14T16:30:45.000Z","size":603,"stargazers_count":15,"open_issues_count":14,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-04-14T18:12:22.223Z","etag":null,"topics":["openstreetmap","osm","scraper","zim"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openzim.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"kiwix","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2025-04-16T14:18:12.000Z","updated_at":"2026-04-14T16:30:48.000Z","dependencies_parsed_at":"2025-04-16T23:05:19.769Z","dependency_job_id":"d7f73c7a-c66c-436e-92f2-79b938e0486d","html_url":"https://github.com/openzim/maps","commit_stats":null,"previous_names":["benoit74/maps2zim-poc","openzim/maps"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/openzim/maps","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fmaps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fmaps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fmaps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fmaps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openzim","download_url":"https://codeload.github.com/openzim/maps/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fmaps/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32209893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T03:15:14.334Z","status":"ssl_error","status_checked_at":"2026-04-24T03:15:11.608Z","response_time":64,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openstreetmap","osm","scraper","zim"],"created_at":"2025-12-25T02:16:45.272Z","updated_at":"2026-04-24T04:33:30.138Z","avatar_url":"https://github.com/openzim.png","language":"Python","funding_links":["https://github.com/sponsors/kiwix"],"categories":[],"sub_categories":[],"readme":"# maps2zim\n\nThis scrapers creates an offline maps, based on [OpenStreetMap](https://www.openstreetmap.org/) data, in the ZIM format.\n\n[![CodeFactor](https://www.codefactor.io/repository/github/openzim/maps/badge)](https://www.codefactor.io/repository/github/openzim/maps)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![codecov](https://codecov.io/gh/openzim/maps/branch/main/graph/badge.svg)](https://codecov.io/gh/openzim/maps)\n[![PyPI version shields.io](https://img.shields.io/pypi/v/maps2zim.svg)](https://pypi.org/project/maps2zim/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/maps2zim.svg)](https://pypi.org/project/maps2zim)\n[![Docker](https://ghcr-badge.egpl.dev/openzim/maps/latest_tag?label=docker)](https://ghcr.io/openzim/maps)\n\n## Installation\n\nMost recommended solution to run the scraper is to use pre-built Docker container.\n\nPrerequisites are:\n\n- [Docker](https://docs.docker.com/engine/install/) (or Docker-based engine)\n- amd64 architecture\n\n## Usage\n\n```sh\n# Get help\ndocker run -v output:/output ghcr.io/openzim/maps maps2zim --help\n```\n\n```sh\n# Create a ZIM for Europe\ndocker 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\n```\n## Advanced installation\n\nYou can also use more advanced installation:\n\n\u003cdetails\u003e\n\u003csummary\u003eBuild your own container\u003c/summary\u003e\n\n1. Clone the repository locally:\n\n   ```sh\n   git clone https://github.com/openzim/maps.git \u0026\u0026 cd maps\n   ```\n\n1. Build the image:\n\n   ```sh\n   docker build -t ghcr.io/openzim/maps .\n   ```\n\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003eRun the software locally using Hatch\u003c/summary\u003e\n\n1. Clone the repository locally:\n\n   ```sh\n   git clone https://github.com/openzim/maps.git \u0026\u0026 cd maps\n   ```\n\n1. Install [Hatch](https://hatch.pypa.io/):\n\n   ```sh\n   pip3 install hatch\n   ```\n\n1. Start a hatch shell to install software and dependencies in an isolated virtual environment.\n\n   ```sh\n   hatch shell\n   ```\n\n1. Run the `maps2zim` command:\n\n   ```sh\n   maps2zim --help\n   ```\n\n\u003c/details\u003e\n\n## Developing\n\nUse the commands below to set up the project once:\n\n```sh\n# Install hatch if it isn't installed already.\n❯ pip install hatch\n\n# Local install (in default env) / re-sync packages\n❯ hatch run pip list\n\n# Set-up pre-commit\n❯ pre-commit install\n```\n\nThe following commands can then be used to build and test the scraper:\n\n```sh\n# Show scripts\n❯ hatch env show\n\n# linting, testing, coverage, checking\n❯ hatch run lint:all\n❯ hatch run lint:fixall\n\n# run tests\n❯ hatch run test:run\n\n# run static type checks\n❯ hatch env run check:all\n\n# building packages\n❯ hatch build\n```\n\n### Contributing\n\nThis project adheres to openZIM's [Contribution Guidelines](https://github.com/openzim/overview/wiki/Contributing).\n\nThis project has implemented openZIM's [Python bootstrap, conventions and policies](https://github.com/openzim/_python-bootstrap/blob/main/docs/Policy.md) **v1.0.3**.\n\nSee details for contributions in [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenzim%2Fmaps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenzim%2Fmaps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenzim%2Fmaps/lists"}