Mapmaker

https://pypi.org/project/mapmaker/
Admin
Mapmaker is a Python tool that generates map images from slippy map tiles, downloading tiles from...
Tokens:4,802
Snippets:66
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install mapmaker using setup.py

Source: https://pypi.org/project/mapmaker

Alternatively, install mapmaker by running its setup script.

```bash
$ python setup.py install
```

--------------------------------

### Install mapmaker using pip

Source: https://pypi.org/project/mapmaker

Use this command to install the mapmaker package via pip.

```bash
pip install mapmaker
```

--------------------------------

### Configure Custom Tile Services

Source: https://pypi.org/project/mapmaker

Define custom tile services in the INI configuration file. Each service section must start with 'service.' and can include URL patterns, tile size, subdomains, and API keys.

```ini
[service.osm]
osm   = https://tile.openstreetmap.org/{z}/{x}/{y}.png

[service.opentopo]
subdomains = abc
topo       = https://{s}.tile.opentopomap.org/{z}/{x}/{y}.png
```

```ini
[service.example]
tile_size  = 512
api_key    = my-secret-api-key
subdomains = abcdef
```

--------------------------------

### Handle negative coordinates

Source: https://pypi.org/project/mapmaker

Use '--' to indicate the end of command line flags when coordinates start with a negative value.

```bash
$ mapmaker -- -32.653197,-70.0112 100km
```

--------------------------------

### Draw GeoJSON Polygon Geometry

Source: https://pypi.org/project/mapmaker

GeoJSON Geometry objects can be used directly. This example shows a Polygon with properties for color and fill.

```json
{
  "type": "Polygon",
  "coordinates": [
    [8.612316, 47.680632],
    [8.612316, 47.676327],
    [8.617423, 47.676327],
    [8.617423, 47.680632]
  ]
  "color": [60, 9, 108],
  "fill": [60, 9, 108, 120]
}
```

--------------------------------

### Draw GeoJSON Point Feature

Source: https://pypi.org/project/mapmaker

The --geojson option can draw GeoJSON objects. This example shows a Point feature with properties for symbol, color, and size.

```json
{
  "type": "Feature",
  "geometry": {
    "type": "Point",
    "coordinates": [12.594474, 55.691438]
  },
  "properties": {
    "symbol": "square",
    "color": [10, 147, 150],
    "size": 12
  }
}
```

--------------------------------

### Create Map Gallery

Source: https://pypi.org/project/mapmaker

Use the --gallery flag to render a map for each available style, outputting to a specified directory. This flag overrides the --style parameter.

```bash
$ mapmaker --gallery output_directory
```

--------------------------------

### Configure Custom Tile Services

Source: https://pypi.org/project/mapmaker/1.6.1

Define custom tile services by specifying URL patterns for tile downloads. Supported variables include {z}, {x}, and {y}. Optional placeholders for subdomains and API keys can also be included.

```ini
[service.osm]
osm   = https://tile.openstreetmap.org/{z}/{x}/{y}.png

[service.opentopo]
subdomains = abc
topo       = https://{s}.tile.opentopomap.org/{z}/{x}/{y}.png
```

```ini
[service.example]
tile_size  = 512
api_key    = my-secret-api-key
subdomains = abcdef
```

```ini
topo        = https://{s}.tile.opentopomap.org/{z}/{x}/{y}.png
                      ^^^
atlas = https://tile.thunderforest.com/atlas/{z}/{x}/{y}.png?apikey={api}
                                                                     ^^^
```

--------------------------------

### Generate map from bounding box

Source: https://pypi.org/project/mapmaker

Create a map image (map.png) by specifying a bounding box with two pairs of lat/lon coordinates.

```bash
$ mapmaker  47.44,10.95 47.37,11.13
```

--------------------------------

### API Key Authorization Configuration

Source: https://pypi.org/project/mapmaker

Configure API keys for services requiring authorization by placing them in the INI file under the corresponding service section. Ensure the key name matches the placeholder in the URL pattern.

```ini
# ~/.config/mapmaker/config.ini

[service.thunderforest]
api_key = YOUR_API_KEY

[service.geoapify]
api_key = YOUR_API_KEY

[service.mapbox]
api_key = YOUR_API_KEY
```

--------------------------------

### URL Pattern Placeholders

Source: https://pypi.org/project/mapmaker

URL patterns for tile services must include placeholders for zoom level (z), X-coordinate (x), and Y-coordinate (y). Optional placeholders for subdomains ({s}) and API keys ({api}) can also be included.

```text
topo        = https://{s}.tile.opentopomap.org/{z}/{x}/{y}.png
                      ^^^
atlas = https://tile.thunderforest.com/atlas/{z}/{x}/{y}.png?apikey={api}
                                                                     ^^^
```

--------------------------------

### Specify output file name

