-
Notifications
You must be signed in to change notification settings - Fork 4
/
metadata.py
272 lines (231 loc) · 8.66 KB
/
metadata.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
from egon.data.db import engine
from geoalchemy2 import Geometry
from sqlalchemy import MetaData, Table
from sqlalchemy.dialects.postgresql.base import ischema_names
def context():
"""
Project context information for metadata
Returns
-------
dict
OEP metadata conform data license information
"""
return {
"homepage": "https://ego-n.org/",
"documentation": "https://egon-data.readthedocs.io/en/latest/",
"sourceCode": "https://github.com/openego/eGon-data",
"contact": "https://ego-n.org/partners/",
"grantNo": "03EI1002",
"fundingAgency": "Bundesministerium für Wirtschaft und Energie",
"fundingAgencyLogo": "https://www.innovation-beratung-"
"foerderung.de/INNO/Redaktion/DE/Bilder/"
"Titelbilder/titel_foerderlogo_bmwi.jpg?"
"__blob=normal&v=3",
"publisherLogo": "https://ego-n.org/images/eGon_logo_"
"noborder_transbg.svg",
}
def meta_metadata():
"""
Meta data on metadata
Returns
-------
dict
OEP metadata conform metadata on metadata
"""
return {
"metadataVersion": "OEP-1.4.1",
"metadataLicense": {
"name": "CC0-1.0",
"title": "Creative Commons Zero v1.0 Universal",
"path": ("https://creativecommons.org/publicdomain/zero/1.0/"),
},
}
def licenses_datenlizenz_deutschland(attribution):
"""
License information for Datenlizenz Deutschland
Parameters
----------
attribution : str
Attribution for the dataset incl. © symbol, e.g. '© GeoBasis-DE / BKG'
Returns
-------
dict
OEP metadata conform data license information
"""
return {
"name": "dl-by-de/2.0",
"title": "Datenlizenz Deutschland – Namensnennung – Version 2.0",
"path": "www.govdata.de/dl-de/by-2-0",
"instruction": (
"Jede Nutzung ist unter den Bedingungen dieser „Datenlizenz "
"Deutschland - Namensnennung - Version 2.0 zulässig.\nDie "
"bereitgestellten Daten und Metadaten dürfen für die "
"kommerzielle und nicht kommerzielle Nutzung insbesondere:"
"(1) vervielfältigt, ausgedruckt, präsentiert, verändert, "
"bearbeitet sowie an Dritte übermittelt werden;\n "
"(2) mit eigenen Daten und Daten Anderer zusammengeführt und "
"zu selbständigen neuen Datensätzen verbunden werden;\n "
"(3) in interne und externe Geschäftsprozesse, Produkte und "
"Anwendungen in öffentlichen und nicht öffentlichen "
"elektronischen Netzwerken eingebunden werden.\n"
"Bei der Nutzung ist sicherzustellen, dass folgende Angaben "
"als Quellenvermerk enthalten sind:\n"
"(1) Bezeichnung des Bereitstellers nach dessen Maßgabe,\n"
"(2) der Vermerk Datenlizenz Deutschland – Namensnennung – "
"Version 2.0 oder dl-de/by-2-0 mit Verweis auf den Lizenztext "
"unter www.govdata.de/dl-de/by-2-0 sowie\n"
"(3) einen Verweis auf den Datensatz (URI)."
"Dies gilt nur soweit die datenhaltende Stelle die Angaben"
"(1) bis (3) zum Quellenvermerk bereitstellt.\n"
"Veränderungen, Bearbeitungen, neue Gestaltungen oder "
"sonstige Abwandlungen sind im Quellenvermerk mit dem Hinweis "
"zu versehen, dass die Daten geändert wurden."
),
"attribution": attribution,
}
def license_odbl(attribution):
"""
License information for Open Data Commons Open Database License (ODbL-1.0)
Parameters
----------
attribution : str
Attribution for the dataset incl. © symbol, e.g.
'© OpenStreetMap contributors'
Returns
-------
dict
OEP metadata conform data license information
"""
return {
"name": "ODbL-1.0",
"title": "Open Data Commons Open Database License 1.0",
"path": "https://opendatacommons.org/licenses/odbl/1.0/index.html",
"instruction": "You are free: To Share, To Create, To Adapt; "
"As long as you: Attribute, Share-Alike, Keep open!",
"attribution": attribution,
}
def license_ccby(attribution):
"""
License information for Creative Commons Attribution 4.0 International
(CC-BY-4.0)
Parameters
----------
attribution : str
Attribution for the dataset incl. © symbol, e.g. '© GeoBasis-DE / BKG'
Returns
-------
dict
OEP metadata conform data license information
"""
return {
"name": "CC-BY-4.0",
"title": "Creative Commons Attribution 4.0 International",
"path": "https://creativecommons.org/licenses/by/4.0/legalcode",
"instruction": "You are free: To Share, To Create, To Adapt; "
"As long as you: Attribute.",
"attribution": attribution,
}
def license_geonutzv(attribution):
"""
License information for GeoNutzV
Parameters
----------
attribution : str
Attribution for the dataset incl. © symbol, e.g. '© GeoBasis-DE / BKG'
Returns
-------
dict
OEP metadata conform data license information
"""
return {
"name": "geonutzv-de-2013-03-19",
"title": "Verordnung zur Festlegung der Nutzungsbestimmungen für die "
"Bereitstellung von Geodaten des Bundes",
"path": "https://www.gesetze-im-internet.de/geonutzv/",
"instruction": "Geodaten und Geodatendienste, einschließlich "
"zugehöriger Metadaten, werden für alle derzeit "
"bekannten sowie für alle zukünftig bekannten Zwecke "
"kommerzieller und nicht kommerzieller Nutzung "
"geldleistungsfrei zur Verfügung gestellt, soweit "
"durch besondere Rechtsvorschrift nichts anderes "
"bestimmt ist oder vertragliche oder gesetzliche "
"Rechte Dritter dem nicht entgegenstehen.",
"attribution": attribution,
}
def generate_resource_fields_from_sqla_model(model):
""" Generate a template for the resource fields for metadata from a SQL
Alchemy model.
For details on the fields see field 14.6.1 of `Open Energy Metadata
<https://github.com/OpenEnergyPlatform/ oemetadata/blob/develop/metadata/
v141/metadata_key_description.md>`_ standard.
The fields `name` and `type` are automatically filled, the `description`
and `unit` must be filled manually.
Examples
--------
>>> from egon.data.metadata import generate_resource_fields_from_sqla_model
>>> from egon.data.datasets.zensus_vg250 import Vg250Sta
>>> resources = generate_resource_fields_from_sqla_model(Vg250Sta)
Parameters
----------
model : sqlalchemy.ext.declarative.declarative_base()
SQLA model
Returns
-------
list of dict
Resource fields
"""
return [
{
"name": col.name,
"description": "",
"type": str(col.type).lower(),
"unit": "none",
}
for col in model.__table__.columns
]
def generate_resource_fields_from_db_table(schema, table, geom_columns=None):
""" Generate a template for the resource fields for metadata from a
database table.
For details on the fields see field 14.6.1 of `Open Energy Metadata
<https://github.com/OpenEnergyPlatform/ oemetadata/blob/develop/metadata/
v141/metadata_key_description.md>`_ standard.
The fields `name` and `type` are automatically filled, the `description`
and `unit` must be filled manually.
Examples
--------
>>> from egon.data.metadata import generate_resource_fields_from_db_table
>>> resources = generate_resource_fields_from_db_table(
... 'openstreetmap', 'osm_point', ['geom', 'geom_centroid']
... ) # doctest: +SKIP
Parameters
----------
schema : str
The target table's database schema
table : str
Database table on which to put the given comment
geom_columns : list of str
Names of all geometry columns in the table. This is required to return
Geometry data type for those columns as SQL Alchemy does not recognize
them correctly. Defaults to ['geom'].
Returns
-------
list of dict
Resource fields
"""
# handle geometry columns
if geom_columns is None:
geom_columns = ["geom"]
for col in geom_columns:
ischema_names[col] = Geometry
table = Table(
table, MetaData(), schema=schema, autoload=True, autoload_with=engine()
)
return [
{
"name": col.name,
"description": "",
"type": str(col.type).lower(),
"unit": "none",
}
for col in table.c
]