Geobuf
------
Geobuf is a compact binary geospatial format for *lossless* compression
of GeoJSON and TopoJSON data.
|Build Status| |Coverage Status|
**Note well**: this project is no longer actively developed. Issues and
pull requests will be attended to when possible, but delays should be
expected.
Advantages over using GeoJSON and TopoJSON directly (in this `revised
version <https://github.com/mapbox/geobuf/issues/27>`__):
- **Very compact**: typically makes GeoJSON 6-8 times smaller and
TopoJSON 2-3 times smaller.
- Smaller even when comparing gzipped sizes: 2-2.5x compression for
GeoJSON and 20-30% for TopoJSON.
- Easy **incremental parsing** — you can get features out as you read
them, without the need to build in-memory representation of the whole
data.
- **Partial reads** — you can read only the parts you actually need,
skipping the rest.
- Trivial **concatenation**: you can concatenate many Geobuf files
together and they will form a valid combined Geobuf file.
- Potentially **faster encoding/decoding** compared to native JSON
implementations (i.e. in Web browsers).
- Can still accommodate any GeoJSON and TopoJSON data, including
extensions with arbitrary properties.
Think of this as an attempt to design a simple, modern Shapefile
successor that works seamlessly with GeoJSON and TopoJSON.
Unlike `Mapbox Vector
Tiles <https://github.com/mapbox/vector-tile-spec/>`__, it aims for
*lossless* compression of datasets — without tiling, projecting
coordinates, flattening geometries or stripping properties.
pygeobuf
^^^^^^^^
This repository is the first encoding/decoding implementation of this
new major version of `Geobuf <https://github.com/mapbox/geobuf>`__ (in
Python). It serves as a prototyping playground, with faster
implementations in JS and C++ coming in future.
Sample compression sizes
^^^^^^^^^^^^^^^^^^^^^^^^
::
| normal | gzipped
+---------------------+-------------+------------+
| us-zips.json | 101.85 MB | 26.67 MB |
+---------------------+-------------+------------+
| us-zips.pbf | 12.24 MB | 10.48 MB |
+---------------------+-------------+------------+
| us-zips.topo.json | 15.02 MB | 3.19 MB |
+---------------------+-------------+------------+
| us-zips.topo.pbf | 4.85 MB | 2.72 MB |
+---------------------+-------------+------------+
| idaho.json | 10.92 MB | 2.57 MB |
+---------------------+-------------+------------+
| idaho.pbf | 1.37 MB | 1.17 MB |
+---------------------+-------------+------------+
| idaho.topo.json | 1.9 MB | 612 KB |
+---------------------+-------------+------------+
| idaho.topo.pbf | 567 KB | 479 KB |
+---------------------+-------------+------------+
Usage
~~~~~
Command line:
.. code:: bash
geobuf encode < example.json > example.pbf
geobuf decode < example.pbf > example.pbf.json
As a module:
.. code:: python
import geobuf
pbf = geobuf.encode(my_json) # GeoJSON or TopoJSON -> Geobuf string
my_json = geobuf.decode(pbf) # Geobuf string -> GeoJSON or TopoJSON
The ``encode`` function accepts a dict-like object, for example the
result of ``json.loads(json_str)``.
Both ``encode.py`` and ``geobuf.encode`` accept two optional arguments:
- **precision** — max number of digits after the decimal point in
coordinates, ``6`` by default.
- **dimensions** — number of dimensions in coordinates, ``2`` by
default.
Tests
~~~~~
.. code:: bash
py.test -v
The tests run through all ``.json`` files in the ``fixtures`` directory,
comparing each original GeoJSON with an encoded/decoded one.
.. |Build Status| image:: https://travis-ci.org/mapbox/pygeobuf.svg?branch=master
:target: https://travis-ci.org/mapbox/pygeobuf
.. |Coverage Status| image:: https://coveralls.io/repos/mapbox/pygeobuf/badge.svg?branch=master
:target: https://coveralls.io/r/mapbox/pygeobuf?branch=master
Raw data
{
"_id": null,
"home_page": "https://github.com/mapbox/pygeobuf",
"name": "geobuf",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "data gis geojson topojson protobuf",
"author": "Vladimir Agafonkin",
"author_email": "vladimir@mapbox.com",
"download_url": "https://files.pythonhosted.org/packages/af/f0/7d9f7d7b2b45dbf9ef6addf00bdd5261045be6e5a37a005e9929c08de86f/geobuf-1.1.1.tar.gz",
"platform": "",
"description": "Geobuf\n------\n\nGeobuf is a compact binary geospatial format for *lossless* compression\nof GeoJSON and TopoJSON data.\n\n|Build Status| |Coverage Status|\n\n**Note well**: this project is no longer actively developed. Issues and\npull requests will be attended to when possible, but delays should be\nexpected.\n\nAdvantages over using GeoJSON and TopoJSON directly (in this `revised\nversion <https://github.com/mapbox/geobuf/issues/27>`__):\n\n- **Very compact**: typically makes GeoJSON 6-8 times smaller and\n TopoJSON 2-3 times smaller.\n- Smaller even when comparing gzipped sizes: 2-2.5x compression for\n GeoJSON and 20-30% for TopoJSON.\n- Easy **incremental parsing** \u2014 you can get features out as you read\n them, without the need to build in-memory representation of the whole\n data.\n- **Partial reads** \u2014 you can read only the parts you actually need,\n skipping the rest.\n- Trivial **concatenation**: you can concatenate many Geobuf files\n together and they will form a valid combined Geobuf file.\n- Potentially **faster encoding/decoding** compared to native JSON\n implementations (i.e. in Web browsers).\n- Can still accommodate any GeoJSON and TopoJSON data, including\n extensions with arbitrary properties.\n\nThink of this as an attempt to design a simple, modern Shapefile\nsuccessor that works seamlessly with GeoJSON and TopoJSON.\n\nUnlike `Mapbox Vector\nTiles <https://github.com/mapbox/vector-tile-spec/>`__, it aims for\n*lossless* compression of datasets \u2014 without tiling, projecting\ncoordinates, flattening geometries or stripping properties.\n\npygeobuf\n^^^^^^^^\n\nThis repository is the first encoding/decoding implementation of this\nnew major version of `Geobuf <https://github.com/mapbox/geobuf>`__ (in\nPython). It serves as a prototyping playground, with faster\nimplementations in JS and C++ coming in future.\n\nSample compression sizes\n^^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n | normal | gzipped\n\n+---------------------+-------------+------------+\n| us-zips.json | 101.85 MB | 26.67 MB |\n+---------------------+-------------+------------+\n| us-zips.pbf | 12.24 MB | 10.48 MB |\n+---------------------+-------------+------------+\n| us-zips.topo.json | 15.02 MB | 3.19 MB |\n+---------------------+-------------+------------+\n| us-zips.topo.pbf | 4.85 MB | 2.72 MB |\n+---------------------+-------------+------------+\n| idaho.json | 10.92 MB | 2.57 MB |\n+---------------------+-------------+------------+\n| idaho.pbf | 1.37 MB | 1.17 MB |\n+---------------------+-------------+------------+\n| idaho.topo.json | 1.9 MB | 612 KB |\n+---------------------+-------------+------------+\n| idaho.topo.pbf | 567 KB | 479 KB |\n+---------------------+-------------+------------+\n\nUsage\n~~~~~\n\nCommand line:\n\n.. code:: bash\n\n geobuf encode < example.json > example.pbf\n geobuf decode < example.pbf > example.pbf.json\n\nAs a module:\n\n.. code:: python\n\n import geobuf\n\n pbf = geobuf.encode(my_json) # GeoJSON or TopoJSON -> Geobuf string\n my_json = geobuf.decode(pbf) # Geobuf string -> GeoJSON or TopoJSON\n\nThe ``encode`` function accepts a dict-like object, for example the\nresult of ``json.loads(json_str)``.\n\nBoth ``encode.py`` and ``geobuf.encode`` accept two optional arguments:\n\n- **precision** \u2014 max number of digits after the decimal point in\n coordinates, ``6`` by default.\n- **dimensions** \u2014 number of dimensions in coordinates, ``2`` by\n default.\n\nTests\n~~~~~\n\n.. code:: bash\n\n py.test -v\n\nThe tests run through all ``.json`` files in the ``fixtures`` directory,\ncomparing each original GeoJSON with an encoded/decoded one.\n\n.. |Build Status| image:: https://travis-ci.org/mapbox/pygeobuf.svg?branch=master\n :target: https://travis-ci.org/mapbox/pygeobuf\n.. |Coverage Status| image:: https://coveralls.io/repos/mapbox/pygeobuf/badge.svg?branch=master\n :target: https://coveralls.io/r/mapbox/pygeobuf?branch=master\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Geobuf is a compact binary geospatial format for lossless compression of GeoJSON and TopoJSON data.",
"version": "1.1.1",
"split_keywords": [
"data",
"gis",
"geojson",
"topojson",
"protobuf"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "6f594380c953ce771889cfd20765a2f4",
"sha256": "e6298e0608b2fcb4fc23530760fbe03862449f44ac5f5065aeb9304ce3d23299"
},
"downloads": -1,
"filename": "geobuf-1.1.1-py2-none-any.whl",
"has_sig": false,
"md5_digest": "6f594380c953ce771889cfd20765a2f4",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 13883,
"upload_time": "2017-10-06T17:52:14",
"upload_time_iso_8601": "2017-10-06T17:52:14.798163Z",
"url": "https://files.pythonhosted.org/packages/4b/95/8cb3915dabf195439dc050ad5e7526fe28c20f08d8d068a706b8e6356659/geobuf-1.1.1-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "cb63873b143994b326ca885b77f9857c",
"sha256": "a6b81a0a09505996ee23b6caa303cde8c0d2f75d31826241a452a19bf675f8c2"
},
"downloads": -1,
"filename": "geobuf-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb63873b143994b326ca885b77f9857c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13883,
"upload_time": "2017-10-06T17:51:31",
"upload_time_iso_8601": "2017-10-06T17:51:31.743868Z",
"url": "https://files.pythonhosted.org/packages/77/8a/264fc3e9d9dd553f813cf578f15e901148a06bc607f4f99c2e54d7ed533f/geobuf-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "b7110d8fa197d936daa59842a4bc2170",
"sha256": "9c645a2ef7c0a8679b1088981e286357823a2291322de6d0b9ee523212933e9a"
},
"downloads": -1,
"filename": "geobuf-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b7110d8fa197d936daa59842a4bc2170",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 56501,
"upload_time": "2017-10-06T17:51:34",
"upload_time_iso_8601": "2017-10-06T17:51:34.775402Z",
"url": "https://files.pythonhosted.org/packages/af/f0/7d9f7d7b2b45dbf9ef6addf00bdd5261045be6e5a37a005e9929c08de86f/geobuf-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2017-10-06 17:51:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mapbox",
"github_project": "pygeobuf",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "geobuf"
}
JSON
