sdmf 0.1.5__py3-none-any.whl → 0.1.6__py3-none-any.whl

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,475 @@
1
+ Metadata-Version: 2.4
2
+ Name: sdmf
3
+ Version: 0.1.6
4
+ Summary: SDMF - Standard Data Management Framework
5
+ Author: Harsh Hando
6
+ Author-email: Harsh Handoo <handoo.harsh@gmail.com>
7
+ License: Apache License
8
+ Version 2.0, January 2004
9
+ http://www.apache.org/licenses/
10
+
11
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
12
+
13
+ 1. Definitions.
14
+
15
+ "License" shall mean the terms and conditions for use, reproduction,
16
+ and distribution as defined by Sections 1 through 9 of this document.
17
+
18
+ "Licensor" shall mean the copyright owner or entity authorized by
19
+ the copyright owner that is granting the License.
20
+
21
+ "Legal Entity" shall mean the union of the acting entity and all
22
+ other entities that control, are controlled by, or are under common
23
+ control with that entity. For the purposes of this definition,
24
+ "control" means (i) the power, direct or indirect, to cause the
25
+ direction or management of such entity, whether by contract or
26
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
27
+ outstanding shares, or (iii) beneficial ownership of such entity.
28
+
29
+ "You" (or "Your") shall mean an individual or Legal Entity
30
+ exercising permissions granted by this License.
31
+
32
+ "Source" form shall mean the preferred form for making modifications,
33
+ including but not limited to software source code, documentation
34
+ source, and configuration files.
35
+
36
+ "Object" form shall mean any form resulting from mechanical
37
+ transformation or translation of a Source form, including but
38
+ not limited to compiled object code, generated documentation,
39
+ and conversions to other media types.
40
+
41
+ "Work" shall mean the work of authorship, whether in Source or
42
+ Object form, made available under the License, as indicated by a
43
+ copyright notice that is included in or attached to the work
44
+ (an example is provided in the Appendix below).
45
+
46
+ "Derivative Works" shall mean any work, whether in Source or Object
47
+ form, that is based on (or derived from) the Work and for which the
48
+ editorial revisions, annotations, elaborations, or other modifications
49
+ represent, as a whole, an original work of authorship. For the purposes
50
+ of this License, Derivative Works shall not include works that remain
51
+ separable from, or merely link (or bind by name) to the interfaces of,
52
+ the Work and Derivative Works thereof.
53
+
54
+ "Contribution" shall mean any work of authorship, including
55
+ the original version of the Work and any modifications or additions
56
+ to that Work or Derivative Works thereof, that is intentionally
57
+ submitted to Licensor for inclusion in the Work by the copyright owner
58
+ or by an individual or Legal Entity authorized to submit on behalf of
59
+ the copyright owner. For the purposes of this definition, "submitted"
60
+ means any form of electronic, verbal, or written communication sent
61
+ to the Licensor or its representatives, including but not limited to
62
+ communication on electronic mailing lists, source code control systems,
63
+ and issue tracking systems that are managed by, or on behalf of, the
64
+ Licensor for the purpose of discussing and improving the Work, but
65
+ excluding communication that is conspicuously marked or otherwise
66
+ designated in writing by the copyright owner as "Not a Contribution."
67
+
68
+ "Contributor" shall mean Licensor and any individual or Legal Entity
69
+ on behalf of whom a Contribution has been received by Licensor and
70
+ subsequently incorporated within the Work.
71
+
72
+ 2. Grant of Copyright License. Subject to the terms and conditions of
73
+ this License, each Contributor hereby grants to You a perpetual,
74
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75
+ copyright license to reproduce, prepare Derivative Works of,
76
+ publicly display, publicly perform, sublicense, and distribute the
77
+ Work and such Derivative Works in Source or Object form.
78
+
79
+ 3. Grant of Patent License. Subject to the terms and conditions of
80
+ this License, each Contributor hereby grants to You a perpetual,
81
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82
+ (except as stated in this section) patent license to make, have made,
83
+ use, offer to sell, sell, import, and otherwise transfer the Work,
84
+ where such license applies only to those patent claims licensable
85
+ by such Contributor that are necessarily infringed by their
86
+ Contribution(s) alone or by combination of their Contribution(s)
87
+ with the Work to which such Contribution(s) was submitted. If You
88
+ institute patent litigation against any entity (including a
89
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
90
+ or a Contribution incorporated within the Work constitutes direct
91
+ or contributory patent infringement, then any patent licenses
92
+ granted to You under this License for that Work shall terminate
93
+ as of the date such litigation is filed.
94
+
95
+ 4. Redistribution. You may reproduce and distribute copies of the
96
+ Work or Derivative Works thereof in any medium, with or without
97
+ modifications, and in Source or Object form, provided that You
98
+ meet the following conditions:
99
+
100
+ (a) You must give any other recipients of the Work or
101
+ Derivative Works a copy of this License; and
102
+
103
+ (b) You must cause any modified files to carry prominent notices
104
+ stating that You changed the files; and
105
+
106
+ (c) You must retain, in the Source form of any Derivative Works
107
+ that You distribute, all copyright, patent, trademark, and
108
+ attribution notices from the Source form of the Work,
109
+ excluding those notices that do not pertain to any part of
110
+ the Derivative Works; and
111
+
112
+ (d) If the Work includes a "NOTICE" text file as part of its
113
+ distribution, then any Derivative Works that You distribute must
114
+ include a readable copy of the attribution notices contained
115
+ within such NOTICE file, excluding those notices that do not
116
+ pertain to any part of the Derivative Works, in at least one
117
+ of the following places: within a NOTICE text file distributed
118
+ as part of the Derivative Works; within the Source form or
119
+ documentation, if provided along with the Derivative Works; or,
120
+ within a display generated by the Derivative Works, if and
121
+ wherever such third-party notices normally appear. The contents
122
+ of the NOTICE file are for informational purposes only and
123
+ do not modify the License. You may add Your own attribution
124
+ notices within Derivative Works that You distribute, alongside
125
+ or as an addendum to the NOTICE text from the Work, provided
126
+ that such additional attribution notices cannot be construed
127
+ as modifying the License.
128
+
129
+ You may add Your own copyright statement to Your modifications and
130
+ may provide additional or different license terms and conditions
131
+ for use, reproduction, or distribution of Your modifications, or
132
+ for any such Derivative Works as a whole, provided Your use,
133
+ reproduction, and distribution of the Work otherwise complies with
134
+ the conditions stated in this License.
135
+
136
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
137
+ any Contribution intentionally submitted for inclusion in the Work
138
+ by You to the Licensor shall be under the terms and conditions of
139
+ this License, without any additional terms or conditions.
140
+ Notwithstanding the above, nothing herein shall supersede or modify
141
+ the terms of any separate license agreement you may have executed
142
+ with Licensor regarding such Contributions.
143
+
144
+ 6. Trademarks. This License does not grant permission to use the trade
145
+ names, trademarks, service marks, or product names of the Licensor,
146
+ except as required for reasonable and customary use in describing the
147
+ origin of the Work and reproducing the content of the NOTICE file.
148
+
149
+ 7. Disclaimer of Warranty. Unless required by applicable law or
150
+ agreed to in writing, Licensor provides the Work (and each
151
+ Contributor provides its Contributions) on an "AS IS" BASIS,
152
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
153
+ implied, including, without limitation, any warranties or conditions
154
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
155
+ PARTICULAR PURPOSE. You are solely responsible for determining the
156
+ appropriateness of using or redistributing the Work and assume any
157
+ risks associated with Your exercise of permissions under this License.
158
+
159
+ 8. Limitation of Liability. In no event and under no legal theory,
160
+ whether in tort (including negligence), contract, or otherwise,
161
+ unless required by applicable law (such as deliberate and grossly
162
+ negligent acts) or agreed to in writing, shall any Contributor be
163
+ liable to You for damages, including any direct, indirect, special,
164
+ incidental, or consequential damages of any character arising as a
165
+ result of this License or out of the use or inability to use the
166
+ Work (including but not limited to damages for loss of goodwill,
167
+ work stoppage, computer failure or malfunction, or any and all
168
+ other commercial damages or losses), even if such Contributor
169
+ has been advised of the possibility of such damages.
170
+
171
+ 9. Accepting Warranty or Additional Liability. While redistributing
172
+ the Work or Derivative Works thereof, You may choose to offer,
173
+ and charge a fee for, acceptance of support, warranty, indemnity,
174
+ or other liability obligations and/or rights consistent with this
175
+ License. However, in accepting such obligations, You may act only
176
+ on Your own behalf and on Your sole responsibility, not on behalf
177
+ of any other Contributor, and only if You agree to indemnify,
178
+ defend, and hold each Contributor harmless for any liability
179
+ incurred by, or claims asserted against, such Contributor by reason
180
+ of your accepting any such warranty or additional liability.
181
+
182
+ END OF TERMS AND CONDITIONS
183
+
184
+ APPENDIX: How to apply the Apache License to your work.
185
+
186
+ To apply the Apache License to your work, attach the following
187
+ boilerplate notice, with the fields enclosed by brackets "[]"
188
+ replaced with your own identifying information. (Don't include
189
+ the brackets!) The text should be enclosed in the appropriate
190
+ comment syntax for the file format. We also recommend that a
191
+ file or class name and description of purpose be included on the
192
+ same "printed page" as the copyright notice for easier
193
+ identification within third-party archives.
194
+
195
+ Copyright [2026] [Harsh Handoo]
196
+
197
+ Licensed under the Apache License, Version 2.0 (the "License");
198
+ you may not use this file except in compliance with the License.
199
+ You may obtain a copy of the License at
200
+
201
+ http://www.apache.org/licenses/LICENSE-2.0
202
+
203
+ Unless required by applicable law or agreed to in writing, software
204
+ distributed under the License is distributed on an "AS IS" BASIS,
205
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
206
+ See the License for the specific language governing permissions and
207
+ limitations under the License.
208
+
209
+ Project-URL: License, https://github.com/yalsworldofficial/standard-data-management-framework/blob/main/LICENSE
210
+ Classifier: License :: OSI Approved :: Apache Software License
211
+ Classifier: Programming Language :: Python :: 3
212
+ Classifier: Programming Language :: Python :: 3.9
213
+ Classifier: Programming Language :: Python :: 3.10
214
+ Classifier: Programming Language :: Python :: 3.11
215
+ Classifier: Programming Language :: Python :: 3.12
216
+ Classifier: Operating System :: OS Independent
217
+ Classifier: Development Status :: 3 - Alpha
218
+ Requires-Python: >=3.9
219
+ Description-Content-Type: text/markdown
220
+ Requires-Dist: pandas
221
+ Requires-Dist: openpyxl
222
+ Requires-Dist: matplotlib
223
+
224
+ # Standard Data Management Framework (SDMF)
225
+
226
+ A **modular, scalable, and Python-based Data Management Framework** designed to standardize **data ingestion, validation, transformation, metadata handling, and storage** across enterprise workflows.
227
+
228
+ This framework eliminates repetitive boilerplate and provides a consistent structure for building reliable, maintainable data pipelines.
229
+
230
+ ## About
231
+
232
+ Created and maintained by **Harsh Handoo**, Data Engineer, SDMF is designed to standardize common data movement patterns and reduce boilerplate in real-world Spark workloads.
233
+
234
+ SDMF (Standard Data Management Framework) is an open-source Spark-based data engineering framework built for reliable, production-grade data pipelines. It focuses on schema enforcement, incremental processing, and SCD Type-2 handling using Delta Lake.
235
+
236
+ ## Features
237
+
238
+ - **Modular Design** – Plug-and-play components for ingestion, validation, transformation, and storage.
239
+ - **Schema Alignment & Partitioning** – Built-in support for CDC (Change Data Capture) and MERGE operations.
240
+ - **Metadata Management** – Centralized handling of feed specifications and lineage.
241
+ - **Scalable** – Works seamlessly with **Spark**, **Delta Lake**, and distributed environments like **Databricks**.
242
+ - **Logging & Monitoring** – Custom logging with retention and rotation policies.
243
+
244
+ ## Installation
245
+
246
+ ```bash
247
+ pip install sdmf
248
+ ```
249
+
250
+ ## Requirements
251
+
252
+ ### Cluster Resources (Typical)
253
+
254
+ | Workload | Minimum | Recommended |
255
+ | ------------------------------ | -------------------- | ----------------------- |
256
+ | Local development | 4 vCPU, 8 GB RAM | 8 vCPU, 16 GB RAM |
257
+ | Small datasets (<10M rows) | 2 executors × 4 GB | 4 executors × 8 GB |
258
+ | Medium datasets (10–100M rows) | 4 executors × 8 GB | 8 executors × 16 GB |
259
+ | Large datasets (>100M rows) | 8+ executors × 16 GB | Cluster-specific tuning |
260
+
261
+ ### Recommended Production Setup
262
+
263
+ - Linux-based Spark cluster
264
+ - Spark FAIR scheduler enabled
265
+ - Delta Lake tables stored on cloud object storage
266
+ - Versioned releases via PyPI + GitHub Releases
267
+
268
+ ### Storage
269
+
270
+ - Local filesystem (dev only)
271
+ - HDFS / ADLS / S3 / GCS (recommended)
272
+ - DBFS (Databricks)
273
+
274
+ ### Operating System
275
+
276
+ - Linux (recommended)
277
+ - macOS
278
+ - Windows (WSL recommended for local development)
279
+
280
+ ⚠️ Production deployments are strongly recommended on Linux-based systems.
281
+
282
+ Note: **This library is tested on databricks.**
283
+
284
+ ## Usage
285
+
286
+ ## Prerequisites
287
+
288
+ - Dedicate a directory to SDMF. Example: /sdmf_dir/
289
+ - Setup `config.ini` file.
290
+
291
+ ```ini
292
+ [DEFAULT]
293
+ outbound_directory_name=sdmf_outbound
294
+ log_directory_name=sdmf_logs
295
+ temp_log_location=/sdmf_dir/temp
296
+ file_hunt_path=/sdmf_dir/
297
+ log_retention_policy_in_days=7
298
+ max_concurrent_batches=4
299
+
300
+ [FILES]
301
+ master_spec_name = master_specs.xlsx
302
+
303
+ [LINEAGE_DIAGRAM]
304
+ BOX_WIDTH=4.4
305
+ BOX_HEIGHT=2.2
306
+ X_GAP=2.0
307
+ Y_GAP=2.5
308
+ ROOT_GAP=2.0
309
+ ```
310
+
311
+ - Setup Master Spec `master_spec.xlsx` (can be renamed in config) file.
312
+
313
+ - feed_id
314
+ - system_name
315
+ - subsystem_name
316
+ - category
317
+ - sub_category
318
+ - data_flow_direction
319
+ - residing_layer
320
+ - feed_name
321
+ - feed_type
322
+ - feed_specs
323
+ - load_type
324
+ - target_unity_catalog
325
+ - target_schema_name
326
+ - target_table_name
327
+ - suggested_feed_name
328
+ - parallelism_group_number
329
+ - parent_feed_id
330
+ - is_active
331
+
332
+ - Feed Spec JSON
333
+
334
+ ```json
335
+ {
336
+ "primary_key": "col1",
337
+ "composite_key": [],
338
+ "partition_keys": [],
339
+ "vacuum_hours": 168,
340
+ "source_table_name": "test.test",
341
+ "selection_query":null,
342
+ "selection_schema": {
343
+ "type": "struct",
344
+ "fields": [
345
+ {
346
+ "name": "col1",
347
+ "type": "string",
348
+ "nullable": true,
349
+ "metadata": {
350
+ "comment": "test"
351
+ }
352
+ },
353
+ {
354
+ "name": "col2",
355
+ "type": "string",
356
+ "nullable": true,
357
+ "metadata": {
358
+ "comment": "test"
359
+ }
360
+ },
361
+ {
362
+ "name": "col3",
363
+ "type": "string",
364
+ "nullable": true,
365
+ "metadata": {
366
+ "comment": "test"
367
+ }
368
+ },
369
+ {
370
+ "name": "col4",
371
+ "type": "string",
372
+ "nullable": true,
373
+ "metadata": {
374
+ "comment": "test"
375
+ }
376
+ }
377
+ ]
378
+ },
379
+ "standard_checks": [
380
+ {
381
+ "check_sequence": [
382
+ "_check_primary_key"
383
+ ],
384
+ "column_name": "col1",
385
+ "threshold": 0
386
+ },
387
+ {
388
+ "check_sequence": [
389
+ "_check_nulls"
390
+ ],
391
+ "column_name": "col2",
392
+ "threshold": 0
393
+ }
394
+ ],
395
+ "comprehensive_checks": [
396
+ {
397
+ "check_name": "Some unique check name",
398
+ "query": "Select 1;",
399
+ "severity": "WARNING",
400
+ "threshold": 0,
401
+ "load_stage": "PRE_LOAD",
402
+ "dependency_dataset": []
403
+ },
404
+ {
405
+ "check_name": "Some unique check name 1",
406
+ "query": "Select 1;",
407
+ "severity": "WARNING",
408
+ "threshold": 0,
409
+ "load_stage": "PRE_LOAD",
410
+ "dependency_dataset": []
411
+ },
412
+ {
413
+ "check_name": "Some unique check name 2",
414
+ "query": "Select 1;",
415
+ "severity": "WARNING",
416
+ "threshold": 0,
417
+ "load_stage": "PRE_LOAD",
418
+ "dependency_dataset": []
419
+ },
420
+ {
421
+ "check_name": "Some unique check name 3",
422
+ "query": "Select 1;",
423
+ "severity": "WARNING",
424
+ "threshold": 0,
425
+ "load_stage": "POST_LOAD",
426
+ "dependency_dataset": [
427
+ "demo.customers"
428
+ ]
429
+ }
430
+ ]
431
+ }
432
+ ```
433
+
434
+ - Ensure Spark FAIR scheduler is enabled.
435
+
436
+ ```bash
437
+ #!/bin/bash
438
+
439
+ echo "Configuring Spark FAIR scheduler..."
440
+
441
+ cat <<EOF >> /databricks/spark/conf/spark-defaults.conf
442
+ spark.scheduler.mode FAIR
443
+ EOF
444
+
445
+ echo "Spark FAIR scheduler enabled."
446
+ ```
447
+
448
+ ```python
449
+ from pyspark.sql import SparkSession
450
+
451
+ spark = (
452
+ SparkSession.builder
453
+ .appName("SDMF")
454
+ .config("spark.scheduler.mode", "FAIR")
455
+ .getOrCreate()
456
+ )
457
+ ```
458
+
459
+ ## Execution
460
+
461
+ ```python
462
+ import configparser
463
+ from sdmf import Orchestrator
464
+
465
+ spark # available spark session
466
+
467
+ cfg = configparser.ConfigParser()
468
+ cfg.read("/sdmf_dir/config.ini")
469
+ myOrchestrator = Orchestrator(spark, config=cfg)
470
+ myOrchestrator.run()
471
+ ```
472
+
473
+ ## Logging
474
+
475
+ - Logs are first written to specified log directory in `config.ini`.
@@ -71,8 +71,7 @@ sdmf/validation/validation_rules/StandardCheckStructureCheck.py,sha256=_5CrGlLsQ
71
71
  sdmf/validation/validation_rules/VacuumHoursCheck.py,sha256=FQI3RRpso2eQc_m6tX41KkOCAViNaKRTS42t8X4cfbQ,982
72
72
  sdmf/validation/validation_rules/ValidateFeedSpecsJSON.py,sha256=JRyYA1DaXHZT94oDWt1wm7Q5sghKe6OrjJydVII2ico,1046
73
73
  sdmf/validation/validation_rules/ValidateMasterSpecs.py,sha256=PJjL_goDrotit3D0bUWkcDqOgoNxPnFvUeGXfjluH54,666
74
- sdmf-0.1.5.dist-info/licenses/LICENSE.txt,sha256=ow1KLDiojXFN71FLZSb_Ek5j7rvhAG11Xs8SSXmq81c,11346
75
- sdmf-0.1.5.dist-info/METADATA,sha256=hZAuuzyIj1skSDM_T0AHpwwtWi3F9pn_M2J9OTks5jg,7559
76
- sdmf-0.1.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
77
- sdmf-0.1.5.dist-info/top_level.txt,sha256=a67a3_q-4a9HG0C80uz5kmOlzfO4AFoqiNag1KhTpUs,5
78
- sdmf-0.1.5.dist-info/RECORD,,
74
+ sdmf-0.1.6.dist-info/METADATA,sha256=2WpCdd6_zPHtTDg7pp2tF-nM7a2U76ZewscS1lx4ivs,20979
75
+ sdmf-0.1.6.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
76
+ sdmf-0.1.6.dist-info/top_level.txt,sha256=a67a3_q-4a9HG0C80uz5kmOlzfO4AFoqiNag1KhTpUs,5
77
+ sdmf-0.1.6.dist-info/RECORD,,
@@ -1,267 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: sdmf
3
- Version: 0.1.5
4
- Summary: SDMF - Standard Data Management Framework
5
- Author: Harsh Hando
6
- Author-email: Harsh Handoo <handoo.harsh@gmail.com>
7
- License: MIT
8
- Requires-Python: >=3.9
9
- Description-Content-Type: text/markdown
10
- License-File: LICENSE.txt
11
- Requires-Dist: pandas
12
- Requires-Dist: openpyxl
13
- Requires-Dist: matplotlib
14
- Dynamic: license-file
15
-
16
- # Standard Data Management Framework (SDMF)
17
-
18
- A **modular, scalable, and Python-based Data Management Framework** designed to standardize **data ingestion, validation, transformation, metadata handling, and storage** across enterprise workflows.
19
-
20
- This framework eliminates repetitive boilerplate and provides a consistent structure for building reliable, maintainable data pipelines.
21
-
22
- ## About
23
-
24
- Created and maintained by **Harsh Handoo**, Data Engineer, SDMF is designed to standardize common data movement patterns and reduce boilerplate in real-world Spark workloads.
25
-
26
- SDMF (Standard Data Management Framework) is an open-source Spark-based data engineering framework built for reliable, production-grade data pipelines. It focuses on schema enforcement, incremental processing, and SCD Type-2 handling using Delta Lake.
27
-
28
- ## Features
29
-
30
- - **Modular Design** – Plug-and-play components for ingestion, validation, transformation, and storage.
31
- - **Schema Alignment & Partitioning** – Built-in support for CDC (Change Data Capture) and MERGE operations.
32
- - **Metadata Management** – Centralized handling of feed specifications and lineage.
33
- - **Scalable** – Works seamlessly with **Spark**, **Delta Lake**, and distributed environments like **Databricks**.
34
- - **Logging & Monitoring** – Custom logging with retention and rotation policies.
35
-
36
- ## Installation
37
-
38
- ```bash
39
- pip install sdmf
40
- ```
41
-
42
- ## Requirements
43
-
44
- ### Cluster Resources (Typical)
45
-
46
- | Workload | Minimum | Recommended |
47
- | ------------------------------ | -------------------- | ----------------------- |
48
- | Local development | 4 vCPU, 8 GB RAM | 8 vCPU, 16 GB RAM |
49
- | Small datasets (<10M rows) | 2 executors × 4 GB | 4 executors × 8 GB |
50
- | Medium datasets (10–100M rows) | 4 executors × 8 GB | 8 executors × 16 GB |
51
- | Large datasets (>100M rows) | 8+ executors × 16 GB | Cluster-specific tuning |
52
-
53
- ### Recommended Production Setup
54
-
55
- - Linux-based Spark cluster
56
- - Spark FAIR scheduler enabled
57
- - Delta Lake tables stored on cloud object storage
58
- - Versioned releases via PyPI + GitHub Releases
59
-
60
- ### Storage
61
-
62
- - Local filesystem (dev only)
63
- - HDFS / ADLS / S3 / GCS (recommended)
64
- - DBFS (Databricks)
65
-
66
- ### Operating System
67
-
68
- - Linux (recommended)
69
- - macOS
70
- - Windows (WSL recommended for local development)
71
-
72
- ⚠️ Production deployments are strongly recommended on Linux-based systems.
73
-
74
- Note: **This library is tested on databricks.**
75
-
76
- ## Usage
77
-
78
- ## Prerequisites
79
-
80
- - Dedicate a directory to SDMF. Example: /sdmf_dir/
81
- - Setup `config.ini` file.
82
-
83
- ```ini
84
- [DEFAULT]
85
- outbound_directory_name=sdmf_outbound
86
- log_directory_name=sdmf_logs
87
- temp_log_location=/sdmf_dir/temp
88
- file_hunt_path=/sdmf_dir/
89
- log_retention_policy_in_days=7
90
- max_concurrent_batches=4
91
-
92
- [FILES]
93
- master_spec_name = master_specs.xlsx
94
-
95
- [LINEAGE_DIAGRAM]
96
- BOX_WIDTH=4.4
97
- BOX_HEIGHT=2.2
98
- X_GAP=2.0
99
- Y_GAP=2.5
100
- ROOT_GAP=2.0
101
- ```
102
-
103
- - Setup Master Spec `master_spec.xlsx` (can be renamed in config) file.
104
-
105
- - feed_id
106
- - system_name
107
- - subsystem_name
108
- - category
109
- - sub_category
110
- - data_flow_direction
111
- - residing_layer
112
- - feed_name
113
- - feed_type
114
- - feed_specs
115
- - load_type
116
- - target_unity_catalog
117
- - target_schema_name
118
- - target_table_name
119
- - suggested_feed_name
120
- - parallelism_group_number
121
- - parent_feed_id
122
- - is_active
123
-
124
- - Feed Spec JSON
125
-
126
- ```json
127
- {
128
- "primary_key": "col1",
129
- "composite_key": [],
130
- "partition_keys": [],
131
- "vacuum_hours": 168,
132
- "source_table_name": "test.test",
133
- "selection_query":null,
134
- "selection_schema": {
135
- "type": "struct",
136
- "fields": [
137
- {
138
- "name": "col1",
139
- "type": "string",
140
- "nullable": true,
141
- "metadata": {
142
- "comment": "test"
143
- }
144
- },
145
- {
146
- "name": "col2",
147
- "type": "string",
148
- "nullable": true,
149
- "metadata": {
150
- "comment": "test"
151
- }
152
- },
153
- {
154
- "name": "col3",
155
- "type": "string",
156
- "nullable": true,
157
- "metadata": {
158
- "comment": "test"
159
- }
160
- },
161
- {
162
- "name": "col4",
163
- "type": "string",
164
- "nullable": true,
165
- "metadata": {
166
- "comment": "test"
167
- }
168
- }
169
- ]
170
- },
171
- "standard_checks": [
172
- {
173
- "check_sequence": [
174
- "_check_primary_key"
175
- ],
176
- "column_name": "col1",
177
- "threshold": 0
178
- },
179
- {
180
- "check_sequence": [
181
- "_check_nulls"
182
- ],
183
- "column_name": "col2",
184
- "threshold": 0
185
- }
186
- ],
187
- "comprehensive_checks": [
188
- {
189
- "check_name": "Some unique check name",
190
- "query": "Select 1;",
191
- "severity": "WARNING",
192
- "threshold": 0,
193
- "load_stage": "PRE_LOAD",
194
- "dependency_dataset": []
195
- },
196
- {
197
- "check_name": "Some unique check name 1",
198
- "query": "Select 1;",
199
- "severity": "WARNING",
200
- "threshold": 0,
201
- "load_stage": "PRE_LOAD",
202
- "dependency_dataset": []
203
- },
204
- {
205
- "check_name": "Some unique check name 2",
206
- "query": "Select 1;",
207
- "severity": "WARNING",
208
- "threshold": 0,
209
- "load_stage": "PRE_LOAD",
210
- "dependency_dataset": []
211
- },
212
- {
213
- "check_name": "Some unique check name 3",
214
- "query": "Select 1;",
215
- "severity": "WARNING",
216
- "threshold": 0,
217
- "load_stage": "POST_LOAD",
218
- "dependency_dataset": [
219
- "demo.customers"
220
- ]
221
- }
222
- ]
223
- }
224
- ```
225
-
226
- - Ensure Spark FAIR scheduler is enabled.
227
-
228
- ```bash
229
- #!/bin/bash
230
-
231
- echo "Configuring Spark FAIR scheduler..."
232
-
233
- cat <<EOF >> /databricks/spark/conf/spark-defaults.conf
234
- spark.scheduler.mode FAIR
235
- EOF
236
-
237
- echo "Spark FAIR scheduler enabled."
238
- ```
239
-
240
- ```python
241
- from pyspark.sql import SparkSession
242
-
243
- spark = (
244
- SparkSession.builder
245
- .appName("SDMF")
246
- .config("spark.scheduler.mode", "FAIR")
247
- .getOrCreate()
248
- )
249
- ```
250
-
251
- ## Execution
252
-
253
- ```python
254
- import configparser
255
- from sdmf import Orchestrator
256
-
257
- spark # available spark session
258
-
259
- cfg = configparser.ConfigParser()
260
- cfg.read("/sdmf_dir/config.ini")
261
- myOrchestrator = Orchestrator(spark, config=cfg)
262
- myOrchestrator.run()
263
- ```
264
-
265
- ## Logging
266
-
267
- - Logs are first written to specified log directory in `config.ini`.
@@ -1,201 +0,0 @@
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 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 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 those 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
- APPENDIX: How to apply the Apache License to your work.
179
-
180
- To apply the Apache License to your work, attach the following
181
- boilerplate notice, with the fields enclosed by brackets "[]"
182
- replaced with your own identifying information. (Don't include
183
- the brackets!) The text should be enclosed in the appropriate
184
- comment syntax for the file format. We also recommend that a
185
- file or class name and description of purpose be included on the
186
- same "printed page" as the copyright notice for easier
187
- identification within third-party archives.
188
-
189
- Copyright [2026] [Harsh Handoo]
190
-
191
- Licensed under the Apache License, Version 2.0 (the "License");
192
- you may not use this file except in compliance with the License.
193
- You may obtain a copy of the License at
194
-
195
- http://www.apache.org/licenses/LICENSE-2.0
196
-
197
- Unless required by applicable law or agreed to in writing, software
198
- distributed under the License is distributed on an "AS IS" BASIS,
199
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
- See the License for the specific language governing permissions and
201
- limitations under the License.
File without changes