# 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)
## Installation
Git checkout (requires git)
git clone git://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"''',
--image_format=FORMAT
The format of the image tiles, either png, jpg, webp or pbf
--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 silentl
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 `>= 2.6`
## 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 [nosetests](http://readthedocs.org/docs/nose/en/latest/) for testing. Install nosetests:
pip install nose
or
easy_install nose
Then run:
nosetests
## 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": "https://github.com/mapbox/mbutil",
"name": "mbutil",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Tom MacWright",
"author_email": "tom@macwright.org",
"download_url": "https://files.pythonhosted.org/packages/08/2d/49fb7b4fe74775e456e562a3dfde901cbaf51c5a068f182b4ab945cf811f/mbutil-0.3.0.tar.gz",
"platform": "UNKNOWN",
"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## Installation\n\nGit checkout (requires git)\n\n git clone git://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 --image_format=FORMAT\n The format of the image tiles, either png, jpg, webp or pbf\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 silentl\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 `>= 2.6`\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 [nosetests](http://readthedocs.org/docs/nose/en/latest/) for testing. Install nosetests:\n\n pip install nose\nor\n\n easy_install nose\n\nThen run:\n\n nosetests\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)",
"bugtrack_url": null,
"license": "LICENSE.md",
"summary": "An importer and exporter for MBTiles",
"version": "0.3.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "976d0d8fa2673074c83b15a53e12fe2f",
"sha256": "ebbc67c966f71a45e6cc6e9e17a840efdc0aa56557abac71a58beb92f0572eaa"
},
"downloads": -1,
"filename": "mbutil-0.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "976d0d8fa2673074c83b15a53e12fe2f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 10062,
"upload_time": "2017-05-03T13:41:34",
"upload_time_iso_8601": "2017-05-03T13:41:34.813345Z",
"url": "https://files.pythonhosted.org/packages/b2/e1/0f3b74ba4d44cbeb9b95fc69c64157c9e5670fabbe3e584487244421f782/mbutil-0.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "0c6c9fda7738e1ab0d9c206e1c53ffd1",
"sha256": "78fca26f2497c4e20592792e2fe4abd5fd51e58a03a023a42a54274b7c13c419"
},
"downloads": -1,
"filename": "mbutil-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "0c6c9fda7738e1ab0d9c206e1c53ffd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8307,
"upload_time": "2017-05-03T13:41:36",
"upload_time_iso_8601": "2017-05-03T13:41:36.361278Z",
"url": "https://files.pythonhosted.org/packages/08/2d/49fb7b4fe74775e456e562a3dfde901cbaf51c5a068f182b4ab945cf811f/mbutil-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2017-05-03 13:41:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mapbox",
"github_project": "mbutil",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "mbutil"
}
JSON
