pgbeam 0.2.1__tar.gz

pgbeam-0.2.1/.gitignore

@@ -0,0 +1,90 @@
+# Go binaries
+/bin/
+/cmd
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test
+*.test
+*.out
+coverage/
+coverage.html
+coverage.txt
+.hypothesis/
+
+# IDE
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Environment
+.env
+.env.*
+!.env.example
+!.env.development
+
+# Python
+.venv/
+__pycache__/
+*.py[cod]
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+
+# Node
+node_modules/
+.next/
+.turbo/
+dist/
+.kubb/
+*.tsbuildinfo
+**/next-env.d.ts
+.source/
+
+# Docker
+.docker/
+
+# Air hot-reload build artifacts
+tmp/
+
+# Local TLS certs
+.certs/
+
+# Vercel
+.vercel
+
+# Pulumi
+infra/bin/
+
+# Playwright
+playwright-report/
+test-results/
+playwright/.auth/
+
+# Storybook
+storybook-static/
+
+# PgBeam CLI project linking
+.pgbeam/
+
+# Noodle runtime state
+.noodle/
+.worktrees/
+.claude/worktrees/
+
+# Typefully config (contains API key)
+.typefully/
+.shots/
+dump.rdb
+
+# eve agent compile/discovery artifacts (frontend/apps/hq)
+.eve/
+.output/

pgbeam-0.2.1/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @pgbeam/python-sdk
+
+## 0.2.1
+
+### Patch Changes
+
+- f056d55: fix(ci): the guard that checks workflows did not run when workflows changed
+
+## 0.2.0
+
+### Minor Changes
+
+- ea5f407: feat(sdk): a Python SDK, generated from the OpenAPI contract
+
+  `pgbeam` on PyPI: a blocking `PgBeamClient` and an awaitable `AsyncPgBeamClient` over every operation in the public API, with a `TypedDict` per request and response body and a `py.typed` marker, so mypy and pyright check calls against the contract. `models.py`, `operations.py` and `services.py` come out of `pnpm generate`, so the client cannot drift from the spec, and CI fails on a stale one the same way it does for the Go, TypeScript and IaC surfaces. The transport is a port of the TypeScript SDK's, not a second opinion: same retryable statuses, same three bounds, same idempotency keys, and the same two error classes, so a 429 or a 409 means one thing across both clients.

pgbeam-0.2.1/LICENSE

@@ -0,0 +1,190 @@
+                                 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 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, "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 the 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 any 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
+
+   Copyright 2026 Alexis Rico
+
+   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.

