Skip to main content

Add web resources to GeoKey projects

Project description

PyPI Package Travis CI Build Status Coveralls Test Coverage

geokey-webresources

Extend GeoKey projects by adding web resources: GeoJSON and KML.

Install

geokey-webresources requires:

  • Python version 2.7
  • GeoKey versions 0.9 or 0.10

Install the geokey-webresources from PyPI:

pip install geokey-webresources

Or from cloned repository:

cd geokey-webresources
pip install -e .

Add the package to installed apps:

INSTALLED_APPS += (
    ...
    'geokey_webresources',
)

Migrate the models into the database:

python manage.py migrate geokey_webresources

You’re now ready to go!

Update

Update the geokey-webresources from PyPI:

pip install -U geokey-webresources

Migrate the new models into the database:

python manage.py migrate geokey_webresources

Test

Run tests:

python manage.py test geokey_webresources

Check code coverage:

pip install coverage
coverage run --source=geokey_webresources manage.py test geokey_webresources
coverage report -m --omit=*/tests/*,*/migrations/*

Public API

Get all web resources of a project

GET /api/projects/:project_id/webresources/

Request parameters:

Parameter Type Description
project_id Integer A unique identifier for the project.

Response:

The response contains an array of web resources. If the array is empty, then the project has no active web resources.

[
    {
        "id": 46,
        "status": "active",
        "name": "Public Houses",
        "description": "All public houses in London.",
        "created": "2014-09-19T15:51:32.790Z",
        "modified": "2014-09-21T15:51:32.804Z",
        "dataformat": "KML",
        "url": "http://london.co.uk/public-houses.kml",
        "colour": "#000000",
        "symbol": null
    }
]

Response status codes:

Code Reason
200 The list of web resources has been returned successfully.
404 The project was not found (or user has no access to it).

Get a single web resource of a project

GET /api/projects/:project_id/webresources/:webresource_id/

Request parameters:

Parameter Type Description
project_id Integer A unique identifier for the project.
webresource_id Integer A unique identifier for the web resource.

Response:

{
    "id": 46,
    "status": "active",
    "name": "Train Stations",
    "description": "Train stations in Germany.",
    "created": "2015-09-15T09:40:01.747Z",
    "modified": "2016-01-10T07:12:01.827Z",
    "dataformat": "GeoJSON",
    "url": "https://germany.de/all-train-stations.geojson",
    "colour": "#ffc0cb",
    "symbol": '/media/webresources/symbols/train_stations.png'
}

Response status codes:

Code Reason
200 The web resource has been returned successfully.
404 The project or web resource was not found.

Project details


Release history Release notifications

This version
History Node

0.2.1

History Node

0.2.0

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
geokey-webresources-0.2.1.tar.gz (14.0 kB) Copy SHA256 hash SHA256 Source None Mar 30, 2016

Supported by

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