pyquickbase 0.1.0a1__py3-none-any.whl

pyquickbase/errors.py

@@ -0,0 +1,110 @@
+"""Exceptions raised by pyquickbase. Everything here derives from `QuickbaseError`."""
+
+from typing import Any
+
+
+class QuickbaseError(Exception):
+    """Base class for every error raised by this library."""
+
+
+class ConfigurationError(QuickbaseError, ValueError):
+    """The client was given invalid or missing settings."""
+
+
+class NetworkError(QuickbaseError):
+    """The request failed before a response was received."""
+
+
+class RequestTimeoutError(NetworkError):
+    """The request timed out. A timed-out write may still have been applied."""
+
+
+class InvalidResponseError(QuickbaseError):
+    """Quickbase reported success, but the response body wasn't in the expected format."""
+
+
+class ReadOnlyError(QuickbaseError):
+    """The client is read-only, and this request could change data. Nothing was sent."""
+
+
+class QueryError(QuickbaseError, ValueError):
+    """A query can't be sent as written. Nothing was sent to Quickbase."""
+
+
+class InvalidValueError(QuickbaseError, ValueError):
+    """A write can't be sent as written. Nothing was sent to Quickbase."""
+
+
+class WriteError(QuickbaseError):
+    """Part of a write failed, and the rest may have been applied.
+
+    `result` is a `WriteResult` with the records that were written and the rows that failed, when
+    Quickbase reported them.
+    """
+
+    def __init__(self, summary: str, *, result: Any = None) -> None:
+        super().__init__(summary)
+        self.result = result
+
+
+class UnknownTableError(QuickbaseError, LookupError):
+    """The app has no table with that name or ID."""
+
+
+class UnknownFieldError(QuickbaseError, LookupError):
+    """The table has no field with that label or ID."""
+
+
+class APIError(QuickbaseError):
+    """Quickbase answered with an unsuccessful status code.
+
+    `message` and `description` are Quickbase's own wording, when it sent any.
+    Include `request_id` when reporting a problem to Quickbase support.
+    """
+
+    def __init__(
+        self,
+        summary: str,
+        *,
+        status_code: int = 0,
+        method: str = "",
+        path: str = "",
+        message: str | None = None,
+        description: str | None = None,
+        request_id: str | None = None,
+    ) -> None:
+        super().__init__(summary)
+        self.status_code = status_code
+        self.method = method
+        self.path = path
+        self.message = message
+        self.description = description
+        self.request_id = request_id
+
+
+class BadRequestError(APIError):
+    """400: Quickbase rejected the request as malformed."""
+
+
+class AuthenticationError(APIError):
+    """401: the token is missing, invalid, or expired."""
+
+
+class PermissionDeniedError(APIError):
+    """403: the token's user may not perform this action."""
+
+
+class NotFoundError(APIError):
+    """404: the app, table, field, or record does not exist."""
+
+
+class RateLimitError(APIError):
+    """429: retries ran out, or Quickbase asked for a longer wait than the retry policy allows."""
+
+    def __init__(self, summary: str, *, retry_after: float | None = None, **kwargs: object) -> None:
+        super().__init__(summary, **kwargs)  # type: ignore[arg-type]  # pyright: ignore[reportArgumentType]
+        self.retry_after = retry_after
+
+
+class ServerError(APIError):
+    """5xx: Quickbase failed to process the request."""

pyquickbase-0.1.0a1.dist-info/METADATA