pgbeam-0.2.1/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.5
+Name: pgbeam
+Version: 0.2.1
+Summary: Python SDK for the PgBeam API, a Postgres proxy for safe AI agent access with policy enforcement in the wire protocol
+Project-URL: Homepage, https://pgbeam.com
+Project-URL: Documentation, https://pgbeam.com/docs/python-sdk
+Project-URL: Repository, https://github.com/sferarc/pgbeam-python
+Project-URL: Issues, https://github.com/sferarc/pgbeam-python/issues
+Project-URL: Changelog, https://github.com/sferarc/pgbeam-python/blob/main/CHANGELOG.md
+Author-email: Alexis Rico <support@pgbeam.com>
+Maintainer-email: Alexis Rico <support@pgbeam.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agents,api-client,database-security,mcp,pgbeam,postgres,postgresql,proxy,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: typing-extensions>=4.7; python_version < '3.11'
+Description-Content-Type: text/markdown
+
+# pgbeam
+
+Python SDK for the [PgBeam](https://pgbeam.com) API: a globally distributed PostgreSQL proxy that enforces agent access policy in the wire protocol, with connection pooling and query caching.
+
+Manage projects, databases, agent credentials, and policy profiles from Python, with a blocking client and an asyncio client that expose exactly the same surface.
+
+## Install
+
+```bash
+pip install pgbeam
+```
+
+Python 3.10 or newer. The only runtime dependency is [httpx](https://www.python-httpx.org/).
+
+## Usage
+
+```python
+from pgbeam import PgBeamClient
+
+with PgBeamClient(token="your-api-key") as client:
+    # Tag-based access, one attribute per API area
+    projects = client.projects.list_projects(org_id="org_123")
+
+    for project in projects["projects"]:
+        print(project["id"], project["name"])
+
+    project = client.projects.get_project(project_id="prj_123")
+```
+
+Omit `token` and the client reads `PGBEAM_API_KEY` from the environment (`PGBEAM_TOKEN` and `PGBEAM_API_TOKEN` are accepted as aliases, the same order the CLI and the Terraform, Crossplane and Pulumi providers use). `PGBEAM_API_URL` overrides the base URL.
+
+### Async
+
+The async client is the same surface with `await` in front of it. Same method names, same arguments, same return types.
+
+```python
+import asyncio
+from pgbeam import AsyncPgBeamClient
+
+
+async def main() -> None:
+    async with AsyncPgBeamClient(token="your-api-key") as client:
+        projects = await client.projects.list_projects(org_id="org_123")
+        print(len(projects["projects"]))
+
+
+asyncio.run(main())
+```
+
+## Types
+
+Every request and response body is a `TypedDict` in `pgbeam.models`, and the package ships a `py.typed` marker, so mypy and pyright check your calls against the API contract.
+
+```python
+from pgbeam import PgBeamClient
+from pgbeam.models import CreateProjectRequest, Project
+
+body: CreateProjectRequest = {
+    "org_id": "org_123",
+    "name": "analytics",
+    "region": "us-east-1",
+}
+
+with PgBeamClient() as client:
+    created = client.projects.create_project(body=body)
+    project: Project = created["project"]
+```
+
+Timestamps are RFC 3339 strings, exactly as the API sends them. They are deliberately not parsed into `datetime`, so what you read is what came over the wire.
+
+## Error handling
+
+`ApiError` means the API answered and the answer was an error. `NetworkError` means it never answered at all: DNS failure, a refused or reset connection, or a timeout.
+
+```python
+from pgbeam import ApiError, NetworkError, PgBeamClient
+
+with PgBeamClient() as client:
+    try:
+        client.projects.get_project(project_id="prj_123")
+    except ApiError as err:
+        print(err.status, err)  # 404 Project not found
+        print(err.body)  # the decoded error body
+    except NetworkError as err:
+        print(err.url, err.attempts, err.timed_out)
+```
+
+## Retries and timeouts
+
+Every call retries 408, 429, 502, 503 and 504 up to five times with jittered exponential backoff, honouring `Retry-After` when the server sends one. A `POST` or `PATCH` that is retried carries one `Idempotency-Key` across all its attempts, so a retry of a request the server already accepted is not a second write.
+
+Three bounds apply, in the order they bite: a 30 second per-attempt timeout, a five-retry ceiling, and a 120 second budget for the whole call measured from the first attempt. A retry that would land past the budget is not made.
+
+```python
+from pgbeam import PgBeamClient, RetryConfig
+
+with PgBeamClient(
+    timeout_ms=10_000,
+    retry=RetryConfig(max_retries=2, total_budget_ms=30_000),
+) as client:
+    ...
+
+# No retrying at all
+with PgBeamClient(retry=RetryConfig(max_retries=0)) as client:
+    ...
+```
+
+The TypeScript SDK applies the same policy with the same defaults, so a 429 or a 409 means the same thing whichever one you reach for.
+
+### Bring your own HTTP client
+
+Pass an `httpx.Client` (or `httpx.AsyncClient`) to share a connection pool, route through a proxy, or install a custom transport. A client you supply is yours to close.
+
+```python
+import httpx
+from pgbeam import PgBeamClient
+
+http = httpx.Client(proxy="http://localhost:8080")
+client = PgBeamClient(token="...", http_client=http)
+```
+
+## Operations map
+
+`pgbeam.OPERATIONS_BY_TAG` and `pgbeam.OPERATIONS_BY_PATH` carry every operation's method and path, for building tooling on top of the SDK.
+
+```python
+from pgbeam import OPERATIONS_BY_PATH
+
+print(OPERATIONS_BY_PATH["GET /v1/projects/{project_id}"])
+# OperationMeta(method='GET', path='/v1/projects/{project_id}')
+```
+
+## Documentation
+
+Full API reference at [pgbeam.com/docs/python-sdk](https://pgbeam.com/docs/python-sdk).
+
+## Contributing
+
+Issues and pull requests are welcome here. An issue is the right place to start for a bug, a wrong doc, or a missing capability; say what you ran, what happened, what you expected, and which version you were on.
+
+`models.py`, `operations.py` and `services.py` are generated from the OpenAPI specification and carry a `DO NOT EDIT` header. A change to any of them belongs in the specification, not in the file. Everything else is ordinary hand-written Python.
+
+To build and test it locally:
+
+```bash
+uv sync --all-groups
+uv run ruff check
+uv run ruff format --check
+uv run mypy
+uv run pytest
+```
+
+Do not open a public issue for a suspected security vulnerability. Email security@pgbeam.com, or report it privately from this repository's Security tab.
+
+## License
+
+Apache 2.0, see [LICENSE](LICENSE).

pgbeam-0.2.1/README.md

@@ -0,0 +1,157 @@
+# pgbeam
+
+Python SDK for the [PgBeam](https://pgbeam.com) API: a globally distributed PostgreSQL proxy that enforces agent access policy in the wire protocol, with connection pooling and query caching.
+
+Manage projects, databases, agent credentials, and policy profiles from Python, with a blocking client and an asyncio client that expose exactly the same surface.
+
+## Install
+
+```bash
+pip install pgbeam
+```
+
+Python 3.10 or newer. The only runtime dependency is [httpx](https://www.python-httpx.org/).
+
+## Usage
+
+```python
+from pgbeam import PgBeamClient
+
+with PgBeamClient(token="your-api-key") as client:
+    # Tag-based access, one attribute per API area
+    projects = client.projects.list_projects(org_id="org_123")
+
+    for project in projects["projects"]:
+        print(project["id"], project["name"])
+
+    project = client.projects.get_project(project_id="prj_123")
+```
+
+Omit `token` and the client reads `PGBEAM_API_KEY` from the environment (`PGBEAM_TOKEN` and `PGBEAM_API_TOKEN` are accepted as aliases, the same order the CLI and the Terraform, Crossplane and Pulumi providers use). `PGBEAM_API_URL` overrides the base URL.
+
+### Async
+
+The async client is the same surface with `await` in front of it. Same method names, same arguments, same return types.
+
+```python
+import asyncio
+from pgbeam import AsyncPgBeamClient
+
+
+async def main() -> None:
+    async with AsyncPgBeamClient(token="your-api-key") as client:
+        projects = await client.projects.list_projects(org_id="org_123")
+        print(len(projects["projects"]))
+
+
+asyncio.run(main())
+```
+
+## Types
+
+Every request and response body is a `TypedDict` in `pgbeam.models`, and the package ships a `py.typed` marker, so mypy and pyright check your calls against the API contract.
+
+```python
+from pgbeam import PgBeamClient
+from pgbeam.models import CreateProjectRequest, Project
+
+body: CreateProjectRequest = {
+    "org_id": "org_123",
+    "name": "analytics",
+    "region": "us-east-1",
+}
+
+with PgBeamClient() as client:
+    created = client.projects.create_project(body=body)
+    project: Project = created["project"]
+```
+
+Timestamps are RFC 3339 strings, exactly as the API sends them. They are deliberately not parsed into `datetime`, so what you read is what came over the wire.
+
+## Error handling
+
+`ApiError` means the API answered and the answer was an error. `NetworkError` means it never answered at all: DNS failure, a refused or reset connection, or a timeout.
+
+```python
+from pgbeam import ApiError, NetworkError, PgBeamClient
+
+with PgBeamClient() as client:
+    try:
+        client.projects.get_project(project_id="prj_123")
+    except ApiError as err:
+        print(err.status, err)  # 404 Project not found
+        print(err.body)  # the decoded error body
+    except NetworkError as err:
+        print(err.url, err.attempts, err.timed_out)
+```
+
+## Retries and timeouts
+
+Every call retries 408, 429, 502, 503 and 504 up to five times with jittered exponential backoff, honouring `Retry-After` when the server sends one. A `POST` or `PATCH` that is retried carries one `Idempotency-Key` across all its attempts, so a retry of a request the server already accepted is not a second write.
+
+Three bounds apply, in the order they bite: a 30 second per-attempt timeout, a five-retry ceiling, and a 120 second budget for the whole call measured from the first attempt. A retry that would land past the budget is not made.
+
+```python
+from pgbeam import PgBeamClient, RetryConfig
+
+with PgBeamClient(
+    timeout_ms=10_000,
+    retry=RetryConfig(max_retries=2, total_budget_ms=30_000),
+) as client:
+    ...
+
+# No retrying at all
+with PgBeamClient(retry=RetryConfig(max_retries=0)) as client:
+    ...
+```
+
+The TypeScript SDK applies the same policy with the same defaults, so a 429 or a 409 means the same thing whichever one you reach for.
+
+### Bring your own HTTP client
+
+Pass an `httpx.Client` (or `httpx.AsyncClient`) to share a connection pool, route through a proxy, or install a custom transport. A client you supply is yours to close.
+
+```python
+import httpx
+from pgbeam import PgBeamClient
+
+http = httpx.Client(proxy="http://localhost:8080")
+client = PgBeamClient(token="...", http_client=http)
+```
+
+## Operations map
+
+`pgbeam.OPERATIONS_BY_TAG` and `pgbeam.OPERATIONS_BY_PATH` carry every operation's method and path, for building tooling on top of the SDK.
+
+```python
+from pgbeam import OPERATIONS_BY_PATH
+
+print(OPERATIONS_BY_PATH["GET /v1/projects/{project_id}"])
+# OperationMeta(method='GET', path='/v1/projects/{project_id}')
+```
+
+## Documentation
+
+Full API reference at [pgbeam.com/docs/python-sdk](https://pgbeam.com/docs/python-sdk).
+
+## Contributing
+
+Issues and pull requests are welcome here. An issue is the right place to start for a bug, a wrong doc, or a missing capability; say what you ran, what happened, what you expected, and which version you were on.
+
+`models.py`, `operations.py` and `services.py` are generated from the OpenAPI specification and carry a `DO NOT EDIT` header. A change to any of them belongs in the specification, not in the file. Everything else is ordinary hand-written Python.
+
+To build and test it locally:
+
+```bash
+uv sync --all-groups
+uv run ruff check
+uv run ruff format --check
+uv run mypy
+uv run pytest
+```
+
+Do not open a public issue for a suspected security vulnerability. Email security@pgbeam.com, or report it privately from this repository's Security tab.
+
+## License
+
+Apache 2.0, see [LICENSE](LICENSE).