Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cartodb/carto-print
A Python module to export images at any resolution, size and bounding box from a CARTO named map:
https://github.com/cartodb/carto-print
maps printing python
Last synced: 6 days ago
JSON representation
A Python module to export images at any resolution, size and bounding box from a CARTO named map:
- Host: GitHub
- URL: https://github.com/cartodb/carto-print
- Owner: CartoDB
- License: bsd-3-clause
- Created: 2018-10-24T18:46:42.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-03T21:34:13.000Z (about 1 year ago)
- Last Synced: 2024-08-09T22:09:22.985Z (3 months ago)
- Topics: maps, printing, python
- Language: Python
- Size: 35.2 KB
- Stars: 19
- Watchers: 24
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
carto-print
===========
A Python module to export images at any resolution, size and bounding box from a CARTO named map:
* [Maps API](https://carto.com/docs/carto-engine/maps-api)
Installation
============
You can install carto-print by cloning this repository or by using
[Pip](http://pypi.python.org/pypi/pip):
pip install carto-print
If you want to use the development version, you can install directly from github:
pip install -e git+git://github.com/CartoDB/carto-print.git#egg=carto
If using, the development version, you might want to install dependencies as well:
pip install -r requirements.txt
*Only tested in Python 3*
Usage Example
=============
Command Line Tool
-----------------
```
usage: carto-print [-h] [--api-key API_KEY] [--dpi DPI] [--img-format FORMAT]
[--output-dir DIR] [--server-url URL]
USER MAP_TPL WIDTH_CM HEIGHT_CM ZOOM BOUNDING_BOX
Exports images at any resolution, size and bounding box from a CARTO named
map.
positional arguments:
USER CARTO user name
MAP_TPL map template or named map name
WIDTH_CM width in cm
HEIGHT_CM height in cm
ZOOM zoom level
BOUNDING_BOX bounding box: south,west,north,east (min lon, min lat,
max lon, max lat)
optional arguments:
-h, --help show this help message and exit
--api-key API_KEY CARTO api_key (default: default_public)
--dpi DPI output image DPI (default: 72)
--img-format FORMAT output image format: RGBA, CMYK (default: RGBA)
--output-dir DIR output directory (default: current one)
--server-url URL server base URL, should contain the token {username}
(default: https://{username}.carto.com)
```
In this example we are exporting a 300 dpi and 30x20 cm image of the [Paris flood map](https://aromeu.carto.com/builder/87c5667f-3eb5-4a19-9300-b39a2d1970d1/embed):
```
carto-print aromeu tpl_87c5667f_3eb5_4a19_9300_b39a2d1970d1 30 20 12 1.956253,48.711127,2.835159,49.012429 --dpi 300 --img-format CMYK --output-dir /tmp
```
For bounding boxes starting with negative coordinates, use this format:
```
carto-print aromeu tpl_87c5667f_3eb5_4a19_9300_b39a2d1970d1 30 20 12 " -1.956253,48.711127,2.835159,49.012429" --dpi 300 --img-format CMYK --output-dir /tmp
```
Library
-------
The previous example calling directly the library would be as follows:
```python
from carto.print import Printer
printer = Printer('aromeu', 'tpl_87c5667f_3eb5_4a19_9300_b39a2d1970d1', 'default_public', 30, 20, 12, '1.956253,48.711127,2.835159,49.012429', 300, 'CMYK')
printer.export('/tmp')
```
Where the signature of the `Printer` constructor is as follows:
```python
Printer(CARTO_USER_NAME, MAP_ID, CARTO_API_KEY, WIDTH_CM, HEIGHT_CM, ZOOM_LEVEL, BOUNDING_BOX, DPI, IMAGE_FORMAT)
```
Where `IMAGE_FORMAT` is one of `RGBA` or `CMYK`
Known Issues
============
Some exported images may not represent exactly what you see in the map for the given zoom level when you ask for a resolution different than 72DPI. The reason is the static maps API returns images at 72DPI so to achieve a bigger resolution the library requests for bigger images to re-scale.
For this reason, specially labels and point size, line width, may be affected. If that's the case you should be able to "design your map for printing" by increaing the text, points and lines sizes.
Having said that, some of the known issues are:
- Google Maps basemaps cannot be rendered