@@ -0,0 +1,223 @@
+Metadata-Version: 2.5
+Name: pyquickbase
+Version: 0.1.0a1
+Summary: An unofficial, typed Python SDK for the Quickbase API, with sync and async clients.
+Project-URL: Repository, https://github.com/matthew-williams-solutions/pyquickbase
+Project-URL: Issues, https://github.com/matthew-williams-solutions/pyquickbase/issues
+Project-URL: Changelog, https://github.com/matthew-williams-solutions/pyquickbase/blob/main/CHANGELOG.md
+Author: Matthew Williams
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,async,client,quickbase,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AnyIO
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: anyio<5,>=4.0
+Requires-Dist: httpx<1,>=0.27
+Description-Content-Type: text/markdown
+
+# pyquickbase
+
+An unofficial, typed Python SDK for the [Quickbase](https://www.quickbase.com/) API, with matching
+sync and async clients.
+
+> **Status: early alpha.** Anything may change before 1.0. This project is not affiliated with or endorsed by Quickbase, Inc.
+
+## What works today
+
+- Sync and async clients with the same API, and support for asyncio and Trio
+- Field labels instead of numeric IDs, and table names instead of table IDs
+- A Python query builder that escapes values, and checks for hand-written queries that Quickbase would
+  otherwise accept and answer incorrectly
+- Automatic paging, and records with real `date` and `datetime` values
+- Automatic retries for rate limits, honoring `Retry-After`, and for connection failures
+- Specific exceptions that include Quickbase's error message and request ID
+- Tokens kept out of `repr`s, exceptions, and logs, and never sent to other hosts or over plain HTTP
+- Creating, updating, and deleting records, with errors reported for each failed row
+- Creating and changing tables, fields, and relationships
+- `qb.request()` for calling any Quickbase endpoint directly
+
+## Coming next
+
+Reports, formulas, file attachments, temporary tokens, and generated typed tables.
+
+## Usage
+
+```bash
+pip install pyquickbase==0.1.0a1
+```
+
+This is an alpha release, so pin the exact version.
+
+```python
+from datetime import date
+from pyquickbase import F, Quickbase
+
+with Quickbase(realm="acme", token="your_user_token") as qb:
+    tasks = qb.app("bq1234567").table("Tasks")
+
+    overdue = (F("Status") != "Done") & (F("Due Date") < date.today())
+    for task in tasks.query(where=overdue, select=["Title", "Due Date"], order_by="-Due Date"):
+        print(task.id, task["Title"], task["Due Date"])
+
+    print(tasks.count(F("Status") == "Done"))
+```
+
+The async client has the same API:
+
+```python
+from pyquickbase import AsyncQuickbase, F
+
+async with AsyncQuickbase(realm="acme", token="your_user_token") as qb:
+    tasks = qb.app("bq1234567").table("Tasks")
+    async for task in tasks.query(where=F("Status") == "Done"):
+        print(task["Title"])
+```
+
+`Quickbase.from_env()` reads `QB_REALM` and `QB_USER_TOKEN` from the environment instead.
+
+## Writing queries
+
+Build conditions with `F`, combining them with `&` and `|` and wrapping each in parentheses.
+
+| Python | Matches |
+|---|---|
+| `F("Status") == "Done"`, `!=` | Equal, not equal, ignoring case |
+| `F("Hours") > 10`, `>=`, `<`, `<=` | Numbers and dates |
+| `F("Notes") == None` | Empty fields |
+| `F("Title").contains("x")`, `.not_contains()` | Text anywhere in the value |
+| `F("Title").starts_with("x")`, `.not_starts_with()` | Text at the start of the value |
+| `F("Status").is_in(["Done", "Blocked"])` | Any of the values |
+| `F("Tags").op("HAS", "x")` | Any other Quickbase operator |
+
+Use `F` for any text you don't control. It escapes quotes and rejects values containing `{` or `}`,
+which Quickbase can't search for and which could otherwise change the meaning of the query.
+
+You can also pass a Quickbase query string as `where`, using field IDs:
+`"({7.EX.'Done'}OR{7.EX.'Blocked'})AND{9.BF.'today'}"`. The SDK raises `QueryError` before sending a
+string with a mistake that Quickbase would silently accept, such as a lowercase operator, which it
+treats as "contains", or an unknown field, which matches nothing.
+
+## Reading records
+
+`query()` fetches further pages as you iterate, and `limit` stops it early. Read values by label or
+ID, with `record["Status"]` or `record[7]`. `dict(record)` gives you `{label: value}`. Record ID# is
+always selected, and without `order_by`, records come back in Record ID# order so that pages stay
+stable. For one page at a time, use `query_page()`, which returns the records, the `total` number of
+matches, `has_more`, and `next_skip`.
+
+Table and field metadata is cached for five minutes. Set `schema_ttl` on the client to change this,
+or call `qb.clear_schema_cache()` after changing a table.
+
+## Writing records
+
+Rows are dictionaries keyed by field label or ID. Python dates, timezone-aware datetimes, and
+`Decimal` values are converted for you, and `None` clears a field.
+
+| Method | What it does |
+|---|---|
+| `table.insert(rows)` | Creates records, and never changes existing ones |
+| `table.update(rows)` | Changes records. Each row needs a `Record ID#`, and a missing record is an error |
+| `table.upsert(rows, merge_on="Code")` | Updates the record whose unique field matches, or creates one |
+| `table.delete(where)` | Deletes matching records and returns the count. `where` is required |
+
+```python
+from pyquickbase import F, WriteError
+
+result = tasks.insert([{"Title": "Pour slab", "Status": "Not Started", "Due Date": date.today()}])
+print(result.created_ids)
+
+tasks.update([{"Record ID#": 7, "Status": "Done", "Notes": None}])
+tasks.delete(F("Status") == "Cancelled")
+
+try:
+    tasks.insert(rows)
+except WriteError as error:
+    print(error.result.created_ids)  # these were written
+    for failed in error.result.errors:
+        print(rows[failed.index], failed.messages)
+```
+
+Quickbase writes the rows it can and reports the rest, so a `WriteError` doesn't mean nothing changed.
+Large writes are split into batches of 1,000 rows, which you can change with `batch_size`. Check
+`error.result` before trying again.
+
+## Changing the schema
+
+```python
+projects = app.create_table("Projects", single_record_name="Project")
+projects.create_field("Name", "text")
+projects.create_field("Status", "text-multiple-choice", choices=["Active", "Done"])
+projects.create_field("Code", "text", unique=True)
+
+tasks.create_relationship(projects, foreign_key_label="Project", lookup_fields=["Name"])
+tasks.update_field("Notes", label="Comments")
+tasks.delete_fields("Old Field")
+tasks.drop(confirm="Tasks")  # deletes the table and its records
+```
+
+## Handling errors
+
+Every exception derives from `QuickbaseError`.
+
+```python
+from pyquickbase import AuthenticationError, QuickbaseError, RateLimitError
+
+try:
+    app = qb.request("GET", "/apps/bq1234567")
+except AuthenticationError:
+    app = None
+except RateLimitError as error:
+    print(f"Still rate limited. Try again in {error.retry_after} seconds.")
+except QuickbaseError as error:
+    print(error)
+```
+
+Quickbase answers with a 401, not a 404, for an app or table that doesn't exist, so
+`AuthenticationError` can mean either a bad token or a wrong ID.
+
+Only rate limits and connection failures are retried. A timed-out write isn't retried because
+Quickbase may already have applied it, so check the data before trying again.
+
+## Limiting what a client can do
+
+Pass `read_only=True` to guarantee a client can't change data. It only sends GET requests and record
+queries, including through `qb.request()`, and raises `ReadOnlyError` for anything else without
+contacting Quickbase.
+
+To allow specific writes and nothing else, pass `allowed_writes={("POST", "/records")}` instead.
+
+## Customizing
+
+Adjust retries with `RetryPolicy`. For proxies, custom TLS, logging hooks, or custom transports,
+pass your own [httpx](https://www.python-httpx.org/) client, which you remain responsible for
+closing.
+
+```python
+import httpx
+from pyquickbase import Quickbase, RetryPolicy
+
+http_client = httpx.Client(proxy="http://proxy.internal:8080")
+qb = Quickbase(
+    realm="acme",
+    token="your_user_token",
+    retry=RetryPolicy(max_retries=2),
+    user_agent="my-app/1.0",
+    http_client=http_client,
+)
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). To report a vulnerability, see [SECURITY.md](SECURITY.md).
+
+## License
+
+[MIT](LICENSE)

pyquickbase-0.1.0a1.dist-info/RECORD

@@ -0,0 +1,24 @@
+pyquickbase/__init__.py,sha256=LpL5txvyFaFSLPdcFrtdG0ZsA4hoGPnUVRGua0j-rBw,1707
+pyquickbase/_auth.py,sha256=d6CnF9rOLn9-pyNxCh_1uEtJbuiWi4pVwM9esOZ_u5s,569
+pyquickbase/_config.py,sha256=rONnqeKl1KitCGv_YbuMqEWx4v0X0IbrWIgBg57rEBk,3806
+pyquickbase/_models.py,sha256=nXHg9M8gyUSv1hOTVrQbYu2ri44O2FlEKUhdP1wRCkE,8217
+pyquickbase/_query.py,sha256=MlWjays75NqPk7g7uWvlbTeCV-fI0uml2K1ggjwnaDc,12174
+pyquickbase/_response.py,sha256=XzeKe9jSJ7UrGog5OJoqmCu-kOzl9LVYxbGbkt_B4mE,3231
+pyquickbase/_retry.py,sha256=oa2C0bEeikpa90KbsjdY_HPNbMayjL_IDygBQ8rVXzg,2568
+pyquickbase/_schema.py,sha256=1MQ-xnAdWApaj0av65ix0RMaHiWVYgAI24rwr2QwBUY,1075
+pyquickbase/_version.py,sha256=lmvUfjeqbjbsnD2PLlUjZbqEGZrq6yUD6t2LZsM61ak,24
+pyquickbase/_writes.py,sha256=ozZQW-nkx1AVdBiYKlxGlktsfBJXgDie_umCP9Ab9lQ,4252
+pyquickbase/errors.py,sha256=zHAwOZISJkMUlFBoBWtPOB48tDXlaav5dYG_ZhsCpHE,3281
+pyquickbase/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyquickbase/_async/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyquickbase/_async/_client.py,sha256=UYgVE6uHkwlFJrdO15Bq6Xv8rDMHlw7JHDZ2CNwzGsg,5392
+pyquickbase/_async/_resources.py,sha256=m2oUwT6leD9a28MQNaHdsGy9sAS42VjB14RUG9TYnOI,20641
+pyquickbase/_async/_transport.py,sha256=nd1dB67a8arBPrlApvej9h6eSWdQ4YBytDl3DVsairk,2804
+pyquickbase/_sync/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyquickbase/_sync/_client.py,sha256=gb0It1A6knvh-GRm7IYmr9uRUTjacwpOl_viRVLsPHE,5379
+pyquickbase/_sync/_resources.py,sha256=1OuJphLr9b8chBgMgRTw1VLSVUMHuV2O_italqHro6w,20153
+pyquickbase/_sync/_transport.py,sha256=10WQyfj_snPJv_hRuC8ovUH-EV0Ng9lSfiqDbaSHUK0,2829
+pyquickbase-0.1.0a1.dist-info/METADATA,sha256=qp4GGEoMKHIvnKjfWcQW2AtKWw83XjwvDP45LOmjppQ,8615
+pyquickbase-0.1.0a1.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+pyquickbase-0.1.0a1.dist-info/licenses/LICENSE,sha256=UVm3Z-AksaPwv43NXxjs2hXTYDVOzFLwpl85CtIqZBM,1073
+pyquickbase-0.1.0a1.dist-info/RECORD,,

pyquickbase-0.1.0a1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pyquickbase-0.1.0a1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Matthew Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.