Metadata-Version: 2.1
Name: rasterfoundry
Version: 0.7.1
Summary: A Python client for Raster Foundry, a web platform for combining, analyzing, and publishing raster data.
Home-page: https://github.com/raster-foundry/raster-foundry-python-client
Author: Raster Foundry
Author-email: info@rasterfoundry.com
License: Apache License 2.0
Description: raster-foundry-python-client
        ============================
        
        A Python client for `Raster Foundry <https://www.rasterfoundry.com/>`_, a web platform for combining, analyzing, and publishing raster data.
        
        Usage
        -----
        
        .. code-block:: python
        
           from rasterfoundry.api import API
           refresh_token = '<>'
        
           api = API(refresh_token=refresh_token)
        
           # List all projects
           my_projects = api.projects
        
           one_project = my_projects[0]
        
           # Get TMS URl without token
           one_project.tms()
        
        Versions
        ~~~~~~~~
        
        The latest version of `rasterfoundry` always points to the most recently released swagger spec in
        the raster-foundry/raster-foundy-api-spec repository. If you need to point to a different spec
        version, either install a version of the python client that refers to the appropriate spec, or
        set the `RF_API_SPEC_PATH` environment variable to a url or local file path pointing to the
        version of the spec that you want to use.
        
        Generally this shouldn't matter, because the Raster Foundry API shouldn't have breaking changes.
        
        
        Installation
        ------------
        
        Without notebook support
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: bash
        
           $ pip install rasterfoundry
        
        With notebook support
        ~~~~~~~~~~~~~~~~~~~~~
        
        Notebook support requires [`npm`](https://www.npmjs.com/get-npm).
        
        .. code:: bash
        
           $ pip install rasterfoundry[notebook]
        
        Then, enable widgets and leaflet in in jupyter notebooks:
        
        .. code:: bash
        
           $ jupyter nbextension install --py --symlink --sys-prefix widgetsnbextension
           $ jupyter nbextension enable --py --sys-prefix widgetsnbextension 
           $ jupyter nbextension install --py --symlink --sys-prefix ipyleaflet
           $ jupyter nbextension enable --py --sys-prefix ipyleaflet
        
        
        Testing
        -------
        
        The test suite execution process is managed by ``tox``:
        
        .. code:: bash
        
           $ tox
        
        
        Releases
        --------
        
        Releases are automatically published to PyPI through Travis CI when commits are tagged. The following ``git flow`` commands lead to a tagged commit that can be pushed to GitHub:
        
        
        .. code:: bash
        
           $ git flow release start X.Y.Z
           $ docker run -ti --rm -v "${PWD}:/changelog" -w "/changelog" "quay.io/azavea/github-changelog-generator:v1.14.3" \
              --token "${GITHUB_TOKEN}" \
              --future-release "X.Y.Z" \
              --no-issues \
              --no-author \
              --release-branch develop
           $ pandoc CHANGELOG.md -o CHANGELOG.rst
           $ rm CHANGELOG.md
           $ vim setup.py
           $ git commit -m "X.Y.Z"
           $ git flow release publish X.Y.Z
           $ git flow release finish X.Y.Z
        
        
        After you've completed the ``git flow`` steps above, you'll need to push the changes from your local repository to the GitHub repository:
        
        .. code:: bash
        
           $ git checkout develop
           $ git push origin develop
           $ git checkout master
           $ git push origin master
           $ git push --tags
        
Keywords: raster earth-observation geospatial geospatial-processing
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Provides-Extra: dev
Provides-Extra: test
Provides-Extra: notebook
