/simple-maps

Tool to create maps with markers using cartes.io API

Primary LanguagePythonMIT LicenseMIT

Simple Maps

MIT License Code Style Black PyPI version Downloads BuyMeACoffee

This program allows the creation of maps with markers directly from the command line.

Installation

$ pip install simple-maps

Features

Simple Maps interacts with the cartes.io API to provide the following functionality:

  • Create a map with parameters: map create
  • Get information about a map: map get
  • Delete a map: map delete
  • Create a marker on a map: marker create
  • List all markers on a map: marker list
  • Edit marker description: marker edit
  • Delete a marker: marker delete

Usage:

$ simple_maps [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • map
  • marker

simple_maps map

Usage:

$ simple_maps map [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a map.
  • delete: Delete a single map.
  • get: Get a single map.

simple_maps map create

Create a map.

Usage:

$ simple_maps map create [OPTIONS]

Options:

  • --title TEXT: The title of the map
  • --slug TEXT: The map slug. Currently un-used
  • --description TEXT: The description of the map and its purpose
  • --privacy [public|unlisted|private]: The privacy level of the map: public, unlisted, private
  • --users-can-create-markers [yes|no|only_logged_in]: The setting that defines who can create markers
  • --help: Show this message and exit.

simple_maps map delete

Delete a single map.

Usage:

$ simple_maps map delete [OPTIONS]

Options:

  • --token TEXT: Token [required]
  • --map-id TEXT: Map id [required]
  • --help: Show this message and exit.

simple_maps map get

Get a single map.

Usage:

$ simple_maps map get [OPTIONS]

Options:

  • --map-id TEXT: Id of the map [required]
  • --help: Show this message and exit.

simple_maps marker

Usage:

$ simple_maps marker [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a marker on a map.
  • delete: Delete a marker on a map.
  • edit: Edit a marker on a map.
  • list: Get all markers on a map.

simple_maps marker create

Create a marker on a map.

Usage:

$ simple_maps marker create [OPTIONS]

Options:

  • --map-token TEXT: Map token [required]
  • --map-id TEXT: Map id [required]
  • --lat FLOAT RANGE: The lat position of the marker [required]
  • --lng FLOAT RANGE: The lng position of the marker [required]
  • --category INTEGER: Category ID. Use category_name if you don't know the ID
  • --category-name TEXT: Category name
  • --description TEXT: Marker description
  • --help: Show this message and exit.

simple_maps marker delete

Delete a marker on a map.

Usage:

$ simple_maps marker delete [OPTIONS]

Options:

  • --token TEXT: Token [required]
  • --map-id TEXT: Map id [required]
  • --marker-id TEXT: Marker id [required]
  • --help: Show this message and exit.

simple_maps marker edit

Edit a marker on a map.

Usage:

$ simple_maps marker edit [OPTIONS]

Options:

  • --token TEXT: Marker token [required]
  • --map-id TEXT: Map id [required]
  • --marker-id TEXT: Marker id [required]
  • --description TEXT: Marker description
  • --help: Show this message and exit.

simple_maps marker list

Get all markers on a map.

Usage:

$ simple_maps marker list [OPTIONS]

Options:

  • --map-id TEXT: Map id [required]
  • --show-expired / --no-show-expired: Show markers that have already expired
  • --help: Show this message and exit.