Skip to main content

Tools for manipulating Geomark datasets

Project description

Build Status

A small python library that provides implementations of the BC Governments Geomark Web Service

Installation

Option 1 - Clone this repository and install manually

  1. We will do our best to keep the master branch of this repository stable. However you could also checkout the tag corresponding to the release you would like…

    git clone https://github.com/greg-and-adam/python-geomark.git

  2. the cd into the directory where this repository was cloned

    cd /path/to/python-geomark

  3. Install using setup.py

    python setup.py install

  4. Or… Follow step 1 above then install using pip

    pip install /path/to/cloned/python-geomark

TODO List more installation methods here as they become supported…

Usage

A Geomark object can be instantiated with either a Geomark ID or a full Geomark URL.

We recommend using the Geomark ID.

from geomark import Geomark

gm = Geomark('gm-abcdefghijklmnopqrstuv0bcislands')
# or...
gm = Geomark('https://apps.gov.bc.ca/pub/geomark/geomarks/gm-abcdefghijklmnopqrstuv0bcislands')

This library supports all of the basic read functions from the Geomark API.

Reponse results are returned as a bytes string. It can be parsed using the appropriate library.

The default format is ‘json’ which will return a json parsable byte string. When using the JSON format any geometries will be formatted as EWKT.

Any of the supported file formats may be requested.

import json
from geomark import Geomark

gm = Geomark('gm-abcdefghijklmnopqrstuv0bcislands')

info = json.loads(gm.info())
parts = json.loads(gm.parts('geojson'))  # geojson is also supported.

Data can also be requested in any of the supported coordinate systems.

import json
from geomark import Geomark

gm = Geomark('gm-abcdefghijklmnopqrstuv0bcislands')
parts_bcalbers = json.loads(gm.parts('geojson', 3005))

If you get data in a format you wish to write to a file you may do so by simply opening a file location as writable in binary mode. (wb)

from geomark import Geomark

gm = Geomark('gm-abcdefghijklmnopqrstuv0bcislands')
feature_file = gm.feature('shpz')

with open('bc_islands.shpz', 'wb') as file:
    file.write(feature_file)

Testing

Using tox

The recommended way to run the tests is by using tox, which can be installed usingpip install tox.

You can use tox -l to list the available environments, and then e.g. use the following to run all tests with Python 3.6

tox -e py36

Running tests manually

Please refer to the tox.ini file for reference/help in case you want to run tests manually / without tox.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

Recent changes can be viewed in the CHANGELOG.md file.

Credits

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for geomark, version 0.1.1
Filename, size & hash File type Python version Upload date
geomark-0.1.1-py2.py3-none-any.whl (15.5 kB) View hashes Wheel py2.py3
geomark-0.1.1.tar.gz (11.5 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page