Skip to content

OpenEnergyData/open-habitation

Repository files navigation

Open Habitation API

This is a project started at the Energy Data Hackdays 2021. Please see our project page for background and have fun.

Service

This repository contains a minimal backend service API based on the Falcon framework, Pandas DataPackage Reader, and the Falcon plugin for apispec.

Use pip with requirements.txt or install the Poetry dependency manager, and:

poetry install
poetry shell
python api.py

To update the requirements file:

poetry export --without-hashes -f requirements.txt > requirements.txt

License

This package is licensed by its maintainers under the MIT License.

If you intended to use these data in a public or commercial product, please check the data sources themselves for any specific restrictions.