Skip to content

Commit dac1da0

Browse files
Merge pull request #228 from tina4stack/fix/docs-say-s3-storage-needs-boto3
docs: S3 storage needs no boto3
2 parents 074fa2e + dd0990a commit dac1da0

5 files changed

Lines changed: 18 additions & 5 deletions

File tree

‎.agents/skills/tina4-developer-python/references/realtime.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ download route `{files}/{key}`.
249249
### Storage backends (`storage.py`)
250250

251251
`select_storage(storage=None)` resolves from the `storage=` arg or `TINA4_STORAGE_BACKEND`
252-
(`local` default | `s3`). An `s3` backend that can't be built (boto3 missing / incomplete config)
252+
(`local` default | `s3`). An `s3` backend that can't be built (for example, no `TINA4_STORAGE_BUCKET`)
253253
**falls back to `LocalStorage`** with a warning — a real store, never a silent no-op.
254254

255255
| var | default | effect |

‎.claude/skills/tina4-developer-python/references/realtime.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ download route `{files}/{key}`.
249249
### Storage backends (`storage.py`)
250250

251251
`select_storage(storage=None)` resolves from the `storage=` arg or `TINA4_STORAGE_BACKEND`
252-
(`local` default | `s3`). An `s3` backend that can't be built (boto3 missing / incomplete config)
252+
(`local` default | `s3`). An `s3` backend that can't be built (for example, no `TINA4_STORAGE_BUCKET`)
253253
**falls back to `LocalStorage`** with a warning — a real store, never a silent no-op.
254254

255255
| var | default | effect |

‎.cursor/skills/tina4-developer-python/references/realtime.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ download route `{files}/{key}`.
249249
### Storage backends (`storage.py`)
250250

251251
`select_storage(storage=None)` resolves from the `storage=` arg or `TINA4_STORAGE_BACKEND`
252-
(`local` default | `s3`). An `s3` backend that can't be built (boto3 missing / incomplete config)
252+
(`local` default | `s3`). An `s3` backend that can't be built (for example, no `TINA4_STORAGE_BUCKET`)
253253
**falls back to `LocalStorage`** with a warning — a real store, never a silent no-op.
254254

255255
| var | default | effect |

‎CLAUDE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Version 3.13.150 - Lightweight Python web framework. See https://tina4.com for f
2525
- Install for the FULL test suite: `uv sync --extra test` — the declared client set
2626
for every live service the suite touches (PostgreSQL, MySQL, MSSQL, Firebird,
2727
MongoDB, ODBC, Redis, Memcached, **Kafka via confluent-kafka, RabbitMQ via
28-
pika, S3/MinIO via boto3**). Use this on any machine that runs the real-service
28+
pika**; S3/MinIO needs no client, `S3Storage` is zero-dependency). Use this on any machine that runs the real-service
2929
tests. Note `uv sync --extra X` PRUNES packages outside the named extras, so prefer
3030
`--extra test` over `--all-extras` when you want exactly the test set. `pyodbc`
3131
additionally needs the SYSTEM unixODBC library (`libodbc.so.2`, e.g.
@@ -923,7 +923,7 @@ uv run tina4python test # Discovers @tests in src/**/*.py
923923
- HTML builder via `tina4_python.HtmlElement` (programmatic HTML generation)
924924
- Messenger via `tina4_python.messenger` (.env driven, SMTP/IMAP)
925925
- Realtime collaboration via `tina4_python.realtime` — call `realtime(features=[...])` in `app.py` before `run()` to mount a zero-dependency control plane. Features: `calls` (WebRTC signalling relay + self-describing ICE config; media is peer-to-peer mesh, Tina4 relays only the offer/answer/ICE handshake), `chat` (framework-owned ORM channels/messages, secured chat WebSocket with presence/typing/read receipts, history endpoint), `files` (uploads through a pluggable `StorageBackend`). Paths are convention-based, overridable via `prefix`, and the client discovers resolved paths from the config endpoint so client and server cannot drift. Env: `TINA4_RTC_BACKEND`, `TINA4_RTC_STUN_URLS`, `TINA4_RTC_TURN_URL`, `TINA4_RTC_TURN_SECRET`, `TINA4_RTC_TURN_TTL`
926-
- File storage via `tina4_python.realtime.storage` — `TINA4_STORAGE_BACKEND` selects `local` (default, zero-dependency filesystem, `TINA4_STORAGE_DIR`) or `s3` (opt-in S3/MinIO, **needs boto3** — `uv sync --extra s3`; configured by `TINA4_STORAGE_URL`/`_KEY`/`_SECRET`/`_BUCKET`/`_REGION`). `S3Storage` issues presigned GET URLs so large blobs stream straight from object storage instead of through the app; `LocalStorage` returns `None` for `url()` and is served by the permissioned download route. An `s3` backend that cannot be built (boto3 missing or config incomplete) logs why and falls back to local — a real persistent store, never a silent no-op
926+
- File storage via `tina4_python.realtime.storage` — `TINA4_STORAGE_BACKEND` selects `local` (default, zero-dependency filesystem, `TINA4_STORAGE_DIR`) or `s3` (opt-in S3/MinIO, zero-dependency — Tina4's own stdlib SigV4 client, no driver to install; configured by `TINA4_STORAGE_URL`/`_KEY`/`_SECRET`/`_BUCKET`/`_REGION`). `S3Storage` issues presigned GET URLs so large blobs stream straight from object storage instead of through the app; `LocalStorage` returns `None` for `url()` and is served by the permissioned download route. An `s3` backend that cannot be built (for example, no `TINA4_STORAGE_BUCKET`) logs why and falls back to local — a real persistent store, never a silent no-op
927927
- SQL Translation via `tina4_python.database.adapter` (cross-engine SQL portability + query cache)
928928
- CLI scaffolding: `tina4 generate model/route/migration/middleware`. `tina4python` is the Python package's own CLI; the `tina4` client forwards `generate` to it.
929929
- Production server auto-detection: `tina4python serve --production` (auto-installs uvicorn)

‎tests/test_require_services_gate.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,19 @@ def test_boto3_is_not_in_the_s3_extra(self):
147147
"the `s3` extra is zero-dependency now — S3Storage needs no driver."
148148
)
149149

150+
def test_no_shipped_doc_says_s3_needs_boto3(self):
151+
# CLAUDE.md and the developer skill (every tree) are what a reader or an
152+
# agent installs from; telling them S3 needs boto3 sends them to install
153+
# a driver the code never imports.
154+
root = PYPROJECT.parent
155+
docs = [root / "CLAUDE.md", *sorted(root.glob(".*/skills/tina4-developer-python/**/*.md"))]
156+
claims = ("needs boto3", "boto3 missing", "via boto3", "boto3 is required")
157+
stale = [f"{doc.relative_to(root)}:{n}" for doc in docs
158+
for n, line in enumerate(doc.read_text(encoding="utf-8").splitlines(), 1)
159+
if any(claim in line for claim in claims)]
160+
assert len(docs) > 3, f"found only {docs}"
161+
assert not stale, f"docs still say S3 needs boto3: {stale}"
162+
150163
def test_the_test_extra_still_carries_every_other_live_client(self):
151164
# NEGATIVE guard against a careless edit dropping a client while adding
152165
# one. Each of these was itself an undeclared-dependency incident.

0 commit comments

Comments
 (0)