Metadata-Version: 1.1
Name: geomark
Version: 0.1.1
Summary: Tools for manipulating Geomark datasets
Home-page: https://github.com/pauperpythonistas/python-geomark/
Author: Adam Valair, Greg Sebastian
Author-email: adam@bitspatial.com, gregseb@protonmail.com
License: BSD2
Download-URL: https://github.com/pauperpythonistas/python-geomark/archive/0.1.1.tar.gz
Description-Content-Type: UNKNOWN
Description: Python Geomark
        ==============
        
        |Build Status|
        
        A small python library that provides implementations of the BC
        Governments `Geomark Web
        Service <https://www2.gov.bc.ca/gov/content/data/geographic-data-services/location-services/geomark-webservice>`__
        
        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.
        
        .. code:: python
        
        
            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 <https://apps.gov.bc.ca/pub/geomark/docs/fileFormats.html>`__
        may be requested.
        
        .. code:: python
        
        
            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 <https://apps.gov.bc.ca/pub/geomark/docs/coordinateSystems.html>`__.
        
        .. code:: python
        
            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)
        
        .. code:: python
        
            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 <https://tox.readthedocs.io/en/latest/>`__, which can be installed
        using\ ``pip 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 <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 <CHANGELOG.md>`__
        file.
        
        Credits
        -------
        
        -  `Adam Valair <https://github.com/spatialbits>`__ (Primary
           Developer/Maintainer)
        -  `Greg Sebastian <https://github.com/gregseb>`__ (Primary
           Developer/Maintainer)
        
        License
        -------
        
        This project is licensed under the BSD 3-Clause License - see the
        `LICENSE <LICENSE>`__ file for details
        
        .. |Build Status| image:: https://travis-ci.org/pauperpythonistas/python-geomark.svg?branch=master
           :target: https://travis-ci.org/pauperpythonistas/python-geomark
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Scientific/Engineering :: GIS
