toolframe-sql-postgres 0.2.0__tar.gz

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

@@ -0,0 +1,44 @@
+name: Validate Python distribution
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  validate:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 25
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-15]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: '3.14.7'
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          version: '0.12.8'
+          enable-cache: false
+      - name: Test and install wheel and source distribution
+        run: python scripts/validate_release.py --output dist/validated
+      - name: Retain only validated distributions
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: python-dist-${{ matrix.os }}
+          path: dist/validated/*
+          if-no-files-found: error
+          retention-days: 14
+
+  postgres:
+    uses: ./.github/workflows/postgres.yml
+    secrets: inherit

toolframe_sql_postgres-0.2.0/.github/workflows/postgres.yml

@@ -0,0 +1,93 @@
+name: PostgreSQL integration
+on:
+  workflow_dispatch:
+  workflow_call:
+permissions:
+  contents: read
+jobs:
+  storage:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 20
+    services:
+      postgres:
+        image: postgres:16.14
+        env:
+          POSTGRES_PASSWORD: disposable-ci-database
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready --health-interval 5s
+          --health-timeout 5s --health-retries 12
+    env:
+      TOOLFRAME_POSTGRES_TEST_ADMIN_DSN: postgresql://postgres:disposable-ci-database@127.0.0.1:5432/postgres
+    steps:
+      - name: Check out provider
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+        with:
+          path: toolframe-sql-postgres
+          persist-credentials: false
+      - name: Check out toolframe-sdk
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+        with:
+          repository: ${{ vars.TOOLFRAME_REPOSITORY_OWNER || github.repository_owner }}/toolframe-sdk
+          token: ${{ secrets.TOOLFRAME_READ_TOKEN || github.token }}
+          ref: 2cd153ec36c585a9adb5ad566effc2985d9e222d
+          path: toolframe-sdk
+          persist-credentials: false
+      - name: Check out toolframe-auth
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+        with:
+          repository: ${{ vars.TOOLFRAME_REPOSITORY_OWNER || github.repository_owner }}/toolframe-auth
+          token: ${{ secrets.TOOLFRAME_READ_TOKEN || github.token }}
+          ref: f43c623cafb1483f3387935d7ef2690ca52088c9
+          path: toolframe-auth
+          persist-credentials: false
+      - name: Check out toolframe-mcp-auth
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+        with:
+          repository: ${{ vars.TOOLFRAME_REPOSITORY_OWNER || github.repository_owner }}/toolframe-mcp-auth
+          token: ${{ secrets.TOOLFRAME_READ_TOKEN || github.token }}
+          ref: 37b53ac0b37637c953cf5e40e59b5dcde8ab2c4b
+          path: toolframe-mcp-auth
+          persist-credentials: false
+      - name: Check out toolframe-oidc-auth
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+        with:
+          repository: ${{ vars.TOOLFRAME_REPOSITORY_OWNER || github.repository_owner }}/toolframe-oidc-auth
+          token: ${{ secrets.TOOLFRAME_READ_TOKEN || github.token }}
+          ref: 5d88289871c7e961216536ddde812510e319a7fe
+          path: toolframe-oidc-auth
+          persist-credentials: false
+      - name: Check out toolframe-demo-entry-register
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+        with:
+          repository: ${{ vars.TOOLFRAME_REPOSITORY_OWNER || github.repository_owner }}/toolframe-demo-entry-register
+          token: ${{ secrets.TOOLFRAME_READ_TOKEN || github.token }}
+          ref: 638e2163bd1f50f3715e05b418ac9095b4003513
+          path: toolframe-demo-entry-register
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97
+        with:
+          python-version: '3.14.7'
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7
+        with:
+          version: '0.12.8'
+          enable-cache: false
+      - name: Install matching PostgreSQL client tools
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y postgresql-client-16
+          echo 'TOOLFRAME_POSTGRES_PG_DUMP=/usr/lib/postgresql/16/bin/pg_dump' >> "$GITHUB_ENV"
+          echo 'TOOLFRAME_POSTGRES_PG_RESTORE=/usr/lib/postgresql/16/bin/pg_restore' >> "$GITHUB_ENV"
+      - name: Test real storage and first-party consumers
+        working-directory: toolframe-sql-postgres
+        run: |
+          uv sync --locked --group dev --group compatibility
+          uv run --no-sync python scripts/check.py
+          uv build --no-sources
+      - name: Retain distributions
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a
+        with:
+          name: postgres-distributions
+          path: toolframe-sql-postgres/dist/*
+          if-no-files-found: error

toolframe_sql_postgres-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,65 @@
+name: Publish Python distribution
+
+on:
+  workflow_dispatch:
+    inputs:
+      index:
+        description: Package index; run against the matching vVERSION tag
+        type: choice
+        options: [testpypi, pypi]
+        default: testpypi
+        required: true
+
+permissions:
+  contents: read
+
+concurrency:
+  group: publish-${{ inputs.index }}
+  cancel-in-progress: false
+
+jobs:
+  release-tag:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: '3.14.7'
+      - name: Require the exact package version tag
+        env:
+          RELEASE_REF: ${{ github.ref }}
+        run: |
+          python - <<'PYCODE'
+          import os, pathlib, tomllib
+          project = tomllib.loads(pathlib.Path('pyproject.toml').read_text())['project']
+          expected = 'refs/tags/v' + project['version']
+          if os.environ['RELEASE_REF'] != expected:
+              raise SystemExit('Publication requires ' + expected)
+          PYCODE
+
+  validate:
+    needs: release-tag
+    uses: ./.github/workflows/ci.yml
+    secrets: inherit
+
+  publish:
+    needs: [release-tag, validate]
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    environment:
+      name: ${{ inputs.index }}
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: python-dist-ubuntu-24.04
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          packages-dir: dist/
+          repository-url: ${{ inputs.index == 'testpypi' && 'https://test.pypi.org/legacy/' || 'https://upload.pypi.org/legacy/' }}

toolframe_sql_postgres-0.2.0/.github/workflows/quality.yml

@@ -0,0 +1,63 @@
+name: Code quality
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    types: [opened, synchronize, reopened, edited]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  branch-policy:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: '3.14.7'
+      - name: Check the actual source branch
+        env:
+          BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
+        run: python scripts/check_branch_name.py "$BRANCH_NAME"
+
+  code-quality:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          version: '0.12.8'
+          enable-cache: false
+      - name: Check Python lint and formatting
+        run: uvx prek==0.5.5 run ruff-check ruff-format --all-files --show-diff-on-failure
+
+  commit-policy:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    permissions:
+      contents: read
+      pull-requests: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: '3.14.7'
+      - uses: commit-check/commit-check-action@a61779784a953fd9047c001c102cfeac5cf26964 # commit-check 2.18.3
+        with:
+          message: true
+          branch: false
+          pr-title: true
+          pr-comments: false

toolframe_sql_postgres-0.2.0/.gitignore

@@ -0,0 +1,15 @@
+/.venv/
+/dist/
+/build/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.coverage
+.env
+.env.*
+
+# Local working documents, issue state, and development worktrees.
+/.local/
+/.issues/
+/.worktrees/

toolframe_sql_postgres-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+default_install_hook_types: [pre-commit, commit-msg]
+default_stages: [pre-commit]
+default_language_version:
+  python: python3.11
+
+repos:
+  - repo: local
+    hooks:
+      - id: check-branch-name
+        name: Check branch naming policy
+        entry: python scripts/check_branch_name.py
+        language: python
+        always_run: true
+        pass_filenames: false
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.8
+    hooks:
+      - id: ruff-check
+        types_or: [python, pyi]
+        files: '^(src|tests|scripts)/'
+      - id: ruff-format
+        types_or: [python, pyi]
+        args: [--check]
+        files: '^(src|tests|scripts)/'
+  - repo: https://github.com/commit-check/commit-check
+    rev: v2.18.3
+    hooks:
+      - id: check-message
+        stages: [commit-msg]

toolframe_sql_postgres-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing
+
+## Commit hooks
+
+Install [prek](https://prek.j178.dev/) and enable the repository's hooks:
+
+```sh
+uv tool install prek==0.5.5
+prek install --allow-missing-config
+prek run --all-files
+```
+
+The missing-config option allows older worktrees without this configuration to
+keep working. Worktrees containing `.pre-commit-config.yaml` still run the checks.
+The `pre-commit` hook checks the branch name, Python lint, and formatting. The
+`commit-msg` hook checks Conventional Commits. Both Ruff hooks only check files;
+they do not rewrite a commit's contents. Fix lint and formatting explicitly:
+
+```sh
+uvx ruff==0.16.8 check --fix src tests scripts
+uvx ruff==0.16.8 format src tests scripts
+prek run --all-files
+```
+
+The Ruff version and checked paths are pinned in
+[the hook configuration](.pre-commit-config.yaml); the Python rules remain in
+[pyproject.toml](pyproject.toml). CI uses these same hooks on all tracked files
+within their configured paths. Existing package, integration, and release checks
+run independently.
+
+## Branches and commits
+
+[cchk.toml](cchk.toml) defines the allowed branch and commit types. Work branches
+use `feat/`, `fix/`, `release/`, or `chore/`, followed by lowercase ASCII letters
+and digits separated by single hyphens. Release versions may also contain dots,
+as in `release/v1.2.0-rc.1`; every separator must have an alphanumeric character on
+both sides. The default branch `main` is the standalone exception.
+
+Commit types are independent of branch types: for example,
+`docs: clarify setup` is valid on `chore/update-docs`. Commit-check uses Conventional
+Commits with its default subject length of 5–80 characters. Pull requests check
+their commits and title so the title can be used for a Conventional Commit when
+squash merging.
+
+Local hooks can be bypassed. CI reports `branch-policy`, `code-quality`, and
+`commit-policy`; maintainers must configure required status checks separately to
+make passing checks a merge requirement.
+
+For package setup and broader verification, see [the development guide](docs/development.md).

toolframe_sql_postgres-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

toolframe_sql_postgres-0.2.0/NOTICE

@@ -0,0 +1,2 @@
+toolframe-sql-postgres
+Copyright 2026 byfb

toolframe_sql_postgres-0.2.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.5
+Name: toolframe-sql-postgres
+Version: 0.2.0
+Summary: Managed PostgreSQL stores for Toolframe plugins
+Project-URL: Homepage, https://github.com/toolframe/toolframe-sql-postgres
+Project-URL: Repository, https://github.com/toolframe/toolframe-sql-postgres
+Project-URL: Documentation, https://github.com/toolframe/toolframe-sql-postgres#readme
+Project-URL: Issues, https://github.com/toolframe/toolframe-sql-postgres/issues
+Author-email: byfb <62798989+byfb@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.14
+Requires-Dist: pglast==8.4
+Requires-Dist: psycopg[binary]<4,>=3.3
+Requires-Dist: toolframe-sdk==0.4.0
+Description-Content-Type: text/markdown
+
+# Toolframe PostgreSQL storage
+
+`sql-postgres` stores Toolframe plugin data in PostgreSQL. Entry Register,
+Auth, MCP Auth and OIDC Auth use a separate schema per plugin inside one database
+per application environment. Database access is loaded **only from the runtime
+process environment**; credentials do not belong in `toolframe.toml`.
+
+This release requires Toolframe SDK 0.4 and Core 0.7. Run one Core per
+application. Core 0.7 can separately store its management journal in a dedicated
+PostgreSQL database; SQLite remains the default. Configuration, private keys and
+artifacts still need a persistent application home. PostgreSQL storage does not
+make Core stateless or enable multiple replicas.
+Existing SQLite data is not imported. Plugins are trusted Python code.
+
+## Quick start
+
+Use Python 3.14+, PostgreSQL 16+, and `pg_dump` / `pg_restore` with the **same major
+version** as the server. PostgreSQL 16 is the integration-test baseline.
+
+Install the host and provider CLI from PyPI:
+
+```sh
+uv venv --python 3.14.7 .venv
+uv pip install --python .venv/bin/python \
+  toolframe-core==0.7.0 toolframe-sql-postgres==0.2.0
+.venv/bin/toolframe-core --home ./app init
+```
+
+Read `[application].id` from `app/toolframe.toml`. Supply an administrator DSN from
+your secret manager as `TOOLFRAME_POSTGRES_SETUP_DSN`. It is used only by setup.
+The CLI output file contains generated runtime credentials and must remain private.
+
+```sh
+.venv/bin/toolframe-postgres setup \
+  --application-id '<id from app/toolframe.toml>' \
+  --database toolframe_development \
+  --owner entry-register --owner auth --owner mcp-auth --owner oidc-auth \
+  --output ./app/.toolframe/postgres-environment.json
+unset TOOLFRAME_POSTGRES_SETUP_DSN
+```
+
+Add the provider to `app/toolframe.toml`:
+
+```toml
+[plugins.sql-postgres]
+source = "pypi:toolframe-sql-postgres==0.2.0"
+enabled = true
+
+[bindings]
+"toolframe.sql" = "sql-postgres"
+```
+
+This configuration sends every SQL consumer to PostgreSQL. Core builds with
+multiple SQL provider support can also run SQLite, using an explicit per-plugin
+override such as `"entry-register/sql" = "sql-sqlite"` in `[bindings]`.
+Choose bindings before initializing stores: changing a retained store's provider
+is rejected and does not copy data. Earlier Core builds require one enabled
+storage provider. The package version alone does not identify multiple-provider
+support; build the matching Core revision when using mixed providers.
+
+Install the matching business plugins
+before enabling them: Entry Register 0.4, Auth 0.3, MCP Auth 0.3 and OIDC Auth 0.3.
+Each store owner must be provisioned before Core starts its plugin.
+
+```sh
+.venv/bin/toolframe-postgres run \
+  --env-file ./app/.toolframe/postgres-environment.json -- \
+  .venv/bin/toolframe-core --home ./app serve
+```
+
+The `run` helper exports the private document as environment variables and replaces
+itself with Core. It removes setup/test administrator variables. Containers can
+inject the same runtime values directly; the provider does not read that file.
+
+- [Setup, environment and recovery](docs/operations.md)
+- [SQL and isolation contract](docs/storage-contract.md)
+- [Development and verification](docs/development.md)
+- [Domain glossary](docs/glossary.md) and [architecture decisions](docs/adr/0001-plugin-storage-boundary.md)
+
+For release validation and Trusted Publisher setup, see [releasing](docs/releasing.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+For development hooks and contribution rules, see [Contributing](CONTRIBUTING.md).