dcf-core 0.1.1__tar.gz

dcf_core-0.1.1/LICENSE

@@ -0,0 +1,184 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submit" means any form of electronic, verbal, or
+      written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or/or a
+      Contribution incorporated within the Work constitutes direct or
+      contributory patent infringement, then any patent licenses granted to
+      You under this License for that Work shall terminate as of the date
+      such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative Works
+          a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text file
+          distributed as part of the Derivative Works; within the Source
+          form or documentation, if provided along with the Derivative Works;
+          or, within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, and to permit persons to whom the Derivative Works
+      is furnished to do so, subject to Your own terms and conditions.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a result
+      of this License or out of the use or inability to use the Work
+      (including but not limited to damages for loss of goodwill, work
+      stoppage, computer failure or malfunction, or all other commercial
+      damages or losses), even if such Contributor has been advised of the
+      possibility of such damages.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such conditions only on
+      Your own behalf and on a solely responsible basis, not on behalf of
+      any other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by, or
+      claims asserted against, such Contributor by reason of your accepting
+      any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Zeph Schafer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dcf_core-0.1.1/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: dcf-core
+Version: 0.1.1
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship made available under
+              the License, as indicated by a copyright notice that is included in
+              or attached to the work (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other transformations
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean, as submitted to the Licensor for inclusion
+              in the Work by the copyright owner or by an individual or Legal Entity
+              authorized to submit on behalf of the copyright owner. For the purposes
+              of this definition, "submit" means any form of electronic, verbal, or
+              written communication sent to the Licensor or its representatives,
+              including but not limited to communication on electronic mailing lists,
+              source code control systems, and issue tracking systems that are managed
+              by, or on behalf of, the Licensor for the purpose of discussing and
+              improving the Work, but excluding communication that is conspicuously
+              marked or designated in writing by the copyright owner as "Not a
+              Contribution."
+        
+              "Contributor" shall mean Licensor and any Legal Entity on behalf of
+              whom a Contribution has been received by the Licensor and included
+              within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by the combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a cross-claim
+              or counterclaim in a lawsuit) alleging that the Work or/or a
+              Contribution incorporated within the Work constitutes direct or
+              contributory patent infringement, then any patent licenses granted to
+              You under this License for that Work shall terminate as of the date
+              such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or Derivative Works
+                  a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, You must include a readable copy of the
+                  attribution notices contained within such NOTICE file, in
+                  at least one of the following places: within a NOTICE text file
+                  distributed as part of the Derivative Works; within the Source
+                  form or documentation, if provided along with the Derivative Works;
+                  or, within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own license statement for Your modifications and
+              may provide additional grant of rights to use, copy, modify, merge,
+              publish, distribute, sublicense, and/or sell copies of the
+              Derivative Works, and to permit persons to whom the Derivative Works
+              is furnished to do so, subject to Your own terms and conditions.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or reproducing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or exemplary damages of any character arising as a result
+              of this License or out of the use or inability to use the Work
+              (including but not limited to damages for loss of goodwill, work
+              stoppage, computer failure or malfunction, or all other commercial
+              damages or losses), even if such Contributor has been advised of the
+              possibility of such damages.
+        
+           9. Accepting Warranty or Liability. While redistributing the Work or
+              Derivative Works thereof, You may choose to offer, and charge a fee
+              for, acceptance of support, warranty, indemnity, or other liability
+              obligations and/or rights consistent with this License. However, in
+              accepting such obligations, You may offer such conditions only on
+              Your own behalf and on a solely responsible basis, not on behalf of
+              any other Contributor, and only if You agree to indemnify, defend,
+              and hold each Contributor harmless for any liability incurred by, or
+              claims asserted against, such Contributor by reason of your accepting
+              any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           Copyright 2026 Zeph Schafer
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Requires-Python: >=3.12
+License-File: LICENSE
+Requires-Dist: pyspark==4.0.2
+Requires-Dist: pandas
+Requires-Dist: requests
+Requires-Dist: pyarrow
+Requires-Dist: pytz
+Requires-Dist: pydantic>=2
+Requires-Dist: typer[all]>=0.9
+Requires-Dist: google-auth>=2.29
+Requires-Dist: google-cloud-storage>=2.16
+Requires-Dist: google-cloud-secret-manager>=2.20
+Requires-Dist: kafka-python>=2.0
+Requires-Dist: google-api-python-client>=2.126
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: mcp>=1.0
+Requires-Dist: duckdb>=1.0
+Dynamic: license-file

dcf_core-0.1.1/README.md

