Files
pygeoapi/README.md
T
KatKatKateryna c96d4f6f30 Kate speckle poc (#1)
* MVP

* upd

* upd

* fixed dynamic loading

* don't overwrite YAML, remember the value instead

* remove default link; URL syntax; TODO: lat vs lon; speckle_data None

* crs centralized

* not implemented methods

* remove case from args

* removing client auth; only receive branch

* enable Queryables page

* normal props

* reprojection in bulk

* speed up reprojections

* add GisFeature

* fix geometry

* fix coords

* fix lines

* all GIS data works

* non-gis data scaling fixed

* fix non-gis pts and curves

* backup displayValue

* remove redirect to individual features

* replace old links

* UI without redirects

* display parameters

* reroute from homepage

* operations from Core; set HostApp

* receive exception

* all not implemented

* zoom

* redirect to speckle from individual features

* layer color placeholders

* render styles; server info

* Model info column

* html styles

* display Missing URL message

* return functionality for WFS

* more display colors

* load landing page for GIS apps only

* display invalid input error

* typo

* print out agent

* patch specklepy on install

* fix import

* warning for zero coords; remove Account from auth

* remove transport account only before receive

* better patch

* get the entire stream

* fix request split

* clear provider data

* list browsers to support

* better UI

* UI

* UI and hyperlinks

* large map
2024-08-14 10:29:10 +08:00

58 lines
2.6 KiB
Markdown

# pygeoapi
[![DOI](https://zenodo.org/badge/121585259.svg)](https://zenodo.org/badge/latestdoi/121585259)
[![Build](https://github.com/geopython/pygeoapi/actions/workflows/main.yml/badge.svg)](https://github.com/geopython/pygeoapi/actions/workflows/main.yml)
[![Docker](https://github.com/geopython/pygeoapi/actions/workflows/containers.yml/badge.svg)](https://github.com/geopython/pygeoapi/actions/workflows/containers.yml)
[![Vulnerabilities](https://github.com/geopython/pygeoapi/actions/workflows/vulnerabilities.yml/badge.svg)](https://github.com/geopython/pygeoapi/actions/workflows/vulnerabilities.yml)
[pygeoapi](https://pygeoapi.io) is a Python server implementation of the [OGC API](https://ogcapi.ogc.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).
Please read the docs at [https://docs.pygeoapi.io](https://docs.pygeoapi.io) for more information.
## Speckle plugin
First use:
```python
python -m venv pygeoapi
pygeoapi\Scripts\activate
cd pygeoapi
git clone https://github.com/specklesystems/pygeoapi.git
cd pygeoapi
git checkout dev
pip install --upgrade pip
pip install -r requirements.txt
python setup.py install
set PYGEOAPI_CONFIG=example-config.yml
set PYGEOAPI_OPENAPI=example-config.yml
pygeoapi openapi generate $PYGEOAPI_CONFIG > $PYGEOAPI_OPENAPI
pygeoapi serve
curl http://localhost:5000
```
Repeated use:
```python
cd C:\Users\yourusername
pygeoapi\Scripts\activate
cd pygeoapi
cd pygeoapi
git pull
git checkout dev
set PYGEOAPI_CONFIG=example-config.yml
set PYGEOAPI_OPENAPI=example-config.yml
pygeoapi openapi generate $PYGEOAPI_CONFIG > $PYGEOAPI_OPENAPI
pygeoapi serve
```
Example URL:
http://localhost:5000/?limit=10000&speckleUrl=https://app.speckle.systems/projects/55a29f3e9d/models/2d497a381d
If GIS-originated Speckle model is loaded, no additional arguments are needed, except SPECKLEURL and LIMIT.
Supported arguments:
- speckleUrl (text) - required, should contain path to a specific Model in Speckle Project, e.g. 'https://app.speckle.systems/projects/55a29f3e9d/models/2d497a381d'
- limit (positive integer), recommended, as some applications might apply their custom feature limit
- crsAuthid (text), an authority string e.g. 'epsg:4326'. If set, LAT, LON and NORTHDEGREES arguments will be ignored.
- lat (number), in range -90 to 90
- lon (number), in range -180 to 180
- northDegrees (number), in range -180 to 180