Source: https://pypi.org/project/mapmaker

You can specify a custom name for the output map image file.

```bash
$ mapmaker 63.0695,-151.0074 100km denali.png
```

--------------------------------

### Generate map from center point and radius

Source: https://pypi.org/project/mapmaker

Generate a map image centered on a specific point with a given radius.

```bash
$ mapmaker 63.0695,-151.0074 100km
```

--------------------------------

### Specify coordinates in DMS format

Source: https://pypi.org/project/mapmaker

Coordinates can be provided in Degrees, Minutes, Seconds (DMS) format. Ensure quotes are used around the argument.

```bash
$ mapmaker "63°4'10.2'' N, 151°0'26.64'' W" 4km
```

--------------------------------

### Specify map style

Source: https://pypi.org/project/mapmaker

Customize the visual appearance of the map using the --style flag.

```bash
$ mapmaker 63.0695,-151.0074 100km --style human
```

--------------------------------

### Add Scale Bar to Map

Source: https://pypi.org/project/mapmaker

Use the --scale flag to display a scale bar. Optional arguments control placement, width, color, label style, and underlay.

```bash
$ mapmaker 45.83,6.88 100km --scale
```

```bash
$ mapmaker 45.83,6.88 100km --scale SE
```

```bash
$ mapmaker 45.83,6.88 100km --scale 1
```

```bash
$ mapmaker 45.83,6.88 100km --scale 120,120,120
```

```bash
$ mapmaker 45.83,6.88 100km --scale nolabel
```

```bash
$ mapmaker 45.83,6.88 100km --scale full
```

```bash
$ mapmaker 45.83,6.88 100km --scale SE 1 120,120,120 nolabel full
```

--------------------------------

### Specify image aspect ratio

Source: https://pypi.org/project/mapmaker

Set the desired aspect ratio for the output map image. The map will be extended to match the ratio while containing the specified area.

```bash
$ mapmaker 45.83,6.88 100km --aspect 16:9
```

--------------------------------

### Add Comment to Map

Source: https://pypi.org/project/mapmaker

Use the --comment flag to add small print text to the map. Arguments are similar to --title, specifying placement and color.

```bash
$ mapmaker 45.83,6.88 100km --comment My Comment
```

```bash
$ mapmaker 45.83,6.88 100km --comment SE 200,200,200 My Comment
```

--------------------------------

### Add Title to Map

Source: https://pypi.org/project/mapmaker

Use the --title flag to add a headline to the map. Optional arguments include placement (cardinal directions), border width in pixels, and RGB(A) color values for the text and background.

```bash
$ mapmaker 45.83,6.88 100km --title My Map
```

```bash
$ mapmaker 45.83,6.88 100km --title NNW My Map
```

```bash
$ mapmaker 45.83,6.88 100km --title NNW 5 My Map
```

```bash
$ mapmaker 45.83,6.88 100km --title NNW 5 255,0,0 My Map
```

```bash
$ mapmaker 45.83,6.88 100km --title NNW 5 255,0,0 0,0,255 My Map
```

--------------------------------

### Specify zoom level

Source: https://pypi.org/project/mapmaker

Control the detail and resolution of the map image by setting the zoom level. The default is 8.

```bash
$ mapmaker 63.0695,-151.0074 100km --zoom 12
```

--------------------------------

### Apply Margin to Map

Source: https://pypi.org/project/mapmaker

Use the --margin flag to add a border around the map. The margin can be specified as a single value (all sides), two values (top/bottom, left/right), or four values (top, right, bottom, left).

```bash
$ mapmaker 45.83,6.88 100km --margin 50
```

```bash
$ mapmaker 45.83,6.88 100km --margin 20 40
```

```bash
$ mapmaker 45.83,6.88 100km --margin 10 15 20 15
```

--------------------------------

### Set Margin Background Color

Source: https://pypi.org/project/mapmaker

Control the color of the margin area using the --background flag with RGB(A) values or hex codes.

```bash
$ mapmaker 45.83,6.88 100km --margin 10 --background 200,200,200
```

```bash
$ mapmaker 45.83,6.88 100km --margin 10 --background 200,200,200,128
```

--------------------------------

### Add Frame to Map

Source: https://pypi.org/project/mapmaker

The --frame argument adds a border between the map content and the margin area. Optional parameters include width, main color, secondary color (for alternating styles), and style ('solid' or 'coordinates').

```bash
$ mapmaker 45.83,6.88 100km --frame
```

```bash
$ mapmaker 45.83,6.88 100km --frame 12
```

```bash
$ mapmaker 45.83,6.88 100km --frame 12 255,0,0
```

```bash
$ mapmaker 45.83,6.88 100km --frame 12 255,0,0 0,0,255 coordinates
```

```bash
$ mapmaker 45.83,6.88 100km --frame coordinates
```
Tokens:
Raw