{"id":13495542,"url":"https://github.com/protomaps/PMTiles","last_synced_at":"2025-03-28T16:32:56.469Z","repository":{"id":38845175,"uuid":"339331471","full_name":"protomaps/PMTiles","owner":"protomaps","description":"Cloud-optimized + compressed single-file tile archives for vector and raster maps","archived":false,"fork":false,"pushed_at":"2024-10-22T21:18:36.000Z","size":21096,"stargazers_count":2040,"open_issues_count":12,"forks_count":118,"subscribers_count":22,"default_branch":"main","last_synced_at":"2024-10-29T11:28:34.409Z","etag":null,"topics":["serverless"],"latest_commit_sha":null,"homepage":"https://protomaps.com/docs/pmtiles/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/protomaps.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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},"funding":{"github":"protomaps"}},"created_at":"2021-02-16T08:30:22.000Z","updated_at":"2024-10-29T11:12:08.000Z","dependencies_parsed_at":"2023-02-10T14:01:55.608Z","dependency_job_id":"6864973d-211e-4385-89b6-73074af04565","html_url":"https://github.com/protomaps/PMTiles","commit_stats":{"total_commits":447,"total_committers":13,"mean_commits":34.38461538461539,"dds":"0.13422818791946312","last_synced_commit":"0dbe87cfddc6bc78165c25146764132c43028415"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protomaps%2FPMTiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protomaps%2FPMTiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protomaps%2FPMTiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protomaps%2FPMTiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/protomaps","download_url":"https://codeload.github.com/protomaps/PMTiles/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222232145,"owners_count":16952973,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["serverless"],"created_at":"2024-07-31T19:01:35.713Z","updated_at":"2024-10-31T10:31:19.103Z","avatar_url":"https://github.com/protomaps.png","language":"TypeScript","readme":"[![npm](https://img.shields.io/npm/v/pmtiles)](https://www.npmjs.com/package/pmtiles)\n[![pypi](https://img.shields.io/pypi/v/pmtiles)](https://pypi.org/project/pmtiles/)\n\n🔎 **PMTiles Viewer:** [https://pmtiles.io/](https://pmtiles.io) 🔎\n\n# PMTiles\n\nPMTiles is a single-file archive format for tiled data. A PMTiles archive can be hosted on a commodity storage platform such as S3, and enables low-cost, zero-maintenance map applications that are \"serverless\" - free of a custom tile backend or third party provider.\n\n* [Protomaps Blog: Dynamic Maps, Static Storage](http://protomaps.com/blog/dynamic-maps-static-storage)\n\n* [PMTiles Viewer](https://pmtiles.io) - inspect and preview PMTiles local or remote PMTiles archives.\n    * Archives on cloud storage may require CORS for the origin `https://protomaps.github.io`\n\n* [Vector Tiles Example (US Zip Codes)](https://pmtiles.io/?url=https%3A%2F%2Fr2-public.protomaps.com%2Fprotomaps-sample-datasets%2Fcb_2018_us_zcta510_500k.pmtiles)\n\n\nDemos require MapLibre GL JS v1.15 or later.\n\nSee also:\n* [Cloud Optimized GeoTIFFs](https://www.cogeo.org)\n\n## Creating PMTiles\n\nDownload the `pmtiles` binary for your system at [go-pmtiles/Releases](https://github.com/protomaps/go-pmtiles/releases).\n\n    pmtiles convert INPUT.mbtiles OUTPUT.pmtiles\n    pmtiles upload OUTPUT.pmtiles s3://my-bucket?region=us-west-2 // requires AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY env vars to be set\n\n## Consuming PMTiles\n\n### JavaScript\n\nSee [js/README.md](js/README.md) and [js/examples](js/examples) for usage in Leaflet or MapLibre GL JS.\n\nSee [openlayers/README.md](openlayers/README.md) for usage in OpenLayers.\n\n### Go\n\nSee the [go-pmtiles](https://github.com/protomaps/go-pmtiles) repository.\n\n### Python\n\nSee https://github.com/protomaps/PMTiles/tree/main/python/bin for library usage\n\n### Serverless\n\n[PMTiles on AWS Lambda](https://github.com/protomaps/PMTiles/tree/main/serverless/aws)\n\n[PMTiles on Cloudflare Workers](https://github.com/protomaps/PMTiles/tree/main/serverless/cloudflare)\n\n## Specification\n\nThe current specification version is [Version 3](./spec/v3/spec.md).\n\n## Recipes\n\nExample of how to create a PMTiles archive from the [Census Bureau Zip Code Tabulation Areas Shapefile](https://www.census.gov/geographies/mapping-files/time-series/geo/carto-boundary-file.html) using [tippecanoe](https://github.com/felt/tippecanoe):\n\n```sh\n    # use GDAL/OGR to convert SHP to GeoJSON\n    ogr2ogr -t_srs EPSG:4326 cb_2018_us_zcta510_500k.json cb_2018_us_zcta510_500k.shp\n    # Creates a layer in the vector tiles named \"zcta\"\n    tippecanoe -zg --projection=EPSG:4326 -o cb_2018_us_zcta510_500k_nolimit.pmtiles -l zcta cb_2018_us_zcta510_500k.json\n```\n\n### Uploading to Storage\n\nUsing the [PMTiles command line tool](http://github.com/protomaps/go-pmtiles):\n\n```sh\npmtiles upload LOCAL.pmtiles \"s3://BUCKET_NAME?endpoint=https://example.com\u0026region=region\" REMOTE.pmtiles\n```\n\nUsing [RClone](https://rclone.org) (do `rclone config` first)\n\n```sh\nrclone copyto LOCAL.pmtiles r2:/BUCKET/REMOTE.pmtiles --progress --s3-chunk-size=256M --s3-upload-concurrency=2\n```\n\n## License\n\nThe reference implementations of PMTiles are published under the BSD 3-Clause License. The PMTiles specification itself is public domain, or under a CC0 license where applicable.\n","funding_links":["https://github.com/sponsors/protomaps"],"categories":["TypeScript","Python","serverless","Data Sources \u0026 Platform"],"sub_categories":["Agent Skills \u0026 Tools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotomaps%2FPMTiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprotomaps%2FPMTiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotomaps%2FPMTiles/lists"}