-
Notifications
You must be signed in to change notification settings - Fork 23
/
OutputOpenSdg.py
296 lines (254 loc) · 12.1 KB
/
OutputOpenSdg.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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
import os
import sdg
from sdg.outputs import OutputBase
from sdg.data import write_csv
from sdg.json import write_json, df_to_list_dict
class OutputOpenSdg(OutputBase):
"""Output SDG data/metadata in the formats expected by Open SDG."""
def __init__(self, inputs, schema, output_folder='_site', translations=None,
reporting_status_extra_fields=None, indicator_options=None,
indicator_downloads=None, logging=None, indicator_export_filename='all_indicators',
ignore_out_of_scope_disaggregation_stats=False):
"""Constructor for OutputOpenSdg.
Parameters
----------
Inherits all the parameters from OutputBase, plus the following:
reporting_status_extra_fields : string
To be passed as "extra_fields" to sdg.stats.reporting_status.
indicator_downloads : list
A list of dicts describing calls to the write_downloads() method of
IndicatorDownloadService.
indicator_export_filename : string
A filename (without the extension) for the zipped indicator export.
ignore_out_of_scope_disaggregation_stats : boolean
Whether to ignore the "not applicable" disaggregation stats.
"""
if translations is None:
translations = []
OutputBase.__init__(self, inputs, schema, output_folder, translations,
indicator_options, logging=logging)
self.reporting_status_grouping_fields = reporting_status_extra_fields
self.indicator_downloads = indicator_downloads
self.indicator_export_filename = indicator_export_filename
self.ignore_na = ignore_out_of_scope_disaggregation_stats
def build(self, language=None):
"""Write the JSON output expected by Open SDG. Overrides parent."""
status = True
all_meta = dict()
all_headline = dict()
site_dir = self.output_folder
# Write the schema.
schema_output = sdg.schemas.SchemaOutputOpenSdg(schema=self.schema)
schema_output_folder = os.path.join(site_dir, 'meta')
schema_output.write_schema(output_folder=schema_output_folder, filename='schema.json')
# Write the translations.
translation_output = sdg.translations.TranslationOutputJson(self.translations)
translation_folder = os.path.join(site_dir, 'translations')
translation_output.write_translations(
language=language,
output_folder=translation_folder,
filename='translations.json'
)
for indicator_id in self.get_indicator_ids():
indicator = self.get_indicator_by_id(indicator_id).language(language)
# Output all the csvs
status = status & write_csv(indicator_id, indicator.data, ftype='data', site_dir=site_dir)
status = status & write_csv(indicator_id, indicator.edges, ftype='edges', site_dir=site_dir)
status = status & write_csv(indicator_id, indicator.headline, ftype='headline', site_dir=site_dir)
# And JSON
data_dict = df_to_list_dict(indicator.data, orient='list')
edges_dict = df_to_list_dict(indicator.edges, orient='list')
headline_dict = df_to_list_dict(indicator.headline, orient='records')
status = status & write_json(indicator_id, data_dict, ftype='data', gz=False, site_dir=site_dir)
status = status & write_json(indicator_id, edges_dict, ftype='edges', gz=False, site_dir=site_dir)
status = status & write_json(indicator_id, headline_dict, ftype='headline', gz=False, site_dir=site_dir)
# combined
comb = {'data': data_dict, 'edges': edges_dict}
status = status & write_json(indicator_id, comb, ftype='comb', gz=False, site_dir=site_dir)
# Metadata
status = status & sdg.json.write_json(indicator_id, indicator.meta, ftype='meta', site_dir=site_dir)
# Append to the build-time "all" output
all_meta[indicator_id] = indicator.meta
all_headline[indicator_id] = headline_dict
status = status & sdg.json.write_json('all', all_meta, ftype='meta', site_dir=site_dir)
status = status & sdg.json.write_json('all', all_headline, ftype='headline', site_dir=site_dir)
# Reporting status.
stats_reporting = sdg.stats.reporting_status(all_meta, self.reporting_status_grouping_fields)
status = status & sdg.json.write_json('reporting', stats_reporting, ftype='stats', site_dir=site_dir)
disaggregation_status_service = sdg.DisaggregationStatusService(
site_dir,
self.indicators,
self.reporting_status_grouping_fields,
self.ignore_na,
)
disaggregation_status_service.write_json()
indicator_export_service = sdg.IndicatorExportService(site_dir, self.indicators, filename=self.indicator_export_filename)
indicator_export_service.export_all_indicator_data_as_zip_archive()
# Write the indicator downloads.
if self.indicator_downloads is not None:
download_service = sdg.IndicatorDownloadService(self.output_folder)
for download in self.indicator_downloads:
download_service.write_downloads(
download['button_label'],
download['source_pattern'],
download['indicator_id_pattern'] if 'indicator_id_pattern' in download else None,
download['output_folder']
)
download_service.write_index()
return(status)
def generate_sort_order(self, indicator):
"""Generate a sortable string from an indicator id.
Parameters
----------
indicator : Indicator
An instance of the Indicator class.
Returns
-------
string
A string suitable for sorting indicators.
"""
parts = indicator.get_indicator_id().split('.')
sorted = []
for part in parts:
padded_part = part if len(part) > 1 else '0' + part
sorted.append(padded_part)
return '-'.join(sorted)
def minimum_metadata(self, indicator):
"""Provide minimum metadata for an indicator. Overrides parent."""
minimum = {
'indicator_number': indicator.get_indicator_id(),
'target_number': indicator.get_target_id(),
'goal_number': indicator.get_goal_id(),
'reporting_status': 'complete' if (indicator.has_data() or indicator.is_statistical() == False) else 'notstarted',
'data_non_statistical': False if indicator.has_data() else True,
'graph_type': 'line',
'indicator_sort_order': self.generate_sort_order(indicator)
}
# Add names only if the indicator has one.
if indicator.has_name():
minimum['indicator_name'] = indicator.get_name()
minimum['graph_title'] = indicator.get_name()
# Or fall back to translation keys.
else:
translation_key = 'global_indicators.' + indicator.get_slug() + '-title'
minimum['indicator_name'] = translation_key
minimum['graph_title'] = translation_key
return minimum
def get_documentation_title(self):
return 'Open SDG output'
def get_documentation_content(self, languages=None, baseurl=''):
if languages is None:
languages = ['']
indicator_ids = self.get_documentation_indicator_ids()
sections = [
{
'title': 'Headlines',
'description': 'CSV/JSON files containing "headline" (aggregated only) data for indicators',
'loop_indicators': True,
'endpoints': [
'{language}/headline/{indicator_id}.csv',
'{language}/headline/{indicator_id}.json'
]
},
{
'title': 'Data',
'description': 'CSV/JSON files containing fully disaggregated data for indicators',
'loop_indicators': True,
'endpoints': [
'{language}/data/{indicator_id}.csv',
'{language}/data/{indicator_id}.json'
]
},
{
'title': 'Edges',
'description': 'CSV/JSON files containing "edges" (relationships between disaggregations) data for indicators',
'loop_indicators': True,
'endpoints': [
'{language}/edges/{indicator_id}.csv',
'{language}/edges/{indicator_id}.json'
]
},
{
'title': 'Combined edges and data',
'description': 'JSON files containing both the fully-disaggregated and "edges" data mentioned above',
'loop_indicators': True,
'endpoints': [
'{language}/comb/{indicator_id}.json'
]
},
{
'title': 'Metadata',
'description': 'JSON files containing metadata for the indicators',
'loop_indicators': True,
'endpoints': [
'{language}/meta/{indicator_id}.json'
]
},
{
'title': 'Zip file of CSV data',
'description': 'Zip files containing all indicators in CSV form',
'loop_indicators': False,
'endpoints': [
'{language}/zip/' + self.indicator_export_filename + '.zip'
]
},
{
'title': 'Zip file information',
'description': 'JSON file containing information about the above-mentioned zip files',
'loop_indicators': False,
'endpoints': [
'{language}/zip/all_indicators.json'
]
},
{
'title': 'Reporting status',
'description': 'JSON file containing information about the reporting status of the indicators',
'loop_indicators': False,
'endpoints': [
'{language}/stats/reporting.json'
]
},
{
'title': 'Translations',
'description': 'JSON file containing all the translations used in the platform',
'loop_indicators': False,
'endpoints': [
'{language}/translations/translations.json'
]
}
]
output = '<p>' + self.get_documentation_description() + ' Examples are below:<p>'
for section in sections:
output += '<h2>' + section['title'] + '</h2>'
output += '<p>' + section['description'] + '</p>'
output += '<ul>'
for language in languages:
for indicator_id in indicator_ids:
for endpoint in section['endpoints']:
path = endpoint.format(language=language, indicator_id=indicator_id)
output += '<li><a href="' + baseurl + path + '">' + path + '</a></li>'
if section['loop_indicators'] == False:
break
if section['loop_indicators'] == True:
output += '<li>etc...</li>'
output += '</ul>'
return output
def get_documentation_indicator_ids(self):
indicator_ids = []
for indicator_id in self.get_indicator_ids():
if len(indicator_ids) > 2:
break
indicator = self.get_indicator_by_id(indicator_id)
if not indicator.has_edges():
continue
if not indicator.has_headline():
continue
indicator_ids.append(indicator_id)
if len(indicator_ids) < 1:
return OutputBase.get_documentation_indicator_ids(self)
else:
return indicator_ids
def get_documentation_description(self):
return """This output includes a variety of endpoints designed to
support the <a href="https://open-sdg.readthedocs.io">Open SDG</a>
platform."""