This server was generated by the OpenAPI Generator project. By using the OpenAPI-Spec from a remote server, you can easily generate a server stub. This is an example of building a OpenAPI-enabled Flask server.

This example uses the Connexion library on top of Flask.

Python 3.5.2+

To run the development server, please execute the following from the root directory:

pip3 install -r requirements.txt
python3 -m pfeffernusse

and open your browser to here:

http://localhost:8080/v1/ui/

Your OpenAPI definition lives here:

http://localhost:8080/v1/openapi.json

To run the production server locally please execute the following from the root directory:

pip3 install -r requirements.txt
gunicorn --bind 0.0.0.0:8080 pfeffernusse.wsgi

To run the server on a Docker container, please execute the following from the root directory:

# building the image
docker build -t pfeffernusse .

# starting up a container
docker run -p 8080:8080 pfeffernusse

The Docker container runs pfeffernusse using gunicorn.

We maintain a versioned specification via the USGS Astro SwaggerHub organization. The current version of the specification is available at: https://app.swaggerhub.com/apis/USGS-Astro/pfeffernusse2/0.1.4-oas3

Documentation on adding to or extending an existing driver is available via the wiki at https://github.com/USGS-Astrogeology/pfeffernusse/wiki/Writing-New-Drivers.

We currently support:

• These instruments are supported via pfeffernusse, but not yet supported by the USGS Community Sensor Model

To regenerate the auto-generated portions of the code base, it is necesary to have the openapi-generator-cli installed. Installation instructions are available here. Once installed, simply run make server to (re)generate the autogenerated components. This is generally only used when testing changes to the specification locally before publishing them.