Richard Law
17ed14107d
* Changes to sample pygeopai-config.yml - improved terms_of_service and contact.url for SEO - fixes typo for contact.instructions * whitespace * dynamically embed JSON-LD representation in head * json-led representation for root, collections, and collection * updates sample configuration with metadata that won't cause JSON-LD validation issues * adds support for feature-level JSON-LD representations of collections and items * improves consistency between microdata and JSON-LD root metadata * valid Dataset spatial; and better use of @id * role → instructions * adds jsonld f param to open api definition * working with new temporal extent interface * removes comment * identify and retain NIR/HTTP IDs rather than construct them with reference to pygeoapi * don't pop a feature.properties id, to retain JSON-LD reference integrity * add/update tests for inclusion of json-ld responses * bug fixes * fix bug where id was assumed to be string * better url checking * renames format variable to avoid reserved word * removes top-level CRS in obs sample config * add json-ld textMimeType for serverless * adds flask-cors dependency to allow cors * moves json-ld-requesting script to bottom of body * corrects schema.org url * fixes urls * adds pyld dependency * adds tests for json-ld representations (incomplete) * more tests * make pyld a dev requirement only * linting * changes from revision * removes merge artifact
pygeoapi
pygeoapi provides an API to geospatial data
Installation
virtualenv -p python pygeoapi
cd pygeoapi
. bin/activate
git clone https://github.com/geopython/pygeoapi.git
cd pygeoapi
pip install -r requirements.txt
pip install -r requirements-dev.txt
# install provider requirements accordingly from requirements-provider.txt
# install starlette requirements accordingly from requirements-starlette.txt
pip install -e .
cp pygeoapi-config.yml local.config.yml
vi local.config.yml
# TODO: what is most important to edit?
export PYGEOAPI_CONFIG=$(pwd)/local.config.yml
# generate OpenAPI Document
pygeoapi generate-openapi-document -c local.config.yml > openapi.yml
export PYGEOAPI_OPENAPI=$(pwd)/openapi.yml
pygeoapi serve
Example requests
Try the swagger ui at http://localhost:5000/ui
or
# feature collection metadata
curl http://localhost:5000/
# conformance
curl http://localhost:5000/conformance
# feature collection
curl http://localhost:5000/collections/countries
# feature collection limit 100
curl http://localhost:5000/collections/countries/items?limit=100
# feature
curl http://localhost:5000/collections/countries/items/1
# number of hits
curl http://localhost:5000/collections/countries/items?resulttype=hits
Exploring with Swagger UI
docker pull swaggerapi/swagger-ui
docker run -p 80:8080 swaggerapi/swagger-ui
# go to http://localhost
# enter http://localhost:5000/openapi and click 'Explore'
Demo Server
There is a demo server on https://demo.pygeoapi.io running the latest (Docker) version
from the master branch of this repo. pygeoapi runs there at https://demo.pygeoapi.io/master.
The demo server setup and config is maintained within a seperate GH repo: https://github.com/geopython/demo.pygeoapi.io.
Docker
Best/easiest way to run pygeoapi is to use Docker. On DockerHub pygeoapi Docker Images are available.
Please read the docker/README for details of the Docker implementation.
Unit Testing
Unit tests are run using pytest from the top project folder:
pytest tests
NB beware that some tests require Provider dependencies (libraries) to be available and that the ElasticSearch and Postgres tests require their respective backend servers running.
Environment variables are set in the file pytest.ini.