py-epc-uk 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. py_epc_uk-0.1.0/ATTRIBUTION.md +46 -0
  2. py_epc_uk-0.1.0/LICENSE +373 -0
  3. py_epc_uk-0.1.0/PKG-INFO +193 -0
  4. py_epc_uk-0.1.0/README.md +175 -0
  5. py_epc_uk-0.1.0/pyproject.toml +74 -0
  6. py_epc_uk-0.1.0/src/py_epc/__init__.py +60 -0
  7. py_epc_uk-0.1.0/src/py_epc/_config.py +375 -0
  8. py_epc_uk-0.1.0/src/py_epc/_dataset/__init__.py +1 -0
  9. py_epc_uk-0.1.0/src/py_epc/_dataset/_air_tightness.py +132 -0
  10. py_epc_uk-0.1.0/src/py_epc/_dataset/_bilingual.py +130 -0
  11. py_epc_uk-0.1.0/src/py_epc/_dataset/_build.py +221 -0
  12. py_epc_uk-0.1.0/src/py_epc/_dataset/_categories.py +237 -0
  13. py_epc_uk-0.1.0/src/py_epc/_dataset/_construction_age.py +158 -0
  14. py_epc_uk-0.1.0/src/py_epc/_dataset/_definition.py +227 -0
  15. py_epc_uk-0.1.0/src/py_epc/_dataset/_definitions/epc-england-and-wales-domestic.json +126 -0
  16. py_epc_uk-0.1.0/src/py_epc/_dataset/_definitions/epc-scotland-domestic.json +206 -0
  17. py_epc_uk-0.1.0/src/py_epc/_dataset/_distinct.py +176 -0
  18. py_epc_uk-0.1.0/src/py_epc/_dataset/_fabric.py +222 -0
  19. py_epc_uk-0.1.0/src/py_epc/_dataset/_floor_level.py +112 -0
  20. py_epc_uk-0.1.0/src/py_epc/_dataset/_lighting.py +134 -0
  21. py_epc_uk-0.1.0/src/py_epc/_dataset/_main_fuel.py +105 -0
  22. py_epc_uk-0.1.0/src/py_epc/_dataset/_models.py +13 -0
  23. py_epc_uk-0.1.0/src/py_epc/_dataset/_parts.py +123 -0
  24. py_epc_uk-0.1.0/src/py_epc/_dataset/_photo_supply.py +221 -0
  25. py_epc_uk-0.1.0/src/py_epc/_dataset/_phrases.py +272 -0
  26. py_epc_uk-0.1.0/src/py_epc/_dataset/_prepare.py +86 -0
  27. py_epc_uk-0.1.0/src/py_epc/_dataset/_summary.py +127 -0
  28. py_epc_uk-0.1.0/src/py_epc/_dataset/_systems.py +249 -0
  29. py_epc_uk-0.1.0/src/py_epc/_dataset/_text.py +256 -0
  30. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/alternative_improvements.json +32 -0
  31. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/built_form.json +33 -0
  32. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/energy_tariff.json +33 -0
  33. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/floor.json +59 -0
  34. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/glazed_area.json +29 -0
  35. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/glazed_type.json +41 -0
  36. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/heat_loss_corridor.json +24 -0
  37. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/hotwater.json +269 -0
  38. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/lzc_energy_sources.json +72 -0
  39. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/main_fuel.json +153 -0
  40. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/main_heating_category.json +53 -0
  41. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/mainheat.json +667 -0
  42. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/mainheatcont.json +296 -0
  43. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/mechanical_ventilation.json +44 -0
  44. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/property_type.json +28 -0
  45. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/report_type.json +16 -0
  46. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/roof.json +117 -0
  47. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/secondheat.json +291 -0
  48. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/tenure.json +21 -0
  49. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/transaction_type.json +77 -0
  50. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/type_of_assessment.json +16 -0
  51. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/walls.json +132 -0
  52. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabularies/windows.json +132 -0
  53. py_epc_uk-0.1.0/src/py_epc/_dataset/_vocabulary.py +157 -0
  54. py_epc_uk-0.1.0/src/py_epc/_download.py +305 -0
  55. py_epc_uk-0.1.0/src/py_epc/_enums.py +109 -0
  56. py_epc_uk-0.1.0/src/py_epc/_files.py +60 -0
  57. py_epc_uk-0.1.0/src/py_epc/_manifest.py +121 -0
  58. py_epc_uk-0.1.0/src/py_epc/_output.py +140 -0
  59. py_epc_uk-0.1.0/src/py_epc/_pipeline.py +426 -0
  60. py_epc_uk-0.1.0/src/py_epc/_process/__init__.py +1 -0
  61. py_epc_uk-0.1.0/src/py_epc/_process/_archive.py +239 -0
  62. py_epc_uk-0.1.0/src/py_epc/_process/_build.py +348 -0
  63. py_epc_uk-0.1.0/src/py_epc/_process/_latest.py +202 -0
  64. py_epc_uk-0.1.0/src/py_epc/_process/_postcodes.py +503 -0
  65. py_epc_uk-0.1.0/src/py_epc/_process/_register.py +258 -0
  66. py_epc_uk-0.1.0/src/py_epc/_process/_registers/epc-england-and-wales-domestic.json +600 -0
  67. py_epc_uk-0.1.0/src/py_epc/_process/_registers/epc-scotland-domestic.json +690 -0
  68. py_epc_uk-0.1.0/src/py_epc/_process/_registers/ons-postcode-directory.json +157 -0
  69. py_epc_uk-0.1.0/src/py_epc/_process/_values.py +119 -0
  70. py_epc_uk-0.1.0/src/py_epc/_scan.py +286 -0
  71. py_epc_uk-0.1.0/src/py_epc/_source.py +30 -0
  72. py_epc_uk-0.1.0/src/py_epc/defaults.json +59 -0
  73. py_epc_uk-0.1.0/src/py_epc/py.typed +0 -0
