From 2b38cdba56efda1d57c4f1cdcf7a5a9213618ee3 Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Wed, 29 Apr 2020 14:49:47 -0400 Subject: [PATCH] simplify README --- README.md | 84 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 82 deletions(-) diff --git a/README.md b/README.md index d42ca99..01e2836 100644 --- a/README.md +++ b/README.md @@ -3,86 +3,6 @@ [![Build Status](https://travis-ci.org/geopython/pygeoapi.png)](https://travis-ci.org/geopython/pygeoapi) -pygeoapi is a Python server implementation of the [OGC API](http://ogcapi.org) suite of standards. The project emerged as part of the next generation OGC API efforts in 2018 and provides the capability for organizations to deploy a RESTful OGC API endpoint using OpenAPI, GeoJSON, and HTML. pygeoapi is [open source](https://opensource.org/) and released under an [MIT license](https://github.com/geopython/pygeoapi/blob/master/LICENSE.md). +[pygeoapi](https://pygeoapi.io) is a Python server implementation of the [OGC API](http://ogcapi.org) suite of standards. The project emerged as part of the next generation OGC API efforts in 2018 and provides the capability for organizations to deploy a RESTful OGC API endpoint using OpenAPI, GeoJSON, and HTML. pygeoapi is [open source](https://opensource.org/) and released under an [MIT license](https://github.com/geopython/pygeoapi/blob/master/LICENSE.md). -## Installation - -```bash -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/openapi` - -or - -```bash -# collection metadata -curl http://localhost:5000/ -# conformance -curl http://localhost:5000/conformance -# collection -curl http://localhost:5000/collections/countries -# collection limit 100 -curl http://localhost:5000/collections/countries/items?limit=100 -# collection item -curl http://localhost:5000/collections/countries/items/1 -# number of hits -curl http://localhost:5000/collections/countries/items?resulttype=hits - -``` - -## Exploring with Swagger UI - -```bash -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](https://hub.docker.com/r/geopython/pygeoapi) are available. - -Please read the [docker/README](https://github.com/geopython/pygeoapi/blob/master/docker/README.md) 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](pytest.ini). +Please read the docs at [https://docs.pygeoapi.io](https://docs.pygeoapi.io) for more information.