parsimony-sdmx 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.
Files changed (55) hide show
  1. parsimony_sdmx-0.0.1/.gitignore +40 -0
  2. parsimony_sdmx-0.0.1/CHANGELOG.md +58 -0
  3. parsimony_sdmx-0.0.1/LICENSE +190 -0
  4. parsimony_sdmx-0.0.1/PKG-INFO +289 -0
  5. parsimony_sdmx-0.0.1/README.md +248 -0
  6. parsimony_sdmx-0.0.1/parsimony_sdmx/__init__.py +25 -0
  7. parsimony_sdmx-0.0.1/parsimony_sdmx/_isolation/__init__.py +155 -0
  8. parsimony_sdmx-0.0.1/parsimony_sdmx/_isolation/layout.py +31 -0
  9. parsimony_sdmx-0.0.1/parsimony_sdmx/_isolation/listing.py +170 -0
  10. parsimony_sdmx-0.0.1/parsimony_sdmx/_isolation/structure_worker.py +58 -0
  11. parsimony_sdmx-0.0.1/parsimony_sdmx/catalog_build.py +244 -0
  12. parsimony_sdmx-0.0.1/parsimony_sdmx/catalog_manifest.py +298 -0
  13. parsimony_sdmx-0.0.1/parsimony_sdmx/catalog_policy.py +104 -0
  14. parsimony_sdmx-0.0.1/parsimony_sdmx/catalog_series.py +504 -0
  15. parsimony_sdmx-0.0.1/parsimony_sdmx/connectors/__init__.py +66 -0
  16. parsimony_sdmx-0.0.1/parsimony_sdmx/connectors/_agencies.py +44 -0
  17. parsimony_sdmx-0.0.1/parsimony_sdmx/connectors/codelist_namespace.py +17 -0
  18. parsimony_sdmx-0.0.1/parsimony_sdmx/connectors/enumerate_datasets.py +174 -0
  19. parsimony_sdmx-0.0.1/parsimony_sdmx/connectors/enumerate_series.py +144 -0
  20. parsimony_sdmx-0.0.1/parsimony_sdmx/connectors/fetch.py +370 -0
  21. parsimony_sdmx-0.0.1/parsimony_sdmx/connectors/search.py +281 -0
  22. parsimony_sdmx-0.0.1/parsimony_sdmx/connectors/series_search.py +306 -0
  23. parsimony_sdmx-0.0.1/parsimony_sdmx/core/__init__.py +5 -0
  24. parsimony_sdmx-0.0.1/parsimony_sdmx/core/codelists.py +50 -0
  25. parsimony_sdmx-0.0.1/parsimony_sdmx/core/errors.py +27 -0
  26. parsimony_sdmx-0.0.1/parsimony_sdmx/core/models.py +68 -0
  27. parsimony_sdmx-0.0.1/parsimony_sdmx/core/outcomes.py +47 -0
  28. parsimony_sdmx-0.0.1/parsimony_sdmx/core/projection.py +107 -0
  29. parsimony_sdmx-0.0.1/parsimony_sdmx/core/titles.py +97 -0
  30. parsimony_sdmx-0.0.1/parsimony_sdmx/io/__init__.py +1 -0
  31. parsimony_sdmx-0.0.1/parsimony_sdmx/io/html.py +38 -0
  32. parsimony_sdmx-0.0.1/parsimony_sdmx/io/http.py +212 -0
  33. parsimony_sdmx-0.0.1/parsimony_sdmx/io/parquet.py +110 -0
  34. parsimony_sdmx-0.0.1/parsimony_sdmx/io/paths.py +45 -0
  35. parsimony_sdmx-0.0.1/parsimony_sdmx/io/structure_json.py +72 -0
  36. parsimony_sdmx-0.0.1/parsimony_sdmx/io/xml.py +116 -0
  37. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/__init__.py +1 -0
  38. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/agencies.py +15 -0
  39. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/dataset_urls.py +23 -0
  40. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/ecb.py +147 -0
  41. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/ecb_portal.py +220 -0
  42. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/ecb_series_attrs.py +79 -0
  43. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/estat.py +36 -0
  44. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/imf.py +36 -0
  45. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/protocol.py +30 -0
  46. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/registry.py +33 -0
  47. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/sdmx_client.py +74 -0
  48. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/sdmx_extract.py +190 -0
  49. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/sdmx_flow.py +301 -0
  50. parsimony_sdmx-0.0.1/parsimony_sdmx/providers/wb.py +372 -0
  51. parsimony_sdmx-0.0.1/parsimony_sdmx/release_validate.py +240 -0
  52. parsimony_sdmx-0.0.1/parsimony_sdmx/series_facets.py +65 -0
  53. parsimony_sdmx-0.0.1/parsimony_sdmx/series_fields.py +47 -0
  54. parsimony_sdmx-0.0.1/parsimony_sdmx/series_query.py +119 -0
  55. parsimony_sdmx-0.0.1/pyproject.toml +88 -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,58 @@
