parsimony-eia 0.0.1__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.
- parsimony_eia-0.0.1/.gitignore +40 -0
- parsimony_eia-0.0.1/CHANGELOG.md +70 -0
- parsimony_eia-0.0.1/LICENSE +190 -0
- parsimony_eia-0.0.1/PKG-INFO +112 -0
- parsimony_eia-0.0.1/README.md +78 -0
- parsimony_eia-0.0.1/parsimony_eia/__init__.py +15 -0
- parsimony_eia-0.0.1/parsimony_eia/_http.py +96 -0
- parsimony_eia-0.0.1/parsimony_eia/catalog_build.py +37 -0
- parsimony_eia-0.0.1/parsimony_eia/connectors/__init__.py +19 -0
- parsimony_eia-0.0.1/parsimony_eia/connectors/enumerate.py +209 -0
- parsimony_eia-0.0.1/parsimony_eia/connectors/fetch.py +321 -0
- parsimony_eia-0.0.1/parsimony_eia/outputs.py +81 -0
- parsimony_eia-0.0.1/parsimony_eia/py.typed +0 -0
- parsimony_eia-0.0.1/parsimony_eia/search.py +39 -0
- parsimony_eia-0.0.1/pyproject.toml +78 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
__pycache__/
|
|
2
|
+
*.py[cod]
|
|
3
|
+
*$py.class
|
|
4
|
+
*.so
|
|
5
|
+
|
|
6
|
+
.Python
|
|
7
|
+
build/
|
|
8
|
+
dist/
|
|
9
|
+
*.egg-info/
|
|
10
|
+
*.egg
|
|
11
|
+
|
|
12
|
+
.venv/
|
|
13
|
+
.env
|
|
14
|
+
.env.*
|
|
15
|
+
!.env.example
|
|
16
|
+
|
|
17
|
+
.pytest_cache/
|
|
18
|
+
.mypy_cache/
|
|
19
|
+
.ruff_cache/
|
|
20
|
+
.coverage
|
|
21
|
+
htmlcov/
|
|
22
|
+
coverage.xml
|
|
23
|
+
|
|
24
|
+
uv.lock
|
|
25
|
+
|
|
26
|
+
.vscode/
|
|
27
|
+
.council/
|
|
28
|
+
PLAN-*.md
|
|
29
|
+
.idea/
|
|
30
|
+
*.swp
|
|
31
|
+
.DS_Store
|
|
32
|
+
|
|
33
|
+
outputs/
|
|
34
|
+
logs/
|
|
35
|
+
# Recorded HTTP cassettes must never be committed — respx mocks are hand-authored
|
|
36
|
+
# from upstream API documentation. A pre-commit / CI regex scan is the belt; this
|
|
37
|
+
# ignore is the braces. Override per-file via `!` if you need a hand-authored
|
|
38
|
+
# fixture checked in.
|
|
39
|
+
packages/*/tests/fixtures/**
|
|
40
|
+
!packages/*/tests/fixtures/README.md
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Changelog — parsimony-eia
|
|
2
|
+
|
|
3
|
+
All notable changes to `parsimony-eia` will be documented in this file. The
|
|
4
|
+
format is based on [Keep a Changelog](https://keepachangelog.com/) and
|
|
5
|
+
this project adheres to [Semantic Versioning](https://semver.org/).
|
|
6
|
+
|
|
7
|
+
## [0.8.0] — 2026-06-09
|
|
8
|
+
|
|
9
|
+
Re-run through the connector guidebook process: documentation compiled,
|
|
10
|
+
completeness proven live, and the shallow top-level-routes enumerator replaced
|
|
11
|
+
with a real searchable catalog.
|
|
12
|
+
|
|
13
|
+
### Fixed
|
|
14
|
+
|
|
15
|
+
- **Silent pagination truncation (data loss).** EIA caps every `/data` response
|
|
16
|
+
at 5,000 rows; `eia_fetch` previously made a single call and returned only the
|
|
17
|
+
first 5,000 of whatever matched (e.g. 5,000 of `petroleum/pri/spt` daily's
|
|
18
|
+
91,285 rows). Both fetch verbs now read `response.total` and page through with
|
|
19
|
+
`offset` until complete, guarded by a row-count ceiling that raises an
|
|
20
|
+
actionable `InvalidParameterError` (echoing EIA's own "constrain with facet,
|
|
21
|
+
start, end" guidance) instead of either truncating or pulling millions of rows.
|
|
22
|
+
- **400 errors lost their message.** A bad measure/frequency/facet returns a
|
|
23
|
+
clean HTTP 400 with a useful JSON body; it now maps to a message-preserving
|
|
24
|
+
`InvalidParameterError` rather than a generic `ProviderError(400)`.
|
|
25
|
+
- Period parsing now covers every EIA frequency (annual, monthly, daily, weekly,
|
|
26
|
+
quarterly `YYYY-Q#`, hourly `…THH`, local-hourly with a TZ band).
|
|
27
|
+
|
|
28
|
+
### Added
|
|
29
|
+
|
|
30
|
+
- **A searchable dataset catalog (`eia_search` + `enumerate_eia` rewrite).** The
|
|
31
|
+
enumerator now walks the full v2 route tree to one row per leaf dataset (232 at
|
|
32
|
+
release), each carrying its measure + facet manifest folded into the indexed
|
|
33
|
+
description. `eia_search` resolves a query to a dataset route. `catalog_build`,
|
|
34
|
+
`scripts/build_catalog.py`, and `catalog_tests/queries.yaml` added.
|
|
35
|
+
- **`eia_fetch_series`** — fetch by a legacy APIv1 series id (`PET.RWTC.D`,
|
|
36
|
+
`ELEC.SALES.CO-RES.A`) via the `/v2/seriesid/{id}` path, the addressing scheme
|
|
37
|
+
used across the EIA/FRED ecosystem. This path lives outside the route tree, so
|
|
38
|
+
it is the only way to reach a famous series straight from its id.
|
|
39
|
+
- **`eia_facets`** — list a facet dimension's `{id, name}` values so a fetch can
|
|
40
|
+
be narrowed to a specific series (essential for huge datasets — electricity
|
|
41
|
+
hourly is ~18.7M rows).
|
|
42
|
+
- **Facet filtering on `eia_fetch`** via a `facets={id: value|[values]}` param.
|
|
43
|
+
|
|
44
|
+
### Verified
|
|
45
|
+
|
|
46
|
+
- Catalog covers all **232 leaf datasets** across 14 categories (0 duplicate
|
|
47
|
+
codes; exact match to an independent route-tree walk). Every series is fetchable
|
|
48
|
+
by route+facets or legacy series id (EIA's ~2M-series universe is the facet
|
|
49
|
+
cartesian product — uncatalogable, fully accessible). Bump to
|
|
50
|
+
`parsimony-core>=0.7,<0.8`.
|
|
51
|
+
|
|
52
|
+
## [0.5.0] — 2026-05-06
|
|
53
|
+
|
|
54
|
+
### Changed
|
|
55
|
+
|
|
56
|
+
- Adapted to `parsimony-core==0.5`. Connector code no longer constructs `Provenance` directly; the framework authors all provenance fields in `Connector._wrap_result`. Source-specific extras (where present) move to `Result.with_properties(**kwargs)`. Drops the `provenance=` and `params=` kwargs from `OutputConfig.build_table_result` / `Result.from_dataframe` call sites.
|
|
57
|
+
- Bump `parsimony-core` pin from `>=0.4.0,<0.5` to `>=0.5.0,<0.6` (and `[standard-onnx]` extra accordingly on catalog-publishing packages).
|
|
58
|
+
## [0.4.0] — 2026-04-24
|
|
59
|
+
|
|
60
|
+
Part of the first coordinated release of the
|
|
61
|
+
[`parsimony-connectors`](https://github.com/ockham-sh/parsimony-connectors)
|
|
62
|
+
monorepo under `parsimony-core==0.4`.
|
|
63
|
+
|
|
64
|
+
### Changed
|
|
65
|
+
|
|
66
|
+
- Connector rewritten against the kernel's `parsimony.discover` surface
|
|
67
|
+
(`iter_providers`, `load`, `load_all`) and the `@connector(env=...)`
|
|
68
|
+
decorator-level env-var declaration that replaced module-level
|
|
69
|
+
`ENV_VARS`.
|
|
70
|
+
- Pin bumped to `parsimony-core>=0.4,<0.5`.
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by the Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding any notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
Copyright 2026 Ockham.sh
|
|
179
|
+
|
|
180
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
181
|
+
you may not use this file except in compliance with the License.
|
|
182
|
+
You may obtain a copy of the License at
|
|
183
|
+
|
|
184
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
185
|
+
|
|
186
|
+
Unless required by applicable law or agreed to in writing, software
|
|
187
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
188
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
189
|
+
See the License for the specific language governing permissions and
|
|
190
|
+
limitations under the License.
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: parsimony-eia
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: U.S. Energy Information Administration connector for the parsimony framework
|
|
5
|
+
Project-URL: Homepage, https://www.eia.gov
|
|
6
|
+
Project-URL: Repository, https://github.com/ockham-sh/parsimony-connectors
|
|
7
|
+
Project-URL: Issues, https://github.com/ockham-sh/parsimony-connectors/issues
|
|
8
|
+
Author-email: "Ockham.sh" <team@ockham.sh>
|
|
9
|
+
License-Expression: Apache-2.0
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: connectors,data,eia,finance,parsimony
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Intended Audience :: Financial and Insurance Industry
|
|
15
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
+
Classifier: Topic :: Office/Business :: Financial
|
|
21
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
22
|
+
Classifier: Typing :: Typed
|
|
23
|
+
Requires-Python: >=3.11
|
|
24
|
+
Requires-Dist: pandas<3,>=2.3.0
|
|
25
|
+
Requires-Dist: parsimony-core>=0.0.1
|
|
26
|
+
Requires-Dist: pydantic<3,>=2.11.1
|
|
27
|
+
Provides-Extra: dev
|
|
28
|
+
Requires-Dist: mypy>=1.10; extra == 'dev'
|
|
29
|
+
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
|
|
30
|
+
Requires-Dist: pytest>=9.0.3; extra == 'dev'
|
|
31
|
+
Requires-Dist: respx>=0.22.0; extra == 'dev'
|
|
32
|
+
Requires-Dist: ruff>=0.15.10; extra == 'dev'
|
|
33
|
+
Description-Content-Type: text/markdown
|
|
34
|
+
|
|
35
|
+
# parsimony-eia
|
|
36
|
+
|
|
37
|
+
U.S. Energy Information Administration (EIA) connector — fetches energy data (petroleum, electricity, natural gas, coal, renewables) from the EIA v2 Open Data API.
|
|
38
|
+
|
|
39
|
+
Part of the [parsimony-connectors](https://github.com/ockham-sh/parsimony-connectors) monorepo. Distributed standalone on PyPI as `parsimony-eia`.
|
|
40
|
+
|
|
41
|
+
## Connectors
|
|
42
|
+
|
|
43
|
+
| Name | Kind | Description |
|
|
44
|
+
|---|---|---|
|
|
45
|
+
| `eia_search` | tool | Semantic-search the dataset catalog; returns a dataset `route` to pass to `eia_fetch`. |
|
|
46
|
+
| `eia_fetch` | fetch | Fetch a dataset by `route` (e.g. `petroleum/pri/spt`) with optional `measure`, `facets`, `frequency`, `start`, `end`. Paged in full. |
|
|
47
|
+
| `eia_fetch_series` | fetch | Fetch by a legacy APIv1 series id (e.g. `PET.RWTC.D`) via the `/v2/seriesid/{id}` path. |
|
|
48
|
+
| `eia_facets` | tool | List the valid `{id, name}` values of a dataset's facet dimension, to narrow a fetch to a series. |
|
|
49
|
+
| `enumerate_eia` | enumerator | Walk the v2 route tree to one row per leaf dataset (the catalog feed). |
|
|
50
|
+
|
|
51
|
+
## Coverage
|
|
52
|
+
|
|
53
|
+
The catalog indexes **all 232 leaf datasets** across EIA's 14 top-level
|
|
54
|
+
categories (petroleum, natural gas, electricity, coal, nuclear, renewables/
|
|
55
|
+
densified-biomass, total energy, emissions, international, SEDS, STEO, AEO, IEO,
|
|
56
|
+
crude-oil imports), each carrying its measure and facet-dimension manifest. EIA's
|
|
57
|
+
full series universe (~2M series) is the facet cartesian product of those
|
|
58
|
+
datasets — too large to catalog individually, but every series is **fetchable**:
|
|
59
|
+
by `route` + `facets` filters, or by its legacy series id via `eia_fetch_series`.
|
|
60
|
+
So discovery is at the dataset tier and access is total.
|
|
61
|
+
|
|
62
|
+
EIA caps every data response at 5,000 rows; the fetch connectors page through to
|
|
63
|
+
completeness automatically (a request matching more than 300,000 rows is refused
|
|
64
|
+
with guidance to narrow it). Data is U.S. federal public domain — cite as
|
|
65
|
+
"Source: U.S. Energy Information Administration".
|
|
66
|
+
|
|
67
|
+
## Install
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
pip install parsimony-eia
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Pulls in a compatible `parsimony-core` automatically. Verify discovery:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
python -c "from parsimony import discover; print([p.name for p in discover.iter_providers()])"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Configuration
|
|
80
|
+
|
|
81
|
+
Set the following environment variable:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
export EIA_API_KEY="<your-key>"
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Get a free key at https://www.eia.gov/opendata/register.php.
|
|
88
|
+
|
|
89
|
+
## Quick start
|
|
90
|
+
|
|
91
|
+
```python
|
|
92
|
+
from parsimony_eia import CONNECTORS
|
|
93
|
+
|
|
94
|
+
result = CONNECTORS["eia_fetch"](route="petroleum/pri/spt", frequency="monthly")
|
|
95
|
+
print(result.data.head())
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
For multi-plugin composition:
|
|
99
|
+
|
|
100
|
+
```python
|
|
101
|
+
from parsimony import discover
|
|
102
|
+
connectors = discover.load_all()
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Provider
|
|
106
|
+
|
|
107
|
+
- Homepage: https://www.eia.gov
|
|
108
|
+
- API docs: https://www.eia.gov/opendata/documentation.php
|
|
109
|
+
|
|
110
|
+
## License
|
|
111
|
+
|
|
112
|
+
See [LICENSE](./LICENSE).
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# parsimony-eia
|
|
2
|
+
|
|
3
|
+
U.S. Energy Information Administration (EIA) connector — fetches energy data (petroleum, electricity, natural gas, coal, renewables) from the EIA v2 Open Data API.
|
|
4
|
+
|
|
5
|
+
Part of the [parsimony-connectors](https://github.com/ockham-sh/parsimony-connectors) monorepo. Distributed standalone on PyPI as `parsimony-eia`.
|
|
6
|
+
|
|
7
|
+
## Connectors
|
|
8
|
+
|
|
9
|
+
| Name | Kind | Description |
|
|
10
|
+
|---|---|---|
|
|
11
|
+
| `eia_search` | tool | Semantic-search the dataset catalog; returns a dataset `route` to pass to `eia_fetch`. |
|
|
12
|
+
| `eia_fetch` | fetch | Fetch a dataset by `route` (e.g. `petroleum/pri/spt`) with optional `measure`, `facets`, `frequency`, `start`, `end`. Paged in full. |
|
|
13
|
+
| `eia_fetch_series` | fetch | Fetch by a legacy APIv1 series id (e.g. `PET.RWTC.D`) via the `/v2/seriesid/{id}` path. |
|
|
14
|
+
| `eia_facets` | tool | List the valid `{id, name}` values of a dataset's facet dimension, to narrow a fetch to a series. |
|
|
15
|
+
| `enumerate_eia` | enumerator | Walk the v2 route tree to one row per leaf dataset (the catalog feed). |
|
|
16
|
+
|
|
17
|
+
## Coverage
|
|
18
|
+
|
|
19
|
+
The catalog indexes **all 232 leaf datasets** across EIA's 14 top-level
|
|
20
|
+
categories (petroleum, natural gas, electricity, coal, nuclear, renewables/
|
|
21
|
+
densified-biomass, total energy, emissions, international, SEDS, STEO, AEO, IEO,
|
|
22
|
+
crude-oil imports), each carrying its measure and facet-dimension manifest. EIA's
|
|
23
|
+
full series universe (~2M series) is the facet cartesian product of those
|
|
24
|
+
datasets — too large to catalog individually, but every series is **fetchable**:
|
|
25
|
+
by `route` + `facets` filters, or by its legacy series id via `eia_fetch_series`.
|
|
26
|
+
So discovery is at the dataset tier and access is total.
|
|
27
|
+
|
|
28
|
+
EIA caps every data response at 5,000 rows; the fetch connectors page through to
|
|
29
|
+
completeness automatically (a request matching more than 300,000 rows is refused
|
|
30
|
+
with guidance to narrow it). Data is U.S. federal public domain — cite as
|
|
31
|
+
"Source: U.S. Energy Information Administration".
|
|
32
|
+
|
|
33
|
+
## Install
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
pip install parsimony-eia
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Pulls in a compatible `parsimony-core` automatically. Verify discovery:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
python -c "from parsimony import discover; print([p.name for p in discover.iter_providers()])"
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Configuration
|
|
46
|
+
|
|
47
|
+
Set the following environment variable:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
export EIA_API_KEY="<your-key>"
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Get a free key at https://www.eia.gov/opendata/register.php.
|
|
54
|
+
|
|
55
|
+
## Quick start
|
|
56
|
+
|
|
57
|
+
```python
|
|
58
|
+
from parsimony_eia import CONNECTORS
|
|
59
|
+
|
|
60
|
+
result = CONNECTORS["eia_fetch"](route="petroleum/pri/spt", frequency="monthly")
|
|
61
|
+
print(result.data.head())
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
For multi-plugin composition:
|
|
65
|
+
|
|
66
|
+
```python
|
|
67
|
+
from parsimony import discover
|
|
68
|
+
connectors = discover.load_all()
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Provider
|
|
72
|
+
|
|
73
|
+
- Homepage: https://www.eia.gov
|
|
74
|
+
- API docs: https://www.eia.gov/opendata/documentation.php
|
|
75
|
+
|
|
76
|
+
## License
|
|
77
|
+
|
|
78
|
+
See [LICENSE](./LICENSE).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"""US Energy Information Administration (EIA): fetch + catalog enumeration.
|
|
2
|
+
|
|
3
|
+
API docs: https://www.eia.gov/opendata/documentation.php
|
|
4
|
+
|
|
5
|
+
The EIA v2 Open Data API is keyed. Supply ``EIA_API_KEY`` (or bind it via
|
|
6
|
+
``load(api_key=...)`` / ``Connector.bind``); a missing key fast-fails with
|
|
7
|
+
:class:`~parsimony.errors.UnauthorizedError`. Register a free key at
|
|
8
|
+
https://www.eia.gov/opendata/register.php.
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
from __future__ import annotations
|
|
12
|
+
|
|
13
|
+
from parsimony_eia.connectors import CONNECTORS, load
|
|
14
|
+
|
|
15
|
+
__all__ = ["CONNECTORS", "load"]
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
"""US EIA v2 Open Data API transport: key resolution, client, typed-error chokepoint.
|
|
2
|
+
|
|
3
|
+
The EIA v2 API is a single keyed REST host. The key rides as an ``?api_key=``
|
|
4
|
+
query param (``api_key`` is in parsimony-core's sensitive-param set, so it is
|
|
5
|
+
auto-redacted from logs) and is also stripped from provenance via
|
|
6
|
+
``secrets=("api_key",)`` on every verb.
|
|
7
|
+
|
|
8
|
+
``eia_get`` is the per-package mapper chokepoint: EIA returns a clean HTTP 400
|
|
9
|
+
with a useful JSON body for a bad measure / frequency / facet argument
|
|
10
|
+
(``{"error": "Invalid data 'x' ... valid data are 'value'", "code": 400}``).
|
|
11
|
+
``fetch_json`` would collapse that into a generic ``ProviderError(400)`` and drop
|
|
12
|
+
the actionable text, so this chokepoint reads the 400 body and raises
|
|
13
|
+
``InvalidParameterError`` preserving EIA's message; every other status falls
|
|
14
|
+
through to the canonical kernel mappers.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
from __future__ import annotations
|
|
18
|
+
|
|
19
|
+
import os
|
|
20
|
+
from typing import Any
|
|
21
|
+
|
|
22
|
+
import httpx
|
|
23
|
+
from parsimony.errors import InvalidParameterError, UnauthorizedError
|
|
24
|
+
from parsimony.transport import HttpClient, map_http_error, map_timeout_error
|
|
25
|
+
from parsimony.transport.helpers import make_http_client
|
|
26
|
+
|
|
27
|
+
PROVIDER = "eia"
|
|
28
|
+
ENV_VAR = "EIA_API_KEY"
|
|
29
|
+
BASE_URL = "https://api.eia.gov/v2"
|
|
30
|
+
|
|
31
|
+
# EIA caps every /data page at 5000 rows: a request with ``length`` > 5000 is
|
|
32
|
+
# silently clamped back to 5000 (verified live), so a single call can never
|
|
33
|
+
# return more than 5000 of a dataset's ``total`` rows. The fetch connector pages
|
|
34
|
+
# through with ``offset`` to reach completeness.
|
|
35
|
+
PAGE_SIZE = 5000
|
|
36
|
+
|
|
37
|
+
# Connectivity for the route-tree enumeration fan-out (~272 nodes). EIA enforces
|
|
38
|
+
# a short-window per-second cap and 429s a 6-wide fan-out; 4 keeps the crawl
|
|
39
|
+
# under that ceiling (the pooled-client retry policy still absorbs the rare 429)
|
|
40
|
+
# so a node is never dropped to a silently-shrunk catalog.
|
|
41
|
+
ENUMERATE_CONCURRENCY = 4
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
def resolve_key(api_key: str) -> str:
|
|
45
|
+
"""Resolve the API key (arg → ``EIA_API_KEY`` env fallback) or fast-fail."""
|
|
46
|
+
key = api_key or os.environ.get(ENV_VAR, "")
|
|
47
|
+
if not key:
|
|
48
|
+
raise UnauthorizedError(PROVIDER, env_var=ENV_VAR)
|
|
49
|
+
return key
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
def make_eia_client(api_key: str, *, timeout: float = 60.0) -> HttpClient:
|
|
53
|
+
"""Build the EIA client with the key fixed as a (redacted) default query param."""
|
|
54
|
+
key = resolve_key(api_key)
|
|
55
|
+
return make_http_client(BASE_URL, query_params={"api_key": key}, timeout=timeout)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
def _extract_400_message(response: httpx.Response) -> str:
|
|
59
|
+
"""Pull EIA's human-readable error string out of a 400 body (bounded length)."""
|
|
60
|
+
try:
|
|
61
|
+
err = response.json().get("error")
|
|
62
|
+
except ValueError:
|
|
63
|
+
err = None
|
|
64
|
+
if isinstance(err, str) and err.strip():
|
|
65
|
+
return err.strip()[:300]
|
|
66
|
+
return "invalid request parameter"
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
def eia_get(
|
|
70
|
+
http: HttpClient,
|
|
71
|
+
path: str,
|
|
72
|
+
*,
|
|
73
|
+
params: dict[str, Any] | None = None,
|
|
74
|
+
op_name: str,
|
|
75
|
+
) -> dict[str, Any]:
|
|
76
|
+
"""GET ``{BASE_URL}/{path}`` and return the ``response`` object (dict).
|
|
77
|
+
|
|
78
|
+
Drops ``None`` params, raises for status, maps a 400 to a message-preserving
|
|
79
|
+
``InvalidParameterError`` and every other error family to the canonical typed
|
|
80
|
+
errors. ``HttpClient.request`` never calls ``raise_for_status`` itself, so we
|
|
81
|
+
do it here and feed both error families to the kernel mappers.
|
|
82
|
+
"""
|
|
83
|
+
filtered = {k: v for k, v in (params or {}).items() if v is not None}
|
|
84
|
+
try:
|
|
85
|
+
response = http.request("GET", f"/{path.lstrip('/')}", params=filtered or None)
|
|
86
|
+
response.raise_for_status()
|
|
87
|
+
except httpx.HTTPStatusError as exc:
|
|
88
|
+
if exc.response.status_code == 400:
|
|
89
|
+
raise InvalidParameterError(PROVIDER, _extract_400_message(exc.response)) from exc
|
|
90
|
+
map_http_error(exc, provider=PROVIDER, op_name=op_name)
|
|
91
|
+
except httpx.TimeoutException as exc:
|
|
92
|
+
map_timeout_error(exc, provider=PROVIDER, op_name=op_name)
|
|
93
|
+
|
|
94
|
+
body = response.json()
|
|
95
|
+
inner = body.get("response") if isinstance(body, dict) else None
|
|
96
|
+
return inner if isinstance(inner, dict) else {}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"""Build the EIA dataset catalog snapshot.
|
|
2
|
+
|
|
3
|
+
Maintainer tooling, not part of the plugin contract: ``enumerate_eia`` walks the
|
|
4
|
+
v2 route tree to one row per leaf dataset (with its measure/facet manifest), the
|
|
5
|
+
rows become catalog entities, and the catalog is indexed and built. The series
|
|
6
|
+
within a dataset are not catalogued (EIA's ~2M-series universe is the facet
|
|
7
|
+
cartesian product) — they stay fetchable by route+facets or legacy series id.
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
from __future__ import annotations
|
|
11
|
+
|
|
12
|
+
from parsimony.catalog import Catalog
|
|
13
|
+
from parsimony.catalog.policy import discovery_indexes
|
|
14
|
+
from parsimony.catalog.source import entities_from_raw
|
|
15
|
+
|
|
16
|
+
from parsimony_eia.connectors.enumerate import enumerate_eia
|
|
17
|
+
from parsimony_eia.outputs import EIA_ENUMERATE_OUTPUT
|
|
18
|
+
|
|
19
|
+
CATALOG_NAMESPACE = "eia"
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
def build_eia_catalog(*, api_key: str | None = None) -> Catalog:
|
|
23
|
+
"""Enumerate every EIA leaf dataset and build a searchable catalog snapshot.
|
|
24
|
+
|
|
25
|
+
``api_key`` falls back to ``EIA_API_KEY`` inside ``enumerate_eia`` (which
|
|
26
|
+
fast-fails with :class:`~parsimony.errors.UnauthorizedError` if neither is
|
|
27
|
+
set), so the snapshot can be built straight from the environment.
|
|
28
|
+
"""
|
|
29
|
+
result = enumerate_eia(api_key=(api_key or "").strip())
|
|
30
|
+
entries = entities_from_raw(result, EIA_ENUMERATE_OUTPUT)
|
|
31
|
+
catalog = Catalog(CATALOG_NAMESPACE, indexes=discovery_indexes(entries), default_field="title")
|
|
32
|
+
catalog.set_entities(entries)
|
|
33
|
+
catalog.build()
|
|
34
|
+
return catalog
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
__all__ = ["CATALOG_NAMESPACE", "build_eia_catalog"]
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"""eia connector registry."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from parsimony.connector import Connectors
|
|
6
|
+
|
|
7
|
+
from parsimony_eia.connectors.enumerate import enumerate_eia
|
|
8
|
+
from parsimony_eia.connectors.fetch import eia_facets, eia_fetch, eia_fetch_series
|
|
9
|
+
from parsimony_eia.search import eia_search
|
|
10
|
+
|
|
11
|
+
CONNECTORS = Connectors([eia_fetch, eia_fetch_series, eia_facets, enumerate_eia, eia_search])
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
def load(*, api_key: str) -> Connectors:
|
|
15
|
+
"""Return :data:`CONNECTORS` with ``api_key`` bound on every keyed connector."""
|
|
16
|
+
return CONNECTORS.bind(api_key=api_key)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
__all__ = ["CONNECTORS", "load"]
|