parsimony-bls 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.
@@ -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,66 @@
1
+ # Changelog — parsimony-bls
2
+
3
+ All notable changes to `parsimony-bls` 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
+ Ground-up refactor, run through the full connector guidebook process and
10
+ **live-verified** against the production BLS API and bulk flat-file site.
11
+
12
+ ### Added
13
+
14
+ - **`enumerate_bls_surveys`** (tier-1 feed) + **`bls_surveys_search`** — a complete
15
+ catalog of every BLS survey, each carrying a `dimensions` manifest (codes +
16
+ labels) for series-id construction.
17
+ - **`enumerate_bls_series`** (tier-2 feed) + **`bls_series_search`** — per-survey
18
+ series catalogs read from the authoritative `download.bls.gov/pub/time.series/
19
+ <survey>/<survey>.series` flat files, with lexical title and **structured
20
+ dimension** (`FIELD: value`) search. Built for the headline economic surveys and
21
+ lazy-buildable on demand; large catalogs are loaded from a published snapshot or
22
+ built and LRU-cached.
23
+ - `scripts/build_catalog.py` (two-tier publish), `catalog_tests/queries.yaml`
24
+ recall gate, and `tests/test_build_catalog.py` / `tests/test_flatfiles.py`.
25
+ - `curl_cffi` as a **hard dependency** — the flat-file host is Akamai bot-managed
26
+ and only a Chrome TLS handshake passes (the data API host stays plain httpx).
27
+
28
+ ### Changed
29
+
30
+ - **Discovery is now two-tier, mirroring `parsimony-sdmx`.** The old enumerator
31
+ crawled only `timeseries/popular` (~top series per survey) — a shallow, never-
32
+ complete catalog. The universe is ~tens of millions of series (15.6 GB of
33
+ `.series` metadata) and cannot be embedded whole; the new design catalogs
34
+ surveys + dimension vocabularies completely and per-survey series for the
35
+ headline surveys, while **every** series remains fetchable by id.
36
+ - Package restructured into `_http` / `surveys` / `flatfiles` / `_titles` /
37
+ `outputs` / `catalog_policy` / `catalog_build` / `connectors/{fetch,
38
+ enumerate_surveys,enumerate_series,search}`; the monolithic `__init__.py` is gone.
39
+ - `bls_fetch` tolerates suppressed (`-`) observation values and `S03` (semiannual
40
+ annual-average) periods; titles compose from dimension labels for the surveys
41
+ whose `.series` file lacks a `series_title` (SM/JT/PR).
42
+
43
+ ### Removed
44
+
45
+ - `enumerate_bls` (the shallow `timeseries/popular` crawl), superseded by the
46
+ flat-file-backed two-tier enumeration.
47
+
48
+ ## [0.5.0] — 2026-05-06
49
+
50
+ ### Changed
51
+
52
+ - 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.
53
+ - 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).
54
+ ## [0.4.0] — 2026-04-24
55
+
56
+ Part of the first coordinated release of the
57
+ [`parsimony-connectors`](https://github.com/ockham-sh/parsimony-connectors)
58
+ monorepo under `parsimony-core==0.4`.
59
+
60
+ ### Changed
61
+
62
+ - Connector rewritten against the kernel's `parsimony.discover` surface
63
+ (`iter_providers`, `load`, `load_all`) and the `@connector(env=...)`
64
+ decorator-level env-var declaration that replaced module-level
65
+ `ENV_VARS`.
66
+ - 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,149 @@
1
+ Metadata-Version: 2.4
2
+ Name: parsimony-bls
3
+ Version: 0.0.1
4
+ Summary: U.S. Bureau of Labor Statistics connector for the parsimony framework
5
+ Project-URL: Homepage, https://www.bls.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: bls,connectors,data,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: curl-cffi<1,>=0.7
25
+ Requires-Dist: pandas<3,>=2.3.0
26
+ Requires-Dist: parsimony-core>=0.0.1
27
+ Requires-Dist: pydantic<3,>=2.11.1
28
+ Provides-Extra: dev
29
+ Requires-Dist: mypy>=1.10; extra == 'dev'
30
+ Requires-Dist: pytest-cov>=5.0; extra == 'dev'
31
+ Requires-Dist: pytest>=9.0.3; extra == 'dev'
32
+ Requires-Dist: respx>=0.22.0; extra == 'dev'
33
+ Requires-Dist: ruff>=0.15.10; extra == 'dev'
34
+ Description-Content-Type: text/markdown
35
+
36
+ # parsimony-bls
37
+
38
+ US Bureau of Labor Statistics connector — CPI, PPI, employment (CES/CPS/QCEW),
39
+ unemployment (LAUS), JOLTS, ECI, productivity, import/export prices, and more, as
40
+ numeric time series.
41
+
42
+ Part of the [parsimony-connectors](https://github.com/ockham-sh/parsimony-connectors) monorepo. Distributed standalone on PyPI as `parsimony-bls`.
43
+
44
+ ## Connectors
45
+
46
+ | Name | Kind | Description |
47
+ |---|---|---|
48
+ | `bls_fetch` | connector | Fetch observations for any `series_id` via the BLS Public Data API. Reaches the **entire** universe by id. |
49
+ | `enumerate_bls_surveys` | enumerator | Tier-1 feed: one row per BLS survey (program). |
50
+ | `enumerate_bls_series` | connector | Tier-2 feed: one row per series in one survey, from its authoritative `.series` flat file. |
51
+ | `bls_surveys_search` | connector | Discover surveys and read their dimension manifests. |
52
+ | `bls_series_search` | connector | Search one survey's series (lexical title or structured dimension clauses). |
53
+
54
+ ## Why two tiers
55
+
56
+ BLS's full universe is **far too large to embed** — the per-survey `.series` flat
57
+ files total ~15.6 GB (tens of millions of series; the injury/illness demographic
58
+ microdata surveys alone are ~12 GB). So discovery is **two-tier, mirroring
59
+ `parsimony-sdmx`** (survey ≈ SDMX dataflow; a survey's dimension code tables ≈ a
60
+ DSD's codelists; a BLS `series_id` ≈ a composed series key):
61
+
62
+ - **Tier 1 — `bls_surveys`** (always built, complete): one entity per survey, with
63
+ a compact `dimensions` manifest (each dimension's codes + labels) for the
64
+ surveys that have a series catalog.
65
+ - **Tier 2 — `bls_series_<survey>`** (built for the headline surveys, lazy-buildable
66
+ for any indexable survey): one entity per series with a resolved title and
67
+ per-dimension metadata for structured search.
68
+
69
+ Every series stays **fetchable by id** via `bls_fetch` regardless of catalog
70
+ coverage — the boundary is discovery, not access. The GB-scale microdata tail is
71
+ reachable by constructing an id from the tier-1 manifest and fetching it.
72
+
73
+ > **Note on structured search.** Each series carries its dimension codes plus a
74
+ > resolved label. For most surveys every label resolves (CU/CE/JT/SM = 100%), but a
75
+ > few have irregular code-table naming where some codes fall back to the raw code
76
+ > (e.g. LA ≈ 60%, WP ≈ 70%). Lexical `series_title` search and `bls_fetch` are
77
+ > unaffected; only structured `FIELD: value` clauses on those specific dimensions
78
+ > degrade to code-equality.
79
+
80
+ ## Install
81
+
82
+ ```bash
83
+ pip install parsimony-bls
84
+ ```
85
+
86
+ Pulls in `parsimony-core>=0.7,<0.8` and `curl_cffi` automatically. `curl_cffi` is a
87
+ hard dependency: the bulk flat-file host (`download.bls.gov`) is Akamai
88
+ bot-managed and only a real Chrome TLS handshake passes — the data API host
89
+ (`api.bls.gov`) uses plain HTTPS.
90
+
91
+ ## Configuration
92
+
93
+ No key required. An optional `registrationkey` raises the daily quota (25 → 500
94
+ queries/day) and request size; set it via the `BLS_API_KEY` environment variable
95
+ or bind it: `load(api_key=...)`.
96
+
97
+ `bls_surveys_search` / `bls_series_search` read published catalog snapshots
98
+ (default root `hf://parsimony-dev/bls`). Override with `PARSIMONY_BLS_CATALOG_URL`
99
+ or `catalog_root=` at call time; missing snapshots are built on demand from the
100
+ live flat files and cached in an LRU.
101
+
102
+ ## Quick start
103
+
104
+ ```python
105
+ from parsimony_bls import CONNECTORS
106
+
107
+ # 1. find the survey + read its dimension manifest
108
+ surveys = CONNECTORS["bls_surveys_search"](query="consumer price index")
109
+ # 2. search that survey's series (lexical or structured FIELD: value)
110
+ hits = CONNECTORS["bls_series_search"](survey="CU", query="gasoline all types")
111
+ series_id = hits.data.iloc[0]["series_id"] # e.g. "CUUR0000SETB01"
112
+ # 3. fetch observations
113
+ result = CONNECTORS["bls_fetch"](
114
+ series_id=series_id, start_year="2020", end_year="2026"
115
+ )
116
+ print(result.data.head())
117
+ ```
118
+
119
+ For multi-plugin composition (autoloads everything installed):
120
+
121
+ ```python
122
+ from parsimony import discover
123
+ connectors = discover.load_all()
124
+ ```
125
+
126
+ ## Catalog building
127
+
128
+ `scripts/build_catalog.py` builds tier-2 series catalogs for the headline surveys,
129
+ collects their dimension manifests, then builds the tier-1 surveys catalog with
130
+ those manifests attached:
131
+
132
+ ```bash
133
+ # headline allowlist → local + remote, per-namespace subdirs
134
+ uv run python packages/bls/scripts/build_catalog.py \
135
+ --save-root /tmp/parsimony-catalogs/bls --push-root hf://parsimony-dev/bls
136
+
137
+ # one survey only
138
+ uv run python packages/bls/scripts/build_catalog.py --survey CU --save-root /tmp/bls
139
+ ```
140
+
141
+ ## Provider
142
+
143
+ - Homepage: https://www.bls.gov
144
+ - API docs: https://www.bls.gov/developers/
145
+ - Bulk flat files: https://download.bls.gov/pub/time.series/
146
+
147
+ ## License
148
+
149
+ See [LICENSE](./LICENSE).
@@ -0,0 +1,114 @@
1
+ # parsimony-bls
2
+
3
+ US Bureau of Labor Statistics connector — CPI, PPI, employment (CES/CPS/QCEW),
4
+ unemployment (LAUS), JOLTS, ECI, productivity, import/export prices, and more, as
5
+ numeric time series.
6
+
7
+ Part of the [parsimony-connectors](https://github.com/ockham-sh/parsimony-connectors) monorepo. Distributed standalone on PyPI as `parsimony-bls`.
8
+
9
+ ## Connectors
10
+
11
+ | Name | Kind | Description |
12
+ |---|---|---|
13
+ | `bls_fetch` | connector | Fetch observations for any `series_id` via the BLS Public Data API. Reaches the **entire** universe by id. |
14
+ | `enumerate_bls_surveys` | enumerator | Tier-1 feed: one row per BLS survey (program). |
15
+ | `enumerate_bls_series` | connector | Tier-2 feed: one row per series in one survey, from its authoritative `.series` flat file. |
16
+ | `bls_surveys_search` | connector | Discover surveys and read their dimension manifests. |
17
+ | `bls_series_search` | connector | Search one survey's series (lexical title or structured dimension clauses). |
18
+
19
+ ## Why two tiers
20
+
21
+ BLS's full universe is **far too large to embed** — the per-survey `.series` flat
22
+ files total ~15.6 GB (tens of millions of series; the injury/illness demographic
23
+ microdata surveys alone are ~12 GB). So discovery is **two-tier, mirroring
24
+ `parsimony-sdmx`** (survey ≈ SDMX dataflow; a survey's dimension code tables ≈ a
25
+ DSD's codelists; a BLS `series_id` ≈ a composed series key):
26
+
27
+ - **Tier 1 — `bls_surveys`** (always built, complete): one entity per survey, with
28
+ a compact `dimensions` manifest (each dimension's codes + labels) for the
29
+ surveys that have a series catalog.
30
+ - **Tier 2 — `bls_series_<survey>`** (built for the headline surveys, lazy-buildable
31
+ for any indexable survey): one entity per series with a resolved title and
32
+ per-dimension metadata for structured search.
33
+
34
+ Every series stays **fetchable by id** via `bls_fetch` regardless of catalog
35
+ coverage — the boundary is discovery, not access. The GB-scale microdata tail is
36
+ reachable by constructing an id from the tier-1 manifest and fetching it.
37
+
38
+ > **Note on structured search.** Each series carries its dimension codes plus a
39
+ > resolved label. For most surveys every label resolves (CU/CE/JT/SM = 100%), but a
40
+ > few have irregular code-table naming where some codes fall back to the raw code
41
+ > (e.g. LA ≈ 60%, WP ≈ 70%). Lexical `series_title` search and `bls_fetch` are
42
+ > unaffected; only structured `FIELD: value` clauses on those specific dimensions
43
+ > degrade to code-equality.
44
+
45
+ ## Install
46
+
47
+ ```bash
48
+ pip install parsimony-bls
49
+ ```
50
+
51
+ Pulls in `parsimony-core>=0.7,<0.8` and `curl_cffi` automatically. `curl_cffi` is a
52
+ hard dependency: the bulk flat-file host (`download.bls.gov`) is Akamai
53
+ bot-managed and only a real Chrome TLS handshake passes — the data API host
54
+ (`api.bls.gov`) uses plain HTTPS.
55
+
56
+ ## Configuration
57
+
58
+ No key required. An optional `registrationkey` raises the daily quota (25 → 500
59
+ queries/day) and request size; set it via the `BLS_API_KEY` environment variable
60
+ or bind it: `load(api_key=...)`.
61
+
62
+ `bls_surveys_search` / `bls_series_search` read published catalog snapshots
63
+ (default root `hf://parsimony-dev/bls`). Override with `PARSIMONY_BLS_CATALOG_URL`
64
+ or `catalog_root=` at call time; missing snapshots are built on demand from the
65
+ live flat files and cached in an LRU.
66
+
67
+ ## Quick start
68
+
69
+ ```python
70
+ from parsimony_bls import CONNECTORS
71
+
72
+ # 1. find the survey + read its dimension manifest
73
+ surveys = CONNECTORS["bls_surveys_search"](query="consumer price index")
74
+ # 2. search that survey's series (lexical or structured FIELD: value)
75
+ hits = CONNECTORS["bls_series_search"](survey="CU", query="gasoline all types")
76
+ series_id = hits.data.iloc[0]["series_id"] # e.g. "CUUR0000SETB01"
77
+ # 3. fetch observations
78
+ result = CONNECTORS["bls_fetch"](
79
+ series_id=series_id, start_year="2020", end_year="2026"
80
+ )
81
+ print(result.data.head())
82
+ ```
83
+
84
+ For multi-plugin composition (autoloads everything installed):
85
+
86
+ ```python
87
+ from parsimony import discover
88
+ connectors = discover.load_all()
89
+ ```
90
+
91
+ ## Catalog building
92
+
93
+ `scripts/build_catalog.py` builds tier-2 series catalogs for the headline surveys,
94
+ collects their dimension manifests, then builds the tier-1 surveys catalog with
95
+ those manifests attached:
96
+
97
+ ```bash
98
+ # headline allowlist → local + remote, per-namespace subdirs
99
+ uv run python packages/bls/scripts/build_catalog.py \
100
+ --save-root /tmp/parsimony-catalogs/bls --push-root hf://parsimony-dev/bls
101
+
102
+ # one survey only
103
+ uv run python packages/bls/scripts/build_catalog.py --survey CU --save-root /tmp/bls
104
+ ```
105
+
106
+ ## Provider
107
+
108
+ - Homepage: https://www.bls.gov
109
+ - API docs: https://www.bls.gov/developers/
110
+ - Bulk flat files: https://download.bls.gov/pub/time.series/
111
+
112
+ ## License
113
+
114
+ See [LICENSE](./LICENSE).
@@ -0,0 +1,26 @@
1
+ """US Bureau of Labor Statistics connector for parsimony.
2
+
3
+ BLS serves the entire US official labor-statistics universe — CPI, PPI,
4
+ employment (CES/CPS/SM/QCEW), unemployment (LAUS), JOLTS, ECI, productivity,
5
+ import/export prices, and more — as numeric time series. The universe is far too
6
+ large to embed whole (~tens of millions of series), so discovery is **two-tier**,
7
+ mirroring ``parsimony-sdmx``: a small always-built *surveys* catalog plus
8
+ per-survey *series* catalogs built for the headline surveys. Every series remains
9
+ fetchable by id via ``bls_fetch`` regardless of catalog coverage.
10
+
11
+ Auth: optional ``registrationkey`` (env ``BLS_API_KEY``) — raises quota only. The
12
+ bulk flat-file host is Akamai-walled and reached via curl_cffi impersonation.
13
+ """
14
+
15
+ from __future__ import annotations
16
+
17
+ from parsimony.connector import Connectors
18
+
19
+ from parsimony_bls.connectors import CONNECTORS
20
+
21
+ __all__ = ["CONNECTORS", "load"]
22
+
23
+
24
+ def load(*, api_key: str = "") -> Connectors:
25
+ """Return :data:`CONNECTORS` with ``api_key`` bound on connectors that accept it."""
26
+ return CONNECTORS.bind(api_key=api_key)