def delete(tileset, token=None, indent=None, force=None):
"""Delete your tileset.
tilesets delete <tileset_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
if not force:
val = click.prompt(
'To confirm tileset deletion please enter the full tileset id "{0}"'.format(
tileset
),
type=str,
)
if val != tileset:
raise click.ClickException(f"{val} does not match {tileset}. Aborted!")
url = "{0}/tilesets/v1/{1}?access_token={2}".format(
mapbox_api, tileset, mapbox_token
)
r = s.delete(url)
if r.status_code == 200 or r.status_code == 204:
click.echo("Tileset deleted.")
else:
raise errors.TilesetsError(r.text)
def tilejson(tileset, token=None, indent=None, secure=False):
"""View the TileJSON of a particular tileset.
Can take a comma-separated list of tilesets for a composited TileJSON.
tilesets tilejson <tileset_id>,<tileset_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
# validate tilesets by splitting comma-delimted string
# and rejoining it
for t in tileset.split(","):
if not utils.validate_tileset_id(t):
raise errors.TilesetNameError(t)
url = "{0}/v4/{1}.json?access_token={2}".format(mapbox_api, tileset, mapbox_token)
if secure:
url = url + "&secure"
r = s.get(url)
if r.status_code == 200:
click.echo(json.dumps(r.json(), indent=indent))
else:
raise errors.TilesetsError(r.text)
def publish(tileset, token=None, indent=None):
"""Publish your tileset.
Only supports tilesets created with the Mapbox Tiling Service.
tilesets publish <tileset_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}/publish?access_token={2}".format(
mapbox_api, tileset, mapbox_token)
r = s.post(url)
if r.status_code == 200:
response_msg = r.json()
click.echo(json.dumps(response_msg, indent=indent))
studio_url = click.style(
f"https://studio.mapbox.com/tilesets/{tileset}", bold=True)
job_id = response_msg["jobId"]
job_cmd = click.style(f"tilesets job {tileset} {job_id}", bold=True)
message = f"\n✔ Tileset job received. Visit {studio_url} or run {job_cmd} to view the status of your tileset."
# print(message)
click.echo(
message,
err=
True, # print to stderr so the JSON output can be parsed separately from the success message
)
else:
raise errors.TilesetsError(r.text)
def delete_source(username, id, force, token=None):
"""Delete a Tileset Source + all of its files.
tilesets delete-source <username> <id>
"""
if not force:
val = click.prompt(
'To confirm source deletion please enter the full source id "{0}/{1}"'.format(
username, id
),
type=str,
)
if val != f"{username}/{id}":
raise click.ClickException(
f"{val} does not match {username}/{id}. Aborted!"
)
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/sources/{1}/{2}?access_token={3}".format(
mapbox_api, username, id, mapbox_token
)
r = s.delete(url)
if r.status_code == 204:
click.echo("Source deleted.")
else:
raise errors.TilesetsError(r.text)
def validate_recipe(recipe, token=None, indent=None):
"""Validate a Recipe JSON document
tilesets validate-recipe <path_to_recipe>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/validateRecipe?access_token={1}".format(
mapbox_api, mapbox_token)
with open(recipe) as json_recipe:
recipe_json = json.load(json_recipe)
r = s.put(url, json=recipe_json)
click.echo(json.dumps(r.json(), indent=indent))
def view_source(username, id, token=None, indent=None):
"""View a Tileset Source's information
tilesets view-source <username> <source_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/sources/{1}/{2}?access_token={3}".format(
mapbox_api, username, id, mapbox_token)
r = s.get(url)
if r.status_code == 200:
click.echo(json.dumps(r.json(), indent=indent))
else:
raise errors.TilesetsError(r.text)
def view_recipe(tileset, token=None, indent=None):
"""View a tileset's recipe JSON
tilesets view-recipe <tileset_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}/recipe?access_token={2}".format(
mapbox_api, tileset, mapbox_token)
r = s.get(url)
if r.status_code == 200:
click.echo(json.dumps(r.json(), indent=indent))
else:
raise errors.TilesetsError(r.text)
def job(tileset, job_id, token=None, indent=None):
"""View a single job for a particular tileset.
Only supports tilesets created with the Mapbox Tiling Service.
tilesets job <tileset_id> <job_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}/jobs/{2}?access_token={3}".format(
mapbox_api, tileset, job_id, mapbox_token)
r = s.get(url)
click.echo(json.dumps(r.json(), indent=indent))
def jobs(tileset, stage=None, limit=None, token=None, indent=None):
"""View all jobs for a particular tileset.
Only supports tilesets created with the Mapbox Tiling Service.
tilesets jobs <tileset_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}/jobs?access_token={2}".format(
mapbox_api, tileset, mapbox_token)
url = "{0}&limit={1}".format(url, limit) if limit else url
url = "{0}&stage={1}".format(url, stage) if stage else url
r = s.get(url)
click.echo(json.dumps(r.json(), indent=indent))
def list_sources(username, token=None):
"""List all Tileset Sources for an account. Response is an un-ordered array of sources.
tilesets list-sources <username>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/sources/{1}?access_token={2}".format(
mapbox_api, username, mapbox_token)
r = s.get(url)
if r.status_code == 200:
for source in r.json():
click.echo(source["id"])
else:
raise errors.TilesetsError(r.text)
def create(
tileset,
recipe,
name=None,
description=None,
privacy=None,
attribution=None,
token=None,
indent=None,
):
"""Create a new tileset with a recipe.
$ tilesets create <tileset_id>
<tileset_id> is in the form of username.handle - for example "mapbox.neat-tileset".
The handle may only include "-" or "_" special characters and must be 32 characters or fewer.
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}?access_token={2}".format(
mapbox_api, tileset, mapbox_token
)
body = {}
body["name"] = name or ""
body["description"] = description or ""
if privacy:
body["private"] = True if privacy == "private" else False
if not utils.validate_tileset_id(tileset):
raise errors.TilesetNameError(tileset)
if recipe:
with open(recipe) as json_recipe:
body["recipe"] = json.load(json_recipe)
if attribution:
try:
body["attribution"] = json.loads(attribution)
except:
click.echo("Unable to parse attribution JSON")
click.exit(1)
r = s.post(url, json=body)
click.echo(json.dumps(r.json(), indent=indent))
def status(tileset, token=None, indent=None):
"""View the current queue/processing/complete status of your tileset.
tilesets status <tileset_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}/jobs?limit=1&access_token={2}".format(
mapbox_api, tileset, mapbox_token)
r = s.get(url)
status = {}
for job in r.json():
status["id"] = job["tilesetId"]
status["latest_job"] = job["id"]
status["status"] = job["stage"]
click.echo(json.dumps(status, indent=indent))
def update_recipe(tileset, recipe, token=None, indent=None):
"""Update a Recipe JSON document for a particular tileset
Only supports tilesets created with the Mapbox Tiling Service.
tilesets update-recipe <tileset_id> <path_to_recipe>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}/recipe?access_token={2}".format(
mapbox_api, tileset, mapbox_token)
with open(recipe) as json_recipe:
recipe_json = json.load(json_recipe)
r = s.patch(url, json=recipe_json)
if r.status_code == 201 or r.status_code == 204:
click.echo("Updated recipe.", err=True)
else:
raise errors.TilesetsError(r.text)
def publish(tileset, token=None, indent=None):
"""Publish your tileset.
Only supports tilesets created with the Mapbox Tiling Service.
tilesets publish <tileset_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}/publish?access_token={2}".format(
mapbox_api, tileset, mapbox_token)
r = s.post(url)
if r.status_code == 200:
click.echo(json.dumps(r.json(), indent=indent))
click.echo(
f"You can view the status of your tileset with the `tilesets status {tileset}` command.",
err=True,
)
else:
raise errors.TilesetsError(r.text)
def list(
username,
verbose,
type=None,
visibility=None,
sortby=None,
limit=None,
token=None,
indent=None,
):
"""List all tilesets for an account.
By default the response is a simple list of tileset IDs.
If you would like an array of all tileset's information,
use the --versbose flag.
tilests list <username>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}?access_token={2}".format(
mapbox_api, username, mapbox_token
)
url = "{0}&limit={1}".format(url, limit) if limit else url
url = "{0}&type={1}".format(url, type) if type else url
url = "{0}&visibility={1}".format(url, visibility) if visibility else url
url = "{0}&sortby={1}".format(url, sortby) if sortby else url
r = s.get(url)
if r.status_code == 200:
if verbose:
for tileset in r.json():
click.echo(json.dumps(tileset, indent=indent))
else:
for tileset in r.json():
click.echo(tileset["id"])
else:
raise errors.TilesetsError(r.text)
def update(
tileset,
token=None,
indent=None,
name=None,
description=None,
privacy=None,
attribution=None,
):
"""Update a tileset's information.
tilesets update <tileset_id>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = "{0}/tilesets/v1/{1}?access_token={2}".format(
mapbox_api, tileset, mapbox_token
)
body = {}
if name:
body["name"] = name
if description:
body["description"] = description
if privacy:
body["private"] = True if privacy == "private" else False
if attribution:
try:
body["attribution"] = json.loads(attribution)
except:
click.echo("Unable to parse attribution JSON")
click.exit(1)
r = s.patch(url, json=body)
if r.status_code != 204:
raise errors.TilesetsError(r.text)
def test_get_session():
s = _get_session("my_application", "1.0.0")
assert "user-agent" in s.headers
assert s.headers["user-agent"] == "my_application/1.0.0"
def _upload_source(
ctx, username, id, features, no_validation, quiet, replace, token=None, indent=None
):
"""Create/add a tileset source
tilesets add-source <username> <id> <path/to/source/data>
"""
mapbox_api = utils._get_api()
mapbox_token = utils._get_token(token)
s = utils._get_session()
url = (
f"{mapbox_api}/tilesets/v1/sources/{username}/{id}?access_token={mapbox_token}"
)
method = "post"
if replace:
method = "put"
# This does the decoding by hand instead of using pyjwt because
# pyjwt rejects tokens that don't pad the base64 with = signs.
token_parts = mapbox_token.split(".")
if len(token_parts) < 2:
raise errors.TilesetsError(
f"Token {mapbox_token} does not contain a payload component"
)
else:
while len(token_parts[1]) % 4 != 0:
token_parts[1] = token_parts[1] + "="
body = json.loads(base64.b64decode(token_parts[1]))
if "u" in body:
if username != body["u"]:
raise errors.TilesetsError(
f"Token username {body['u']} does not match username {username}"
)
else:
raise errors.TilesetsError(
f"Token {mapbox_token} does not contain a username"
)
with tempfile.TemporaryFile() as file:
for feature in features:
if not no_validation:
utils.validate_geojson(feature)
file.write(
(json.dumps(feature, separators=(",", ":")) + "\n").encode("utf-8")
)
file.seek(0)
m = MultipartEncoder(fields={"file": ("file", file)})
if quiet:
resp = getattr(s, method)(
url,
data=m,
headers={
"Content-Disposition": "multipart/form-data",
"Content-type": m.content_type,
},
)
else:
prog = click.progressbar(
length=m.len, fill_char="=", width=0, label="upload progress"
)
with prog:
def callback(m):
prog.pos = m.bytes_read
prog.update(0) # Step is 0 because we set pos above
monitor = MultipartEncoderMonitor(m, callback)
resp = getattr(s, method)(
url,
data=monitor,
headers={
"Content-Disposition": "multipart/form-data",
"Content-type": monitor.content_type,
},
)
if resp.status_code == 200:
click.echo(json.dumps(resp.json(), indent=indent))
else:
raise errors.TilesetsError(resp.text)