EE-Status

Displaying Data from the "Marktstammdatenregister". You can currently explore it at https://ee-status.de/ . This project is currently a (technical) "Proof of concept". It lacks tests, proper documentation and a good structure.

License: GPLv3

Settings

Moved to settings.

Basic Commands

Get the data locally

thank open-MaStR for their great efforts which make this project here possible in the first place
get the data with help from open-MaStR
- open-MaStR should already be installed locally via pip
- RTD: https://open-mastr.readthedocs.io/en/latest/getting_started.html#
- start a python console (e.g. python manage.py shell_plus)
  - from open_mastr import Mastr
  - db = Mastr()
  - db.download(data=["solar","wind","biomass","hydro","storage"]) # we don't need all data

Import data wit pgloader

import the population and area data (from another source, saved inside sql_scripts/municipality_key_import_file.csv)
- run pgloader: pgloader sql_scripts/01_import_municipality_keys
run pgloader transform data from open-MaStR: pgloader sql_scripts/02_import_from_open-mastr
- adapt path to open_MaStR to your needs; data usually gets downloaded to /home/$USER
- pgloader will also run the script 03_unite_tables.sql

Import the newly created tables into your django postgres database

import the tables 'current_totals', 'energy_units' and 'monthly_timeline' into your Django project
run Django as usual "python manage.py runserver"

Setting Up Your Users

To create a superuser account, use this command:
```
$ python manage.py createsuperuser
```

Type checks

Running type checks with mypy:

$ mypy ee_status

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with pytest

$ pytest

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

This repo is ready to be deployed via caprover - the free and open source PaaS.

finnus/ee-status