wis2box-api

WIS 2.0 in a box OGC API

Installation

wis2box-api is part of the wis2box project. To install wis2box-api in standalone mode:

docker install wmo-im/wis2box:latest

Requirements

• Python 3 and above
• Python virtualenv package

Dependencies

Dependencies are listed in requirements.txt. Dependencies are automatically installed during wis2box-api's installation.

Installing the Package

python3 -m venv my-env
cd my-env
. bin/activate
git clone https://github.com/wmo-im/wis2box-api.git
cd wis2box-api
python setup.py build
python setup.py install

Running

export FLASK_APP=wis2box_api.app
flask run

Development

Setting up a Development Environment

Same as installing a package. Use a virtualenv. Also install developer requirements:

pip install -r requirements-dev.txt

Releasing

# create release (x.y.z is the release version)
vi wis2box_api/__init__.py  # update __version__
git commit -am 'update release version x.y.z'
git push origin main
git tag -a x.y.z -m 'tagging release version x.y.z'
git push --tags

# publish release on GitHub (https://github.com/wmo-im/wis2box-api/releases/new)

# bump version back to dev
vi wis2box_api/__init__.py  # update __version__
git commit -am 'back to dev'
git push origin main

Code Conventions

• PEP8

Bugs and Issues

All bugs, enhancements and issues are managed on GitHub.

Contact

• Tom Kralidis
• Maaike Limper