plzpy 0.1.3

zip/buildings rest API for Berlin

PLZ Rest API

A simple rest API that exposes data related to zip codes and buildings in Berlin.

This project is the Python implementation of PLZ

The source dataset is published by Esri and is available here.

Motivations

Built as an exercise

Rest API

PLZ provides the following endpoints:

• /status returns the status of the service
• /zip/buildings returns the number of buildings aggregated by zip code
• /zip/buildings/history returns the number of buildings aggregated by zip code and year
• /zip/buildings/:code returns the number of buildings for a specific zip code
• /zip/buildings/:code/history returns the number of buildings aggregated by zip code and year for a specific zip code

Usage

There are 2 ways to run the PLZ api service: using Docker(recommended) or via manual setup.

For best results with Docker please use the image from the go project as described here since the image is orders of magnitude smaller.

Manual setup

Those are the steps to run the project manually:

1. Install the library

pip install plzpy

1. Download the dataset linked above:

curl -L https://opendata.arcgis.com/datasets/273bf4ae7f6a460fbf3000d73f7b2f76_0.csv?outSR=%7B%22latestWkid%22%3A3857%2C%22wkid%22%3A102100%7D -o /tmp/src.csv

2. Massage the dataset to produce an optimized json to be served via the Rest API

plzpy massage --in /tmp/src.csv --out rest.json

3. Run the Rest API service

plzpy serve --data rest.json

Development

The project relies on poetry.