geoadmin / doc-jupyter-api

a jupyter equivalent to the REST api documentation with examples and the possibility to manipulate parameters

#app-teaching

1. Principle of the application

This is a jupyter notebook application meant to help teach the usage of the swisstopo API.

2. Installation

2.1 using docker

It is the simplest way. You can do it with a docker pull command, followed by a docker-compose command.

docker pull swisstopo/app-teaching:stable
docker-compose up -d [ARGS]

2.2 make

A makefile is offered with two possible commands

make run-docker
make run-env

Which respectively allow you to

2.3 manually

3. Usage

4.