@@ -0,0 +1,46 @@
1
+ # Attribution
2
+
3
+ Py-EPC downloads data from the publishers below. The library is shipped with none of the listed data. Each user
4
+ downloads the data they need, and the onus is on the user to follow the respective licence. The licence of Py-EPC's code
5
+ does not cover the listed data.
6
+
7
+ ## Energy Performance Certificates, England and Wales
8
+
9
+ - **Publisher**: Ministry of Housing, Communities and Local Government, through the
10
+ [Get energy performance of buildings data](https://get-energy-performance-data.communities.gov.uk) service.
11
+ - **Licence**: every field except the address fields is under the
12
+ [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/), including
13
+ Ordnance Survey UPRNs.
14
+ - **Address fields** (`address1` to `address3`, `address`, `postcode`): Ordnance Survey and Royal Mail reserve their
15
+ copyright and database rights. They may be used only for the purposes listed in the
16
+ [licensing restrictions](https://get-energy-performance-data.communities.gov.uk/guidance/licensing-restrictions),
17
+ which relate to the energy performance of buildings. Anyone sharing address data must include a copy of that notice.
18
+ - **Personal data**: the data is personal data under UK GDPR and the Data Protection Act 2018. Its users are data
19
+ controllers.
20
+
21
+ ## Energy Performance Certificates, Scotland
22
+
23
+ - **Publisher**: Scottish Government, through the [Scottish EPC Register](https://www.scottishepcregister.org.uk),
24
+ published on [data.gov.scot](https://data.gov.scot).
25
+ - **Licence**: every field except the address fields is under the Open Government Licence v3.0.
26
+ - **Address fields** (`ADDRESS1`, `ADDRESS2`, `ADDRESS3` (the post town), `POSTCODE`): Royal Mail copyright, for the
27
+ energy performance purposes listed in each release's publication note. Anyone republishing address data must include
28
+ the Royal Mail copyright notice.
29
+
30
+ ## ONS Postcode Directory
31
+
32
+ - **Publisher**: Office for National Statistics, through the
33
+ [Open Geography Portal](https://geoportal.statistics.gov.uk).
34
+ - **Licence**: Open Government Licence v3.0, for Great Britain, with these attributions:
35
+ 1. Contains OS data © Crown copyright and database right [year]
36
+ 2. Contains Royal Mail data © Royal Mail copyright and database right [year]
37
+ 3. Source: Office for National Statistics licensed under the Open Government Licence v.3.0
38
+ - **Northern Ireland**: postcodes starting `BT` are not under the Open Government Licence. Commercial use needs a
39
+ licence from Land and Property Services. Py-EPC always leaves them out.
40
+ - See the [ONS licences](https://www.ons.gov.uk/methodology/geography/licences).
41
+
42
+ ## OS Open UPRN
43
+
44
+ - **Publisher**: Ordnance Survey, through the [OS Data Hub](https://osdatahub.os.uk).
45
+ - **Licence**: Open Government Licence v3.0, with this attribution:
46
+ - Contains OS data © Crown copyright and database right [year]
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
@@ -0,0 +1,193 @@
1
+ Metadata-Version: 2.4
2
+ Name: py-epc-uk
3
+ Version: 0.1.0
4
+ Summary: Download, process and clean the UK Energy Performance Certificate registers of England and Wales and of Scotland.
5
+ Author: David Huang
6
+ Author-email: David Huang <dh.fwc18@gmail.com>
7
+ License-Expression: MPL-2.0
8
+ License-File: ATTRIBUTION.md
9
+ License-File: LICENSE
10
+ Requires-Dist: httpx>=0.28.1
11
+ Requires-Dist: polars>=2.1.0
12
+ Requires-Dist: py7zr>=1.1.4
13
+ Requires-Dist: pydantic>=2.14.3
14
+ Requires-Python: >=3.14
15
+ Project-URL: Issues, https://github.com/dhfwc18/py-epc/issues
16
+ Project-URL: Repository, https://github.com/dhfwc18/py-epc
17
+ Description-Content-Type: text/markdown
18
+
19
+ # Py-EPC
20
+
21
+ Py-EPC downloads the published Energy Performance Certificate (EPC) registers for England and Wales and for Scotland,
22
+ processes them into typed Parquet, marks each property's latest certificate, adds the ONS areas of each postcode, and
23
+ builds a dataset whose text is cleaned and whose descriptions are parsed into columns. Both registers can be read
24
+ together, for Great Britain. Every step is an explicit call, and every result is a lazy [Polars](https://pola.rs) frame.
25
+
26
+ Py-EPC was inspired by [carbon.place](https://www.carbon.place), by Malcolm Morgan at the University of Leeds. Its
27
+ published behaviour informed the design of some modules, but none of its code is used.
28
+
29
+ ## Quick start
30
+
31
+ Py-EPC is published on [PyPI](https://pypi.org/project/py-epc-uk/) as `py-epc-uk`, and imported as `py_epc`. Install it
32
+ with `pip install py-epc-uk`, or `uv add py-epc-uk`.
33
+
34
+ ```python
35
+ import polars as pl
36
+ import py_epc
37
+
38
+ root = "data" # Folder for downloads and builds, created if missing.
39
+
40
+ # 1. Download the published files, unchanged. England and Wales needs a token from
41
+ # https://get-energy-performance-data.communities.gov.uk; Scotland needs none.
42
+ py_epc.download_epc("scotland", "domestic", root)
43
+ py_epc.download_ons_postcode_directory(root)
44
+
45
+ # 2. Process them into typed Parquet.
46
+ py_epc.process_epc("scotland", "domestic", root)
47
+ py_epc.process_ons_postcode_directory(root)
48
+
49
+ # 3. Build the dataset, with text cleaned and descriptions parsed into columns.
50
+ py_epc.build_epc_dataset("scotland", "domestic", root)
51
+
52
+ # 4. Read the latest certificate of each property, with its ONS areas.
53
+ homes = py_epc.scan_epc("scotland", "domestic", root, stage="dataset", latest=True, geography=True)
54
+ homes.group_by("ons_itl1_name").agg(pl.col("lighting_low_energy_percent").mean()).collect()
55
+
56
+ # 5. Once England and Wales is downloaded, processed and built too, read both for Great Britain.
57
+ gb = py_epc.scan_epc("gb", "domestic", root, stage="dataset", latest=True)
58
+ gb.group_by("origin", "assessment_method").agg(pl.col("heating_cost_current").median()).collect()
59
+ ```
60
+
61
+ ## In one call
62
+
63
+ `run_epc_pipeline` covers every step outlined above for an origin and segment, then reads the result. It reuses the
64
+ newest download, build and dataset already made, and only makes what is missing, so running it again is quick.
65
+
66
+ ```python
67
+ # The latest certificates of Great Britain, as a lazy frame. England and Wales needs a token the first time.
68
+ homes = py_epc.run_epc_pipeline("gb", "domestic", root, latest=True, token="...")
69
+
70
+ # The same, written to one file, data/outputs/epc-gb-domestic-dataset-latest.parquet, whose path is returned.
71
+ path = py_epc.run_epc_pipeline("gb", "domestic", root, latest=True, output_type="parquet")
72
+ ```
73
+
74
+ - `output_type` is `"parquet"` or `"sqlite"`. A manifest beside the file, `<name>.manifest.json`, names every download
75
+ it was made from. SQLite stores categories, dates and lists as text, and is much larger, about 1.4 KB a certificate,
76
+ so all of England and Wales is about 42 GB. `output_path` writes the file elsewhere, and `overwrite=True` replaces an
77
+ existing one.
78
+ - `stage="processed"` stops before the dataset, and reads the processed builds.
79
+ - `update=True` downloads each register again. A download identical to the one already kept is deleted, and its build
80
+ and dataset are reused.
81
+ - `clean_up=True`, with an output, deletes the download, build and dataset each register's output was made from, so only
82
+ the output is left. The postcode directory and other snapshots are kept. The next run downloads the registers again.
83
+
84
+ ## What each step does
85
+
86
+ - **Download** saves each published file unchanged, with a manifest of its source, size and SHA-256, in
87
+ `raw/<source>/<timestamp>/`.
88
+ - **Process** checks every yearly file against the register's published columns, parses values into their types, renames
89
+ columns where the two registers mean the same thing, and writes one Parquet file per lodgement year. Values that do
90
+ not parse become null, and are counted in the build's manifest with examples.
91
+ - **Latest**: each certificate gets `is_latest`, true for the newest certificate of its property, found by UPRN and, in
92
+ Scotland, the register's building reference.
93
+ - **Geography**: the ONS Postcode Directory is processed into the chosen areas of each postcode, with codes and names.
94
+ `scan(..., geography=True)` adds them to each certificate with the prefix `ons_`.
95
+ - **Dataset** prepares each lodgement year of a build by the source's dataset definition. England and Wales's bilingual
96
+ values keep their English, and every text column is cleaned. Scotland describes each part of a building, such as an
97
+ extension, so each element is reduced to its main part, with every part kept in `<column>_parts`. Each description is
98
+ then parsed into columns. `scan(..., stage="dataset")` reads the result.
99
+ - **Great Britain** reads both registers as one frame, with `scan_epc("gb", ...)`. See [Great Britain](#great-britain).
100
+
101
+ ## Dataset columns
102
+
103
+ Each parsed description gives columns named after it. The table lists the main ones.
104
+
105
+ | Published column | Columns added |
106
+ | ------------------------------- | ---------------------------------------------------------------------------------- |
107
+ | `walls_description` | `walls_construction`, `walls_insulation`, `walls_u_value`, `walls_assumed` |
108
+ | `roof_description` | as for walls, with `roof_insulation_mm` |
109
+ | `floor_description` | as for walls |
110
+ | `mainheat_description` | `mainheat_system`, `mainheat_emitter`, `mainheat_fuel`, and the same for a second |
111
+ | `hotwater_description` | `hotwater_system`, `hotwater_cylinder_thermostat`, `hotwater_solar` and others |
112
+ | `lighting_description` | `lighting_low_energy_percent`, or `lighting_efficiency` |
113
+ | `construction_age_band` | `construction_age_from`, `construction_age_to` |
114
+ | `floor_level` | `floor_level_number`, where 21 means 21 or above, and `floor_level_position` |
115
+ | `main_fuel` | `main_fuel` as a category, and `main_fuel_community` |
116
+ | `air_tightness_description` | `air_tightness_m3_per_h_m2`, `air_tightness_basis`, `air_tightness_test`, Scotland |
117
+ | `photo_supply_description` | `photo_supply_peak_kw` and the other totals of each dwelling's panels, Scotland |
118
+ | `tenure`, `built_form` and more | the same column, as a category |
119
+ | `lzc_energy_sources` | the same column, as a list of categories, Scotland |
120
+
121
+ Each parsed column also gets `<column>_kind`, saying what its phrase turned out to be. Only a `described` phrase gives
122
+ values. A placeholder is `not_a_description`, a phrase belonging to another column is `misplaced`, and an impossible
123
+ value, such as a share above 100%, is `invalid`. Each of these gives null, so it is never mistaken for a description. A
124
+ phrase of no known form is `unknown`, and stops the build, unless it is built with `strict=False`, when it gives null
125
+ with a warning. The dataset's manifest counts each column's rows by kind, for every year.
126
+
127
+ ## Great Britain
128
+
129
+ `scan_epc("gb", ...)` reads the newest build, or dataset, of each register and stacks them. It keeps the columns both
130
+ registers have with the same name and type, after an `origin` column of `scotland` or `england-and-wales`. Columns only
131
+ one register publishes, such as Scotland's building parts or England and Wales's `constituency`, stay in that register's
132
+ own build and dataset. `latest=True` keeps each register's latest certificates, and the ONS areas are added by default,
133
+ so every certificate has the same areas whichever register it is from.
134
+
135
+ Each register's dataset reconciles the columns that differ, so they can be compared. The table shows how.
136
+
137
+ | Column | England and Wales | Scotland |
138
+ | -------------------------------- | ----------------------- | ------------------------------------------------- |
139
+ | `assessment_method` | `report_type`, 2 or 3 | `type_of_assessment`, such as "SAP, new dwelling" |
140
+ | `heating_cost_current` and so on | published per year | a third of the cost published over 3 years |
141
+ | `photo_supply_roof_area_percent` | `photo_supply`, renamed | parsed from `photo_supply_description` |
142
+ | `glazed_area` | published as text | published as a number, parsed to one category |
143
+
144
+ `assessment_method` is `rdsap` or `sap`. A processed build has none of these, and leaves out `glazed_area`, so read
145
+ Great Britain from the datasets.
146
+
147
+ ## Text and place names
148
+
149
+ The dataset stage cleans text into ASCII, with `£` the only exception. Part of the text normalisation process removed
150
+ accents in place names, such as the circumflex in the Welsh name for Anglesey and the grave accents in many Gaelic place
151
+ names. This is a practical choice, so that values work in every tool, and not a judgement on the accents, which are
152
+ integral parts of how Welsh and Scottish Gaelic are written and of the heritage of the places they name. The processed
153
+ builds keep every value exactly as published, and ONS codes identify each place exactly, so use them wherever the
154
+ published spelling matters.
155
+
156
+ ## Settings
157
+
158
+ Settings are read from `py_epc.Config`, and can be changed, saved and loaded:
159
+
160
+ ```python
161
+ py_epc.Config.get("geography.fields") # ('lad', 'pcon', 'itl1')
162
+ py_epc.Config.set("geography.fields", ["lad", "pcon", "itl1", "lsoa21"])
163
+ py_epc.Config.set("geography.names", False) # Codes only, without names.
164
+ py_epc.Config.save("py-epc.json")
165
+ ```
166
+
167
+ The default areas are the local authority (`lad`), Westminster constituency (`pcon`) and ITL1 region (`itl1`), which
168
+ covers the 9 English regions, Wales and Scotland. Changing them needs the postcode directory to be processed again, with
169
+ `overwrite=True`, which takes a few seconds.
170
+
171
+ ## Data layout
172
+
173
+ ```text
174
+ <root>/
175
+ raw/ # Published files, never changed. Ignored by Git.
176
+ epc/scotland/domestic/<timestamp>/
177
+ ons/postcode-directory/<timestamp>/
178
+ processed/ # Builds, made again from raw at any time. Ignored by Git.
179
+ epc/scotland/domestic/<snapshot>/certificates/lodgement_year=<year>/data.parquet
180
+ ons/postcode-directory/<snapshot>/postcodes.parquet
181
+ datasets/ # Datasets, made again from processed at any time. Ignored by Git.
182
+ epc/scotland/domestic/<snapshot>/certificates/lodgement_year=<year>/data.parquet
183
+ outputs/ # Files written by run_epc_pipeline, with their manifests. Ignored by Git.
184
+ epc-gb-domestic-dataset-latest.parquet
185
+ epc-gb-domestic-dataset-latest.manifest.json
186
+ ```
187
+
188
+ ## Licences
189
+
190
+ Py-EPC's code is licensed under the [Mozilla Public License 2.0](https://github.com/dhfwc18/py-epc/blob/main/LICENSE).
191
+ Py-EPC does not publish any data. The user downloads the data and becomes responsible for its use.
192
+ [ATTRIBUTION.md](https://github.com/dhfwc18/py-epc/blob/main/ATTRIBUTION.md) lists every source, its licence, the
193
+ attributions it needs, and the restrictions on address data and personal data.