1
+ # Changelog — parsimony-sdmx
2
+
3
+ All notable changes to `parsimony-sdmx` 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.7.0]
8
+
9
+ ### Changed
10
+
11
+ - **Adapted to `parsimony-core==0.7`**: Bump `parsimony-core` pin from `>=0.6.0,<0.7` to `>=0.7.0,<0.8`.
12
+ - **Dynamic hybrid catalogs**: operator builds choose BM25+vector `HybridIndex` per field when unique field text count is below 1,000, otherwise BM25-only; title and each SDMX dimension field on series catalogs, title/description on `sdmx_datasets` with `code` kept as a BM25 lookup index.
13
+ - **Unified Catalog Loading**: Updated catalog search connectors to use `Catalog.load` instead of `Catalog.from_url` or custom caching.
14
+ - **Unified Catalog Saving**: Updated catalog build script to call `Catalog.save` instead of `Catalog.push`.
15
+ - **Local LRU**: `sdmx_series_search` / `sdmx_datasets_search` now own their per-namespace catalog LRU (previously delegated to the kernel). `PARSIMONY_SDMX_CATALOG_LRU_SIZE` env var still configures it.
16
+
17
+ ## [0.5.0] — 2026-05-06
18
+ ### Changed
19
+
20
+ - 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.
21
+ - 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).
22
+ - `sdmx_fetch` no longer delegates to a `_legacy_sdmx` shim; the body
23
+ is inlined in `connectors/fetch.py` and reuses the existing
24
+ `core/codelists`, `providers/sdmx_extract`, and `providers/sdmx_flow`
25
+ pipeline. Behaviour is identical for the live observation table.
26
+ - `providers/sdmx_client.sdmx_client()` accepts `wb_url_rewrite=False`
27
+ to install the `dataapi.worldbank.org` → `api.worldbank.org` host
28
+ rewrite when the live fetch path needs it. Default is unchanged for
29
+ every existing caller.
30
+
31
+ ### Added
32
+
33
+ - `core/titles.compose_observation_title` and
34
+ `core/titles.format_code_with_label`, sibling helpers to
35
+ `compose_series_title` for the per-observation result schema.
36
+ - `providers/dataset_urls.build_sdmx_dataset_url` for agency portal URLs.
37
+ - Test coverage for `sdmx_fetch`, `dataset_urls`, and the
38
+ `wb_url_rewrite` option.
39
+
40
+ ### Removed
41
+
42
+ - `parsimony_sdmx/_legacy_sdmx.py` and its five never-wired connectors
43
+ (`sdmx_list_datasets`, `sdmx_dsd`, `sdmx_codelist`, `sdmx_series_keys`,
44
+ `enumerate_sdmx_dataset_codelists`) plus their param classes.
45
+
46
+ ## [0.4.0] — 2026-04-24
47
+
48
+ Part of the first coordinated release of the
49
+ [`parsimony-connectors`](https://github.com/ockham-sh/parsimony-connectors)
50
+ monorepo under `parsimony-core==0.4`.
51
+
52
+ ### Changed
53
+
54
+ - Connector rewritten against the kernel's `parsimony.discover` surface
55
+ (`iter_providers`, `load`, `load_all`) and the `@connector(env=...)`
56
+ decorator-level env-var declaration that replaced module-level
57
+ `ENV_VARS`.
58
+ - 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,289 @@
1
+ Metadata-Version: 2.4
2
+ Name: parsimony-sdmx
3
+ Version: 0.0.1
4
+ Summary: SDMX protocol connector (ECB, Eurostat, IMF, World Bank) for the parsimony framework
5
+ Project-URL: Homepage, https://sdmx.org
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,finance,parsimony,sdmx
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: beautifulsoup4>=4.12
25
+ Requires-Dist: lxml>=5.0
26
+ Requires-Dist: pandas<3,>=2.3.0
27
+ Requires-Dist: parsimony-core[catalog]>=0.0.1
28
+ Requires-Dist: psutil>=5.9
29
+ Requires-Dist: pyarrow>=16.0
30
+ Requires-Dist: pydantic<3,>=2.11.1
31
+ Requires-Dist: requests>=2.32
32
+ Requires-Dist: sdmx1>=2.16
33
+ Provides-Extra: dev
34
+ Requires-Dist: mypy>=1.10; extra == 'dev'
35
+ Requires-Dist: pytest-cov>=5.0; extra == 'dev'
36
+ Requires-Dist: pytest>=9.0.3; extra == 'dev'
37
+ Requires-Dist: pyyaml>=6.0; extra == 'dev'
38
+ Requires-Dist: respx>=0.22.0; extra == 'dev'
39
+ Requires-Dist: ruff>=0.15.10; extra == 'dev'
40
+ Description-Content-Type: text/markdown
41
+
42
+ # parsimony-sdmx
43
+
44
+ SDMX connector plugin for parsimony. Harvests dataflow listings, DSD structure (dimensions + codelists), and populated series keys from statistical agencies (ECB, Eurostat, IMF, World Bank), composes human-readable titles from codelists, and exposes searchable local catalog bundles for agent workflows.
45
+
46
+ Part of the [parsimony-connectors](https://github.com/ockham-sh/parsimony-connectors) monorepo. Distributed standalone on PyPI as `parsimony-sdmx`.
47
+
48
+ Live observation fetches hit the agency endpoint inside a spawned subprocess. Maintainer catalog builds are explicit operator workflows under `scripts/`.
49
+
50
+ ## Supported agencies
51
+
52
+ | Agency ID | Source |
53
+ |------------|--------------------------------------------------|
54
+ | `ECB` | European Central Bank SDMX 2.1 |
55
+ | `ESTAT` | Eurostat SDMX 2.1 |
56
+ | `IMF_DATA` | IMF SDMX 3 (``sdmx.imf.org``) |
57
+ | `WB_WDI` | World Bank SDMX 2.1 (custom path × decade sweep) |
58
+
59
+ ## Connectors
60
+
61
+ | Name | Kind | Description |
62
+ |---|---|---|
63
+ | `enumerate_sdmx_datasets` | enumerator | One row per dataflow per agency (`sdmx_datasets_<agency>` namespaces). |
64
+ | `enumerate_sdmx_series` | connector (dynamic schema) | Scoped keys-only discovery for one `(agency, dataset_id, key_pattern)` — returns matching series with labeled dimensions, no observations. |
65
+ | `sdmx_fetch` | connector | Live observation fetch for a series key against the agency endpoint. |
66
+ | `sdmx_datasets_search` | connector | Structured search over per-agency dataset catalogs (agency optional — fans out across all agencies). |
67
+ | `sdmx_codelist_search` | connector | Semantic search over deduplicated per-agency codelist catalogs. |
68
+ | `sdmx_series_search` | connector | Search populated per-flow series catalogs with dimension filters, title search, and refine facets. |
69
+
70
+ Six registered connectors total (1 enumerator + 1 dynamic-schema connector + 1 fetch + 3 search).
71
+
72
+ ### Dynamic schema: `enumerate_sdmx_series`
73
+
74
+ Scoped discovery returns a wide DataFrame whose columns depend on the SDMX datastructure definition for that flow. The output schema is **dynamic per call** — it cannot be declared statically on ``@enumerator``. The connector stays a plain ``@connector`` that returns raw ``pd.DataFrame`` rows.
75
+
76
+ ## Install
77
+
78
+ ```bash
79
+ pip install parsimony-sdmx
80
+ ```
81
+
82
+ Pulls in `parsimony-core[catalog]>=0.7,<0.8` automatically (includes the hybrid BM25+vector catalog stack).
83
+
84
+ Verify discovery:
85
+
86
+ ```bash
87
+ python -c "from parsimony import discover; print([p.name for p in discover.iter_providers()])"
88
+ ```
89
+
90
+ ## Quick start
91
+
92
+ ```python
93
+ from parsimony_sdmx import CONNECTORS
94
+
95
+ result = CONNECTORS["sdmx_fetch"](
96
+ dataset_key="ECB-YC",
97
+ series_key="B.U2.EUR.4F.G_N_A.SV_C_YM.SR_10Y",
98
+ )
99
+ print(result.data.head())
100
+ ```
101
+
102
+ For multi-plugin composition:
103
+
104
+ ```python
105
+ from parsimony import discover
106
+ connectors = discover.load_all()
107
+ ```
108
+
109
+ ## Catalog building
110
+
111
+ Catalog building is an operator workflow. Use `scripts/build_catalog.py` for individual dataset/codelist snapshots and `scripts/build_all_catalogs.py` for full SDMX release roots. Indexing policy lives in `parsimony_sdmx/catalog_policy.py`:
112
+
113
+ - **Dataset catalogs** — hybrid BM25+vector on `title`/`description` when unique text count is below **1,000**, otherwise BM25-only.
114
+ - **Codelist catalogs** — BM25 on `code`, hybrid on `label` (always hybrid for semantic concept→code resolution).
115
+ - **Series catalogs** — per-flow parquet-backed catalogs with a title index plus code/label indexes for each DSD dimension.
116
+
117
+ Namespaces:
118
+
119
+ - ``sdmx_datasets_<agency>`` — one dataset catalog per agency (e.g. ``sdmx_datasets_ecb``). Each entity carries a summarized **DSD** in metadata (dimension order, codelist refs, sample codes).
120
+ - ``sdmx_codelist_<agency>_<codelist_id>`` — deduplicated codelist catalogs (e.g. ``sdmx_codelist_ecb_cl_freq``). Entities are `{code, label}` pairs.
121
+ - ``sdmx_series_<agency>_<flow>`` — one populated-series catalog per supported flow (e.g. ``sdmx_series_estat_prc_hicp_manr``). Rows are stored in `series.parquet`; indexes resolve titles and dimension labels/codes.
122
+
123
+ ### Build and push
124
+
125
+ ```bash
126
+ # One agency: dataset index + deduplicated codelist catalogs
127
+ uv run python scripts/build_catalog.py --catalog agency --agency ECB \
128
+ --save-root /tmp/parsimony-catalogs/sdmx --push-root hf://parsimony-dev/sdmx
129
+
130
+ # Full portfolio (all agencies)
131
+ uv run python scripts/build_catalog.py --catalog portfolio \
132
+ --save-root /tmp/parsimony-catalogs/sdmx --push-root hf://parsimony-dev/sdmx \
133
+ --parallel 2 --keep-going
134
+ ```
135
+
136
+ Use `--save-root /tmp/sdmx` to write local snapshots under namespace subdirectories. Use `--push <url>` for one explicit catalog URL or `--push-root <root>` for namespace subdirectories.
137
+
138
+ A local build produces:
139
+
140
+ ```
141
+ /tmp/parsimony-catalogs/sdmx/
142
+ ├── sdmx_datasets_ecb/
143
+ │ ├── entries.parquet
144
+ │ ├── indexes/
145
+ │ └── meta.json
146
+ ├── sdmx_codelist_ecb_cl_freq/
147
+ │ ├── entries.parquet
148
+ │ ├── indexes/
149
+ │ └── meta.json
150
+ ├── sdmx_series_ecb_yc/
151
+ │ ├── series.parquet
152
+ │ ├── indexes/
153
+ │ └── meta.json
154
+ └── ...
155
+ ```
156
+
157
+ ### Build an agency batch
158
+
159
+ ```bash
160
+ uv run python scripts/build_catalog.py --catalog agency --agency ECB --push-root hf://parsimony-dev/sdmx
161
+ uv run python scripts/build_catalog.py --catalog agency --agency ESTAT --save-root /tmp/sdmx
162
+ ```
163
+
164
+ Structure fetches are bounded (~2–15 s per flow) and fully parallelizable. Series catalog builds stream keys to parquet and then index distinct dimension values.
165
+
166
+ ## Expected agent workflow (dataset → series → fetch)
167
+
168
+ Agents usually navigate in three steps:
169
+
170
+ 1. **`sdmx_datasets_search(query=..., agency=...)`** — find the right dataflow. *Agency is optional*; omit it to search across all agency dataset catalogs. Read the returned **`dsd`** summary (dimension order + codelist refs).
171
+ 2. **`sdmx_series_search(agency=..., dataset_id=..., query=...)`** — search populated series keys. Use `{dimension}_label` for semantic resolution, `{dimension}_code` for exact filters, and `&&` to combine clauses. The `refine` column returns facet JSON for unpinned dimensions.
172
+ 3. **`sdmx_fetch(dataset_key=..., series_key=...)`** — live observation fetch. On empty/too-broad results, loop back to step 2 with more filters.
173
+
174
+ `sdmx_codelist_search` and `enumerate_sdmx_series` remain available for narrower workflows or live fallback, but `sdmx_series_search` is the preferred path when the release catalog is installed.
175
+
176
+ ### Cookbook: German monthly unemployment rate (Eurostat)
177
+
178
+ ```python
179
+ from parsimony_sdmx import load
180
+
181
+ c = load()
182
+
183
+ # 1. Find the dataset
184
+ ds = c["sdmx_datasets_search"](query="unemployment rate monthly", agency="ESTAT", limit=3)
185
+ row = ds.data.iloc[0]
186
+ print(row["code"], row["title"])
187
+ dsd = row["dsd"] # dimension order + codelist refs
188
+
189
+ # 2. Search populated combinations using DSD field names
190
+ series = c["sdmx_series_search"](
191
+ agency="ESTAT",
192
+ dataset_id="UNE_RT_M",
193
+ query="geo_label: Germany && freq_code:M",
194
+ limit=10,
195
+ )
196
+ print(series.data[["key", "title", "refine"]].head())
197
+
198
+ # 3. Fetch observations for the chosen series
199
+ obs = c["sdmx_fetch"](dataset_ref="ESTAT-UNE_RT_M", series_ref=series.data.iloc[0]["key"])
200
+ print(obs.data.head())
201
+ ```
202
+
203
+ Override the catalog root for local dev: `PARSIMONY_SDMX_CATALOG_URL=file:///tmp/parsimony-catalogs/sdmx` (default publish target: `hf://parsimony-dev/sdmx`).
204
+
205
+ ## Search a published bundle
206
+
207
+ ```python
208
+ from parsimony.catalog import Catalog
209
+
210
+ datasets = Catalog.load("hf://parsimony-dev/sdmx/sdmx_datasets_ecb")
211
+ flows = datasets.search("code: ECB|YC", limit=3)
212
+ print("datasets", flows[0].code, flows[0].title[:80])
213
+
214
+ codelists = Catalog.load("hf://parsimony-dev/sdmx/sdmx_codelist_ecb_cl_freq")
215
+ hits = codelists.search("monthly", limit=3)
216
+ for hit in hits:
217
+ print(f"{hit.score:.3f} {hit.code} {hit.title[:80]}")
218
+ ```
219
+
220
+ The same `Catalog.load(...)` works against `hf://` and `file://` URLs.
221
+
222
+ Validate a built or published snapshot:
223
+
224
+ ```bash
225
+ uv run python scripts/validate_catalog_build.py --root /tmp/parsimony-catalogs
226
+ ```
227
+
228
+ ## Plugin contract
229
+
230
+ The package implements the standard parsimony plugin contract, exported at the top level of ``parsimony_sdmx``:
231
+
232
+ | Export | Role |
233
+ |----------------------|-------------------------------------------------------------------------------|
234
+ | ``CONNECTORS`` | ``Connectors`` collection — one enumerator, one dynamic-schema connector, ``sdmx_fetch``, and three search connectors. |
235
+
236
+ SDMX endpoints are public; no environment variables are required.
237
+
238
+ ## Architecture
239
+
240
+ ```
241
+ parsimony_sdmx/
242
+ ├── core/ pure domain logic: record dataclasses, title composition,
243
+ │ codelist resolution, outcome types, domain exceptions
244
+ ├── io/ boundary effects: atomic parquet writers, hardened lxml
245
+ │ iterparse, HTTPS-only bounded session, path safety
246
+ ├── providers/ per-agency adapters behind a narrow `CatalogProvider`
247
+ │ protocol; ECB/ESTAT/IMF share a common sdmx1 flow helper,
248
+ │ WB diverges with a path × decade sweep
249
+ ├── connectors/ parsimony `@enumerator` surface + ``sdmx_fetch`` live
250
+ │ observation connector + dataset/codelist/series search connectors
251
+ └── _isolation/ subprocess-spawning boundary for every sdmx1 call
252
+ ```
253
+
254
+ ### Title composition
255
+
256
+ Each series row's `title` is built per DSD:
257
+
258
+ - **ECB** — uses the `TITLE` / `TITLE_COMPL` natural-language attributes fetched via the portal side-channel.
259
+ - **ESTAT / IMF_DATA / WB_WDI** — falls back to `compose_series_title()` which concatenates dimension labels in DSD order.
260
+
261
+ ### Why subprocess isolation
262
+
263
+ ``sdmx1`` caches parsed structure messages at module scope with no public invalidation hook. Every sdmx1-touching call runs inside a freshly spawned process that is discarded after the call.
264
+
265
+ Under load the parent process stays sdmx1-free — verified by ``test_listing.py::test_plugin_surface_import_does_not_pull_sdmx``.
266
+
267
+ ## Development
268
+
269
+ ```bash
270
+ # Fast tier — excludes slow + integration markers
271
+ make verify PKG=sdmx
272
+
273
+ # Integration (live agency endpoints)
274
+ uv run --package parsimony-sdmx pytest packages/sdmx/tests -m integration -v
275
+ ```
276
+
277
+ Hardening defaults: HTTPS-only bounded HTTP session, hardened `lxml.iterparse`, path traversal guards on every on-disk write.
278
+
279
+ ## Provider
280
+
281
+ - SDMX standard: <https://sdmx.org>
282
+ - ECB SDMX: <https://data.ecb.europa.eu/help/api/overview>
283
+ - Eurostat SDMX: <https://wikis.ec.europa.eu/display/EUROSTATHELP/API+SDMX+2.1>
284
+ - IMF SDMX: <https://datahelp.imf.org/knowledgebase/articles/667681-using-sdmx-to-query-imf-data>
285
+ - World Bank SDMX: <https://datahelpdesk.worldbank.org/knowledgebase/articles/889398-developer-information-overview>
286
+
287
+ ## License
288
+
289
+ See [LICENSE](./LICENSE).