| Name | smellman-mbutil JSON |
| Version |
0.3.4
JSON |
| download |
| home_page | None |
| Summary | An importer and exporter for MBTiles |
| upload_time | 2025-07-25 12:26:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Copyright (c), Development Seed
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
- Neither the name "Development Seed" nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
map
mbtiles
tiles
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MBUtil
MBUtil is a utility for importing and exporting the [MBTiles](http://mbtiles.org/) format,
typically created with [Mapbox](http://mapbox.com/) [TileMill](http://mapbox.com/tilemill/).
Before exporting tiles to disk, see if there's a [Mapbox Hosting plan](http://mapbox.com/plans/)
or an open source [MBTiles server implementation](https://github.com/mapbox/mbtiles-spec/wiki/Implementations)
that works for you - tiles on disk are notoriously difficult to manage.
[](http://travis-ci.org/mapbox/mbutil)
**Note well**: this project is no longer actively developed. Issues and pull requests will be attended to when possible, but delays should be expected.
## Installation
Git checkout (requires git)
git clone https://github.com/mapbox/mbutil.git
cd mbutil
# get usage
./mb-util -h
Then to install the mb-util command globally:
sudo python setup.py install
# then you can run:
mb-util
Python installation (requires easy_install)
easy_install mbutil
mb-util -h
## Usage
$ mb-util -h
Usage: mb-util [options] input output
Examples:
Export an mbtiles file to a directory of files:
$ mb-util world.mbtiles tiles # tiles must not already exist
Import a directory of tiles into an mbtiles file:
$ mb-util tiles world.mbtiles # mbtiles file must not already exist
Options:
-h, --help Show this help message and exit
--scheme=SCHEME Tiling scheme of the tiles. Default is "xyz" (z/x/y),
other options are "tms" which is also z/x/y
but uses a flipped y coordinate, and "wms" which replicates
the MapServer WMS TileCache directory structure "z/000/000/x/000/000/y.png"''',
and "zyx" which is the format vips dzsave --layout google uses.
--image_format=FORMAT
The format of the image tiles, either png, jpg, webp, pbf or mvt
--grid_callback=CALLBACK
Option to control JSONP callback for UTFGrid tiles. If
grids are not used as JSONP, you can
remove callbacks specifying --grid_callback=""
--do_compression Do mbtiles compression
--silent Dictate whether the operations should run silently
Export an `mbtiles` file to files on the filesystem:
mb-util World_Light.mbtiles adirectory
Import a directory into a `mbtiles` file
mb-util directory World_Light.mbtiles
## Requirements
* Python `>= 3.8`
## Metadata
MBUtil imports and exports metadata as JSON, in the root of the tile directory, as a file named `metadata.json`.
```javascript
{
"name": "World Light",
"description": "A Test Metadata",
"version": "3"
}
```
## Testing
This project uses pytest for testing. Install pytest:
hatch env create
hatch test
## See Also
* [node-mbtiles provides mbpipe](https://github.com/mapbox/node-mbtiles/wiki/Post-processing-MBTiles-with-MBPipe), a useful utility.
* [mbliberator](https://github.com/calvinmetcalf/mbliberator) a similar program but in node.
## License
BSD - see LICENSE.md
## Authors
- Tom MacWright (tmcw)
- Dane Springmeyer (springmeyer)
- Mathieu Leplatre (leplatrem)
Raw data
{
"_id": null,
"home_page": null,
"name": "smellman-mbutil",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "map, mbtiles, tiles",
"author": null,
"author_email": "Tom MacWright <tom@macwright.org>",
"download_url": "https://files.pythonhosted.org/packages/81/9e/f13a7646ff7742847f0d213913e4395200d40045d9832f46db54df40d117/smellman_mbutil-0.3.4.tar.gz",
"platform": null,
"description": "# MBUtil\n\nMBUtil is a utility for importing and exporting the [MBTiles](http://mbtiles.org/) format,\ntypically created with [Mapbox](http://mapbox.com/) [TileMill](http://mapbox.com/tilemill/).\n\nBefore exporting tiles to disk, see if there's a [Mapbox Hosting plan](http://mapbox.com/plans/)\nor an open source [MBTiles server implementation](https://github.com/mapbox/mbtiles-spec/wiki/Implementations)\nthat works for you - tiles on disk are notoriously difficult to manage.\n\n[](http://travis-ci.org/mapbox/mbutil)\n\n**Note well**: this project is no longer actively developed. Issues and pull requests will be attended to when possible, but delays should be expected.\n\n## Installation\n\nGit checkout (requires git)\n\n git clone https://github.com/mapbox/mbutil.git\n cd mbutil\n # get usage\n ./mb-util -h\n\nThen to install the mb-util command globally:\n\n sudo python setup.py install\n # then you can run:\n mb-util\n\nPython installation (requires easy_install)\n\n easy_install mbutil\n mb-util -h\n\n## Usage\n\n $ mb-util -h\n Usage: mb-util [options] input output\n\n Examples:\n\n Export an mbtiles file to a directory of files:\n $ mb-util world.mbtiles tiles # tiles must not already exist\n\n Import a directory of tiles into an mbtiles file:\n $ mb-util tiles world.mbtiles # mbtiles file must not already exist\n\n Options:\n -h, --help Show this help message and exit\n --scheme=SCHEME Tiling scheme of the tiles. Default is \"xyz\" (z/x/y),\n other options are \"tms\" which is also z/x/y\n but uses a flipped y coordinate, and \"wms\" which replicates\n the MapServer WMS TileCache directory structure \"z/000/000/x/000/000/y.png\"''',\n and \"zyx\" which is the format vips dzsave --layout google uses.\n --image_format=FORMAT\n The format of the image tiles, either png, jpg, webp, pbf or mvt\n --grid_callback=CALLBACK\n Option to control JSONP callback for UTFGrid tiles. If\n grids are not used as JSONP, you can\n remove callbacks specifying --grid_callback=\"\"\n --do_compression Do mbtiles compression\n --silent Dictate whether the operations should run silently\n\n\n Export an `mbtiles` file to files on the filesystem:\n\n mb-util World_Light.mbtiles adirectory\n\n\n Import a directory into a `mbtiles` file\n\n mb-util directory World_Light.mbtiles\n\n## Requirements\n\n* Python `>= 3.8`\n\n## Metadata\n\nMBUtil imports and exports metadata as JSON, in the root of the tile directory, as a file named `metadata.json`.\n\n```javascript\n{\n \"name\": \"World Light\",\n \"description\": \"A Test Metadata\",\n \"version\": \"3\"\n}\n```\n\n## Testing\n\nThis project uses pytest for testing. Install pytest:\n\n hatch env create\n hatch test\n\n## See Also\n\n* [node-mbtiles provides mbpipe](https://github.com/mapbox/node-mbtiles/wiki/Post-processing-MBTiles-with-MBPipe), a useful utility.\n* [mbliberator](https://github.com/calvinmetcalf/mbliberator) a similar program but in node.\n\n## License\n\nBSD - see LICENSE.md\n\n## Authors\n\n- Tom MacWright (tmcw)\n- Dane Springmeyer (springmeyer)\n- Mathieu Leplatre (leplatrem)\n",
"bugtrack_url": null,
"license": "Copyright (c), Development Seed \n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without modification,\n are permitted provided that the following conditions are met:\n \n - Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n - Redistributions in binary form must reproduce the above copyright notice, this\n list of conditions and the following disclaimer in the documentation and/or\n other materials provided with the distribution.\n - Neither the name \"Development Seed\" nor the names of its contributors may be\n used to endorse or promote products derived from this software without\n specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\n ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\n WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR\n ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\n LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\n ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "An importer and exporter for MBTiles",
"version": "0.3.4",
"project_urls": null,
"split_keywords": [
"map",
" mbtiles",
" tiles"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8f78263d46bfe9cb9e79e23da7a58788e29d17c6bc4bd2f39ddcee141668e9b5",
"md5": "78c0a1275d77c06b767e1bc40b60e55f",
"sha256": "5c423bb30e47ca0e02614a9efaac373df83ddedf118a0fb787d1504e2c4abe23"
},
"downloads": -1,
"filename": "smellman_mbutil-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "78c0a1275d77c06b767e1bc40b60e55f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10019,
"upload_time": "2025-07-25T12:26:49",
"upload_time_iso_8601": "2025-07-25T12:26:49.461007Z",
"url": "https://files.pythonhosted.org/packages/8f/78/263d46bfe9cb9e79e23da7a58788e29d17c6bc4bd2f39ddcee141668e9b5/smellman_mbutil-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "819ef13a7646ff7742847f0d213913e4395200d40045d9832f46db54df40d117",
"md5": "e6e2e749f7eb5d2d1f5650a4afa6ed4b",
"sha256": "17afb3f4b5bc9f698b6757dda3acdde122c82681e96690bc7539b3d2b314e9e2"
},
"downloads": -1,
"filename": "smellman_mbutil-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "e6e2e749f7eb5d2d1f5650a4afa6ed4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 190720,
"upload_time": "2025-07-25T12:26:48",
"upload_time_iso_8601": "2025-07-25T12:26:48.167725Z",
"url": "https://files.pythonhosted.org/packages/81/9e/f13a7646ff7742847f0d213913e4395200d40045d9832f46db54df40d117/smellman_mbutil-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 12:26:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "smellman-mbutil"
}
