EOEPCA+ Registration API

This repository includes the EOEPCA+ Registration API component
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

• Description
  • Built With
  • Interfaces
• Getting Started
  • Deployment
• Documentation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

Description

The EOEPCA+ Registration API building block is built upon the upstream pygeoapi project.

pygeoapi is a Python server implementation of the OGC API 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 and released under an MIT license, and runs on all major platforms (Windows, Linux, Mac OS X). It is an official OSGeo Project.

pygeoapi is Certified OGC Compliant and is an OGC Reference Implementation for OGC API - Features 1.0, OGC API - EDR 1.0.1, OGC API - Tiles 1.0 and OGC API - Processes 1.0.

Built With

• Python
• pygeoapi

Interfaces

The Registration API provides the following interfaces:

• OGC API - Processes - Part 1: Core

Internally, Data and Metadata registration can be done by the following ways:

• Transaction interfaces (OGC CSW-T or OGC API - Features - Part 4: Create, Replace, Update, Delete) to EOEPCA Resource Catalogue
• Transaction interfaces (STAC API - Create, Replace, Update, Delete) to EOEPCA Data Catalogue
• Transaction interfaces (OGC API - Features - Part 4: Create, Replace, Update, Delete) to EOEPCA Data Access
• Invoking the EOEPCA Harvester component

pygeoapi implements the following interfaces:

• OGC API - Features 1.0
• OGC API - Environmental Data Retrieval 1.0.1
• OGC API - Tiles 1.0
• OGC API - Coverages 1.0
• OGC API - Maps 1.0
• OGC API - Processes 1.0
• OGC API - Records 1.0
• SpatioTemporal Asset Catalog (STAC) 1.0

Getting Started

To get a local copy up and running in 5 minutes follow these simple steps.

# Python 3.10 required
python3 -m venv pygeoapi
cd pygeoapi
. bin/activate
git clone https://github.com/geopython/pygeoapi.git
cd pygeoapi
pip3 install -r requirements.txt
python3 setup.py install
cp pygeoapi-config.yml example-config.yml
vim example-config.yml  # edit as required
export PYGEOAPI_CONFIG=example-config.yml
export PYGEOAPI_OPENAPI=example-openapi.yml
pygeoapi openapi generate $PYGEOAPI_CONFIG --output-file $PYGEOAPI_OPENAPI
pygeoapi serve
# in another terminal
curl http://localhost:5000  # or open in a web browser

Deployment

Registration API deployment is described in the EOEPCA Deployment Guide.

Documentation

The component documentation can be found at https://docs.pygeoapi.io/en/latest/.

Usage

Registration API usage documentation is provided through the upstream pygeoapi project.

• pygeoapi Home Page
• pygeoapi Documenation
• pygeoapi demo
• EOEPCA Registration API usage

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

The EOEPCA components are distributed under the Apache-2.0 License. See LICENSE for more information.

Contact

Angelos Tzotsos - @tzotsos - https://www.osgeo.org/member/angelos-tzotsos/

Project Link: https://github.com/EOEPCA/registration-api

Acknowledgements

• README.md is based on this template by Othneil Drew.