Package: mapbox-tilesets
tilesets-cliCLI for interacting with and preparing data for theMapbox Tiling Service.📚 If you have a question that isn't answered here, please refer to the completeMapbox Tiling Service documentation.ContributingCONTRIBUTING.mdincludes information about release processes & running tests. :raised_hands:InstallationRequirementsPython >= 3.6 (can be installed via virtualenv)Recommended:virtualenv/virtualenvwrapperBasic installationpip install mapbox-tilesetswill install everything butestimate-area.Installing optionalestimate-areacommandIf you are using an x86 Mac or Linux machine, run:pip install 'mapbox-tilesets[estimate-area]'Otherwise, you will need to install some dependencies.arm64 MacOSIf you're on an arm64 Mac (e.g., with an M1 chip), you'll need to installGDALfirst. On Mac, a simple way is to useHomebrew:$brewinstallgdal
...
$pipinstall'mapbox-tilesets[estimate-area]'WindowsNote, Windows is not officially supported at this time.Windows users need to installGDALandrasterio.
Thenpip install 'mapbox-tilesets[estimate-area]'Mapbox Access TokensIn order to use the tilesets endpoints, you need a Mapbox Access Token withtilesets:write,tilesets:read, andtilesets:listscopes. This is a secret token, so do not share it publicly!You can either pass the Mapbox access token to each command with the--tokenflag or export it as an environment variable. Acceptable values are:MAPBOX_ACCESS_TOKENMapboxAccessTokenSet the environment variable withexportexport MAPBOX_ACCESS_TOKEN=my.tokenCommandsTileset Sourcesupload-sourcedeprecatedadd-sourcevalidate-sourceview-sourcelist-sourcesdelete-sourceestimate-areaRecipesview-recipevalidate-recipeupdate-recipeTilesetscreatepublishupdatedeletestatusjobjobslisttilejsonActivitylist-activityupload-sourcetilesetsupload-source<username><source_id><file>Uploads GeoJSON files to a source for tiling. Accepts line-delimited GeoJSON or GeoJSON feature collections as files or viastdin. The CLI automatically converts data to line-delimited GeoJSON prior to uploading. Can be used to add data to a source or to replace all of the data in a source with the--replaceflag.Please note that if your source data is a FeatureCollection,tilesetsmust read it all into memory to split it up into separate features before uploading it to the Tilesets API. You are strongly encouraged to provide your data in line-delimited GeoJSON format instead, especially if it is large.Flags:--no-validation[optional]: do not validate source data locally before uploading--replace[optional]: delete all existing source data and replace with data from the file--quiet[optional]: do not display an upload progress barUsage# single filetilesetsupload-source<username><source_id>./file.geojson# multiple filestilesetsupload-source<username><source_id>file-1.geojsonfile-4.geojson# directory of files# Reading from a directory will not distinguish between GeoJSON files and non GeoJSON files. All source files will be run through our validator unless you pass the `--no-validation` flag.tilesetsupload-source<username><source_id>./path/to/multiple/files/deprecatedadd-sourceWARNING: add-source is maintained for legacy purposes. Please use theupload-sourcecommand instead.tilesetsadd-source<username><source_id><file>Adds GeoJSON files to a source for tiling. Accepts line-delimited GeoJSON or GeoJSON feature collections as files or viastdin. The CLI automatically converts data to line-delimited GeoJSON prior to uploading.Please note that if your source data is a FeatureCollection,tilesetsmust read it all into memory to split it up into separate features before uploading it to the Tilesets API. You are strongly encouraged to provide your data in line-delimited GeoJSON format instead, especially if it is large.Flags:--no-validation[optional]: do not validate source data locally before uploading--quiet[optional]: do not display an upload progress barUsage# single filetilesetsadd-source<username><source_id>./file.geojson# multiple filestilesetsadd-source<username><source_id>file-1.geojsonfile-4.geojson# directory of files# Reading from a directory will not distinguish between GeoJSON files and non GeoJSON files. All source files will be run through our validator unless you pass the `--no-validation` flag.tilesetsadd-source<username><source_id>./path/to/multiple/files/validate-sourcetilesetsvalidate-source<path>Validates a line delimited GeoJSON source file locally. Example error output:Invalidlinedelimitedgeojson.view-sourcetilesets view-source <username> <source_id>Get information for a tileset source, such as number of files, the size in bytes, and the ID in mapbox:// protocol format.list-sourcestilesets list-sources <username>List all tileset sources from a particular account. Response is an array of sources.delete-sourcetilesets delete-source <username> <source_id>Permanently delete a tileset source and all of its files. This is not a recoverable action!Flags:-for--force: Do not ask for confirmation before deletingUsage# to delete mapbox://tileset-source/user/source_idtilesetsdelete-sourceusersource_idestimate-areatilesetsestimate-area<features>-p/--precision<precision>Estimates tiled area (km2) of features with a specified precision. Accepts line-delimited GeoJSON or GeoJSON feature collections as files or viastdinor a list of string-encoded coordinate pairs of the form "[lng, lat]", or "lng, lat", or "lng lat". Precision must be 10m, 1m, 30cm or 1cm.Flags:-por--precision[required]: precision level--no-validation[optional]: do not validate source data locally before area calculation--force-1cm[optional]: the --force-1cm flag must be present to enable 1cm precision area calculation and may take longer for large feature inputs or data with global extents. 1cm precision for tileset processing is only available upon request after contactingMapbox supportUsage# GeoJSON feature filestilesetsestimate-area./file1.geojson./file2.geojson-p<precision># GeoJSON features in stdin redirection 1tilesetsestimate-area-p<precision><./file.geojson# GeoJSON features in stdin redirection 2cat./file.geojson|tilesetsestimate-area-p<precision># GeoJSON features in stdin streamtilesetsestimate-area--precision<precision>
<features># coordinate pairs (must be in quotes)tilesetsestimate-area"[lng,lat]""[lng,lat]"--precision<precision>view-recipePrints the Recipe JSON to stdout.tilesetsview-recipe<tileset_id>validate-recipeValidates a Recipe JSON document.tilesetsvalidate-recipe/path/to/recipe.jsonExamplerecipe.json:{
  "version": 1,
  "layers": {
    "trees": {
      "source": "mapbox://tileset-source/{username}/trees-data",
      "minzoom": 4,
      "maxzoom": 8
    }
  }
}See more details about the recipe spechere.
See recipe exampleshere.Example error output:{"errors":["Unknown top-level key \"potato\"."],"valid":false}update-recipeUpdate the Recipe JSON for a tileset. Performs a server-side validation of the new document.This command only supports tilesets created with theMapbox Tiling Service.tilesetsupdate-recipe<tileset_id>/path/to/recipe.jsoncreateCreates a brand new, empty tileset with a recipe passed in from your local filesystem.tilesetscreate<tileset_id>--recipe/path/to/recipe.json--name"My neat tileset"Thetileset_idis in the form ofusername.handle- for example "mapbox.neat-tileset". The handle may only include "-" or "_" special characters and must be 32 characters or fewer.Flags:--recipeor-r[required]: path to your Recipe JSON document--nameor-n[required]: human-readable name of your tileset. (If your tileset_id is user.my_amazing_tileset, you might want yournamefield to be "My Amazing Tileset".)--descriptionor-d: description of your tileset--privacyor-p: Set the privacy of the tileset. Allowed values areprivateandpublic. By default, new tilesets are private.--attributionor-a[optional]: set tileset attribution. Must be a JSON string, specifically an array of attribution objects, each withtextandlinkkeys. Limited to three attribution objects, 80 characters maximum combined across all text values, and 1000 characters maximum combined across all link values.publishQueues a tilingjobusing the recipe provided. Use to publish a new tileset or update an existing one. Returns a job ID for progress tracking.This command only supports tilesets created with theMapbox Tiling Service.tilesets publish <tileset_id>updateUpdate a tileset's information.tilesets update <tileset_id>
  --name "Hello World"
  --description "Say hi to the world"
  --privacy=private
  --attribution='[{"text":"© Hola Mundo","link":"http://example.com"}]'Flags:--nameor-n[optional]: update tileset name--descriptionor-d[optional]: update tileset description--privacyor-p[optional]: set your tileset topublicorprivate--attributionor-a[optional]: set tileset attribution. Must be a JSON string, specifically an array of attribution objects, each withtextandlinkkeys. Limited to three attribution objects, 80 characters maximum combined across all text values, and 1000 characters maximum combined across all link values.deleteDelete a tileset. By default will prompt you for confirmation before deleting.tilesets delete <tileset_id>Flags:--forceor-fto bypass confirmation prompt.statusView the status of the most recent job for a tileset. To get more detailed information about a tileset's jobs, including the timestamps of failed and successful jobs, use thetilesets jobs <tileset_id>command.tilesets status <tileset_id>jobRetrieve a single job for a tileset.This command only supports tilesets created with theMapbox Tiling Service.tilesetsjob<tileset_id><job_id>What is a job?Each time you generate or regenerate your output tileset via thepublishcommand (whether that's a new recipe or new source data), a single job is created that processes your data. A tileset can have many jobs, each with a unique identifier. When you publish a tileset, the HTTP response includes the unique job identifier that corresponds to the most recent job. To read more about HTTP design, see thisdocumentation.jobsCheck all jobs associated with a tileset. You can filter jobs by a particularstage- processing, queued, success, or failed.This command only supports tilesets created with theMapbox Tiling Service.tilesetsjobs<tileset_id>--stage=processingFlags:--stage[optional]: filter by the stage of jobs--limit [1-500][optional]: the maximum number of results to return, from 1 to 500. The default is 100.listList all tilesets for an account. Just lists tileset IDs by default. Use the--verboseoption for more information.tilesetslist<username>Flags:--type [vector|raster][optional]: filter results by tileset type--visibility [public|private][optional]: filter results by visibility--sortby [created|modified][optional]: sort results by theircreatedormodifiedtimestamps--limit [1-500][optional]: the maximum number of results to return, from 1 to 500. The default is 100.--verbose[optional]: will list out the entire response object from the APItilejsonView the TileJSON for a tileset.tileset_idcan be a comma-separated list of up to 15 tilesets for composited requests.A TileJSON document, according to thespecification, attempts to create a standard for representing metadata about multiple types of web-based layers, to aid clients in configuration and browsing.tilesets tilejson <tileset_id>Flags:--secure: By default, resource URLs in the retrieved TileJSON (such as in the "tiles" array) will use the HTTP scheme. Include this query parameter in your request to receive HTTPS resource URLs instead.list-activityLists total request counts for a user's tilesets in the past 30 days. Returns a pagination keynextif there are more results than the return limit that can be passed into another command as thestartargument.tilesetslist-activity<account>Flags:--sortby [requests|modified][optional]: Sorting key (default: requests)--orderby [asc|desc][optional]: Ordering key (default: desc)--limit [1-500][optional]: The maximum number of results to return (default: 100)--indent[optional]: Indent size for JSON output.--start[optional]: Pagination key from thenextvalue in a response that has more results than the limit.