pineforge-data 0.2.0__tar.gz

pineforge_data-0.2.0/.dockerignore

@@ -0,0 +1,8 @@
+.git
+.github
+.venv
+build
+dist
+**/__pycache__
+**/*.pyc
+tests

pineforge_data-0.2.0/.github/release.yml

@@ -0,0 +1,22 @@
+changelog:
+  exclude:
+    labels:
+      - skip-changelog
+  categories:
+    - title: Breaking changes
+      labels:
+        - breaking-change
+    - title: Features
+      labels:
+        - enhancement
+        - feature
+    - title: Fixes
+      labels:
+        - bug
+        - fix
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Other merged changes
+      labels:
+        - "*"

pineforge_data-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - run: python -m pip install --upgrade pip
+      - run: python -m pip install -e '.[dev,ccxt,release]'
+      - run: ruff check .
+      - run: mypy src
+      - run: pytest
+      - if: matrix.python-version == '3.13'
+        run: python -m build
+      - if: matrix.python-version == '3.13'
+        run: python -m twine check --strict dist/*
+
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: pip
+      - run: python -m pip install -e '.[dev]'
+      - run: PINEFORGE_DOCKER_TEST=1 pytest tests/test_docker_integration.py

pineforge_data-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: pip
+      - run: python -m pip install --upgrade pip
+      - run: python -m pip install -e '.[docs]'
+      - run: mkdocs build --strict
+      - if: github.event_name != 'pull_request'
+        uses: actions/configure-pages@v5
+      - if: github.event_name != 'pull_request'
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+
+  deploy:
+    if: github.event_name != 'pull_request'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - name: Deploy GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pineforge_data-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,231 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump:
+        description: Semantic version component to increment
+        required: true
+        default: patch
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    outputs:
+      published: ${{ steps.release.outputs.published }}
+      sha: ${{ steps.release.outputs.sha }}
+      tag: ${{ steps.release.outputs.tag }}
+      version: ${{ steps.release.outputs.version }}
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          ref: ${{ github.sha }}
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+      - name: Create and merge version bump
+        id: release
+        env:
+          BUMP: ${{ inputs.bump }}
+          DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+        run: |
+          set -euo pipefail
+          if [[ "$GITHUB_REF_NAME" != "$DEFAULT_BRANCH" ]]; then
+            echo "Release must be dispatched from $DEFAULT_BRANCH, not $GITHUB_REF_NAME" >&2
+            exit 1
+          fi
+
+          current_version="$(python scripts/bump_version.py current)"
+          version="$(python scripts/bump_version.py "$BUMP")"
+          tag="v$version"
+          git fetch origin "$DEFAULT_BRANCH" --tags
+
+          if sha="$(git rev-list -n 1 "$tag" 2>/dev/null)" && [[ -n "$sha" ]]; then
+            echo "Reusing existing tag $tag at $sha"
+          else
+            git show "origin/$DEFAULT_BRANCH:pyproject.toml" > "$RUNNER_TEMP/main-pyproject.toml"
+            main_version="$(python scripts/bump_version.py current --pyproject "$RUNNER_TEMP/main-pyproject.toml")"
+            if [[ "$main_version" == "$version" ]]; then
+              sha="$(git rev-parse "origin/$DEFAULT_BRANCH")"
+              echo "Reusing version bump already merged at $sha"
+            elif [[ "$main_version" != "$current_version" ]]; then
+              echo "main moved from version $current_version to $main_version; dispatch again" >&2
+              exit 1
+            else
+              branch="release/$tag-$GITHUB_RUN_ID"
+              git switch --create "$branch" "origin/$DEFAULT_BRANCH"
+              written_version="$(python scripts/bump_version.py "$BUMP" --write)"
+              [[ "$written_version" == "$version" ]]
+              git config user.name "github-actions[bot]"
+              git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+              git add pyproject.toml
+              git commit -m "Release $tag"
+              head_sha="$(git rev-parse HEAD)"
+              git push --set-upstream origin "$branch"
+
+              gh label create skip-changelog \
+                --description "Exclude this PR from generated release notes" \
+                --color "ededed" \
+                --force
+              pr_url="$(gh pr create \
+                --base "$DEFAULT_BRANCH" \
+                --head "$branch" \
+                --title "Release $tag" \
+                --body "Automated **$BUMP** version bump from $current_version to $version.")"
+              pr_number="${pr_url##*/}"
+              gh pr edit "$pr_number" --add-label skip-changelog
+              mergeable=UNKNOWN
+              for _attempt in {1..30}; do
+                mergeable="$(gh pr view "$pr_number" --json mergeable --jq ".mergeable")"
+                [[ "$mergeable" == "MERGEABLE" ]] && break
+                if [[ "$mergeable" == "CONFLICTING" ]]; then
+                  echo "Release PR $pr_number conflicts with $DEFAULT_BRANCH" >&2
+                  exit 1
+                fi
+                sleep 2
+              done
+              if [[ "$mergeable" != "MERGEABLE" ]]; then
+                echo "Release PR $pr_number did not become mergeable" >&2
+                exit 1
+              fi
+              gh pr merge "$pr_number" \
+                --squash \
+                --delete-branch \
+                --match-head-commit "$head_sha" \
+                --subject "Release $tag" \
+                --body "Automated semantic version bump."
+              sha="$(gh pr view "$pr_number" --json mergeCommit --jq ".mergeCommit.oid")"
+            fi
+          fi
+
+          pypi_status="$(curl \
+            --silent \
+            --output /dev/null \
+            --write-out '%{http_code}' \
+            --retry 3 \
+            --retry-all-errors \
+            "https://pypi.org/pypi/pineforge-data/$version/json")"
+          case "$pypi_status" in
+            200) published=true ;;
+            404) published=false ;;
+            *)
+              echo "Unexpected PyPI status $pypi_status while checking $version" >&2
+              exit 1
+              ;;
+          esac
+
+          {
+            echo "published=$published"
+            echo "sha=$sha"
+            echo "tag=$tag"
+            echo "version=$version"
+          } >> "$GITHUB_OUTPUT"
+          printf "Prepared %s at %s (already on PyPI: %s).\n" \
+            "$tag" "$sha" "$published" >> "$GITHUB_STEP_SUMMARY"
+
+  build:
+    if: needs.prepare.outputs.published != 'true'
+    needs: prepare
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ needs.prepare.outputs.sha }}
+          persist-credentials: false
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: pip
+      - run: python -m pip install --upgrade pip
+      - run: python -m pip install -e '.[dev,ccxt,release]'
+      - name: Verify release tag and source
+        run: python scripts/verify_release.py "${{ needs.prepare.outputs.tag }}"
+      - name: Run static and unit checks
+        run: |
+          ruff check .
+          mypy src
+          pytest
+      - name: Run Docker integration checks
+        run: PINEFORGE_DOCKER_TEST=1 pytest tests/test_docker_integration.py
+      - name: Build wheel and source distribution
+        run: python -m build
+      - name: Check distribution metadata
+        run: python -m twine check --strict dist/*
+      - name: Install wheel in a clean environment
+        run: |
+          python -m venv /tmp/pineforge-wheel
+          /tmp/pineforge-wheel/bin/python -m pip install dist/*.whl
+          /tmp/pineforge-wheel/bin/python -c "import pineforge_data; assert 'Bar' in pineforge_data.__all__"
+      - name: Upload validated distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+          if-no-files-found: error
+
+  github-release:
+    if: needs.prepare.outputs.published != 'true'
+    needs:
+      - prepare
+      - build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Create GitHub Release with generated notes
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+          SHA: ${{ needs.prepare.outputs.sha }}
+          TAG: ${{ needs.prepare.outputs.tag }}
+        run: |
+          set -euo pipefail
+          if gh release view "$TAG" >/dev/null 2>&1; then
+            echo "GitHub Release $TAG already exists"
+          else
+            gh release create "$TAG" \
+              --target "$SHA" \
+              --title "pineforge-data $TAG" \
+              --generate-notes \
+              --latest
+          fi
+
+  publish:
+    if: needs.prepare.outputs.published != 'true'
+    needs:
+      - prepare
+      - build
+      - github-release
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/pineforge-data/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download validated distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish to PyPI with Trusted Publishing
+        uses: pypa/gh-action-pypi-publish@release/v1

pineforge_data-0.2.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.coverage
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.venv/
+build/
+dist/
+site/

pineforge_data-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,82 @@
+# Contributing
+
+Community data providers are the reason this repository exists. Keep the core
+contracts small and put vendor behavior behind Python provider modules. This
+repository does not accept a separate C++ provider implementation surface.
+
+User-facing architecture and API guides are indexed in
+[docs/index.md](docs/index.md). Update the applicable guide when changing public
+models, provider behavior, CLI options, report fields, runtime channels, or
+server/cache semantics.
+
+Docker is required for raw-Pine integration work. Engine and codegen are
+consumed only through the pinned `pineforge-release` image; do not add source
+submodules or duplicate their build logic here.
+
+```bash
+docker version
+```
+
+## Provider checklist
+
+- Implement `MarketDataProvider` for backtest-compatible adapters; live-trade
+  and macro support remain separate optional protocols.
+- Resolve exact normalized symbols from the upstream market catalog. Do not
+  infer base, quote, settlement currency, or contract terms by parsing symbols.
+- Preserve both the normalized symbol and the provider-native `provider_id`.
+- Represent spot/cash/CFD/swap/future/option separately and populate derivative
+  contract size, linear/inverse flags, expiry, strike, and option type when the
+  upstream supplies them.
+- Normalize all timestamps to Unix milliseconds.
+- Preserve the source name and normalized instrument on every record.
+- Keep credentials out of logs and exception messages; prefer authorization
+  headers when the upstream API supports them.
+- Make retries, timeouts, and rate limits explicit.
+- Add offline fixture tests. CI must not require network access or API keys.
+- Declare provider-specific libraries as optional dependencies.
+- Keep local/database adapters read-only, validate mapped identifiers against
+  reflected metadata, and bind query values instead of accepting raw SQL.
+- Keep provider-specific request parameters inside the adapter rather than
+  extending the normalized records.
+- Never make `pineforge-engine` depend on this package.
+
+Adapters may be contributed in-tree or shipped by another Python package. An
+external package registers a factory without changing this repository's CLI:
+
+```toml
+[project.entry-points."pineforge_data.providers"]
+example = "example_pineforge:provider_factory"
+```
+
+The callable receives `(venue, config)` and returns a structural
+`MarketDataProvider`. See [docs/provider-contract.md](docs/provider-contract.md)
+for the normalized model and a complete skeleton.
+
+Every provider must have a second-level API guide at
+`docs/providers/<provider>.md` and a catalog row in
+`docs/providers.md`. Keep provider-specific installation, constructor,
+configuration, behavior, errors, and limitations out of the catalog page.
+
+## Determinism and macro vintages
+
+Historical results must be reproducible. Cache or snapshot mutable upstream
+responses when exact replay matters. Macroeconomic values require both the
+original release timestamp and the timestamp at which a particular vintage
+became available; using today's revised value in an old backtest is lookahead.
+
+## Checks
+
+```bash
+python -m pip install -e '.[dev,ccxt,database,server,docs,release]'
+ruff check .
+mypy src
+pytest
+mkdocs build --strict
+python -m build
+python -m twine check dist/*
+PINEFORGE_DOCKER_TEST=1 pytest tests/test_docker_integration.py
+```
+
+Maintainers should follow the version, tag, artifact, and Trusted Publishing
+steps in the [release guide](docs/releasing.md). Contributors cannot publish a
+package from a pull request.

pineforge_data-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, 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 modifications
+      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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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, "submitted"
+      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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 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 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 redistributing 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 consequential 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 any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional 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 act only
+      on Your own behalf and on Your sole responsibility, 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 PineForge contributors
+
+   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.