@@ -0,0 +1,209 @@
+# dcf
+
+D.ata C.ollection F.ramework
+
+It works like this
+1. User defines collectors with basic configs in a YAML (like a dbt model)
+2. dcf builds and runs the collector
+3. Data lake has data
+
+## Quickstart
+
+This guide walks you from zero to a working data collector. The example ingests your GitHub repositories.
+
+### 1. Create a project
+
+dcf is a tool you depend on, not a repo you clone. Create a fresh directory:
+
+```bash
+mkdir dcf-demo && cd dcf-demo
+```
+
+**`pyproject.toml`:**
+
+```toml
+[project]
+name = "dcf-demo"
+version = "0.1.0"
+requires-python = ">=3.12"
+dependencies = [
+    "dcf",
+]
+
+[tool.uv]
+package = false
+
+[tool.uv.sources]
+dcf = { git = "https://github.com/zephschafer/dcf.git" }    
+```
+
+**`project.yml`**
+
+```yaml
+catalog: local
+```
+
+**`.gitignore`:**
+
+```
+warehouse/
+project.yml
+.venv/
+__pycache__/
+```
+
+```bash
+mkdir collectors
+uv sync
+```
+
+---
+
+### 2. Write a collector
+
+Create `collectors/dcf_commits.yml`:
+
+```yaml
+name: dcf_commits
+namespace: github
+description: Commits to the dcf repository.
+
+source:
+  type: http
+  url: https://api.github.com/repos/zephschafer/dcf/commits
+  method: GET
+  params:
+    - name: sha
+      type: string
+      value: main
+    - name: per_page
+      type: integer
+      value: 100
+  schema:
+    columns:
+      - {name: sha,          path: sha,                type: string}
+      - {name: author,       path: commit.author.name, type: string}
+      - {name: message,      path: commit.message,     type: string}
+      - {name: committed_at, path: commit.author.date, type: timestamp}
+
+cadence:
+  strategy: incremental
+  primary_key: sha
+
+deployment:
+  schedule: "0 8 * * *"
+```
+
+---
+
+### 3. Validate
+
+```bash
+uv run dcf validate dcf_commits
+```
+
+---
+
+### 4. Run
+
+```bash
+uv run dcf run dcf_commits
+```
+
+---
+
+### 5. Query the warehouse
+
+```bash
+uv run dcf query 'SELECT * FROM github.dcf_commits'
+```
+
+You can also save your SQL to a file and run it with `--file`:
+
+```bash
+uv run dcf query --file my_query.sql
+```
+
+---
+
+### 6. Deploy
+
+```bash
+uv run dcf deploy dcf_commits
+```
+
+This schedules the collector to run daily at 8 AM UTC, as configured in `deployment.schedule`.
+
+---
+
+## Developing dcf
+
+Clone this repo, then create or point to a project for testing:
+
+```bash
+git clone https://github.com/Data-Dispatch/dcf
+cd dcf
+uv sync
+
+# Test against the demo project
+git clone https://github.com/Data-Dispatch/quipu-data-generator ../quipu-data-generator
+cd ../quipu-data-generator
+uv sync   # picks up dcf from ../dcf via editable path dep
+uv run dcf validate all
+```
+
+Or create a minimal test project:
+
+```bash
+mkdir my-test-project && cd my-test-project
+cat > pyproject.toml << 'EOF'
+[project]
+name = "my-test-project"
+version = "0.1.0"
+requires-python = ">=3.12"
+dependencies = ["dcf"]
+
+[tool.uv]
+package = false
+
+[tool.uv.sources]
+dcf = { path = "../dcf", editable = true }
+EOF
+
+cat > project.yml << 'EOF'
+catalog: local
+EOF
+
+mkdir collectors
+uv sync
+uv run dcf validate all   # "OK — 0 collector(s)"
+```
+
+---
+
+## dcf package structure
+
+```
+dcf/
+├── cli.py              Entry point (Typer app)
+├── project.py          Project root discovery (CWD walk / DCF_PROJECT_DIR)
+├── spark_session.py    PySpark + Iceberg session factory
+├── mcp_server.py       MCP server (FastMCP)
+├── warehouse_reader.py DuckDB-based warehouse query layer
+├── config/
+│   ├── models.py       Pydantic models for collector YAML
+│   └── loader.py       YAML loading + env var resolution
+├── engine/
+│   ├── runner.py       Outer loop (expand cadence → fetch → project → write)
+│   ├── fetcher.py      HTTP and Python source fetchers
+│   ├── iterator.py     Cartesian iteration over date ranges and categoricals
+│   ├── projector.py    Schema projection (path extraction, transforms)
+│   └── transforms.py   Column transforms (crs_reproject, etc.)
+├── writer/
+│   └── iceberg.py      Iceberg write strategies (incremental / append / full_refresh)
+└── gcp/
+    ├── bootstrap.py    GCS bucket + service account provisioning
+    ├── terraform.py    Terraform wrapper for lake infrastructure
+    ├── auth.py         GCP credential helpers
+    └── gcloud.py       gcloud CLI wrappers
+```

dcf_core-0.1.1/dcf/__init__.py

@@ -0,0 +1,4 @@
+from .engine.runner import run_collector
+from .config import load_collector, load_all_collectors
+
+__all__ = ["run_collector", "load_collector", "load_all_collectors"]