fastapi-rtk 2.15.0__tar.gz → 2.17.0__tar.gz

{fastapi_rtk-2.15.0 → fastapi_rtk-2.17.0}/.gitignore

@@ -294,4 +294,10 @@ dist
 .pnp.*
 
 .vscode
-py/fastapi_rtk/_version.py
+py/fastapi_rtk/_version.py
+
+# What `fastapi-rtk agent install` writes when it is run against the example app.
+# The guide's source of truth is py/fastapi_rtk/agent_docs/guide/.
+py/example/docs/agents/
+py/example/AGENTS.md
+py/example/.claude/

{fastapi_rtk-2.15.0 → fastapi_rtk-2.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: fastapi-rtk
-Version: 2.15.0
+Version: 2.17.0
 Summary: A package that provides a set of tools to build a FastAPI application with a Class-Based CRUD API.
 Project-URL: Homepage, https://codeberg.org/datatactics/fastapi-rtk
 Project-URL: Issues, https://codeberg.org/datatactics/fastapi-rtk/issues
@@ -69,6 +69,21 @@ FastAPI React Toolkit bootstraps a web API with [FastAPI](https://github.com/tia
 
 You can use `fastapi-rtk create-app` command to quickly set up a new project with the recommended structure and example code.
 
+### AI coding agents
+
+If you work with an AI coding agent, run this inside your project to teach it the framework:
+
+```bash
+fastapi-rtk agent install
+```
+
+It installs the guide at `docs/agents/fastapi-rtk/`, then one entry point per agent:
+
+- `.claude/skills/rtk-developer/SKILL.md` for Claude Code, when the project has a `.claude` directory or a `CLAUDE.md`, or `claude` is on your PATH. `--claude` writes it regardless, `--no-claude` skips it.
+- A section in `AGENTS.md`, read by Codex, Cursor and others following that convention, when no other entry point was written. `--agents-md` writes it regardless, `--no-agents-md` skips it.
+
+The guide ships inside the installed package, so re-run with `--force` after an upgrade. `fastapi-rtk agent uninstall` removes it all again, keeping your own text in `AGENTS.md` and any file you added under the guide directory. Every file that gets overwritten or removed is copied to `<name>.<YYYYmmdd-HHMMSS>.bak` first.
+
 ### Recommended Project Structure
 
 ```

{fastapi_rtk-2.15.0 → fastapi_rtk-2.17.0}/README.md

@@ -20,6 +20,21 @@ FastAPI React Toolkit bootstraps a web API with [FastAPI](https://github.com/tia
 
 You can use `fastapi-rtk create-app` command to quickly set up a new project with the recommended structure and example code.
 
+### AI coding agents
+
+If you work with an AI coding agent, run this inside your project to teach it the framework:
+
+```bash
+fastapi-rtk agent install
+```
+
+It installs the guide at `docs/agents/fastapi-rtk/`, then one entry point per agent:
+
+- `.claude/skills/rtk-developer/SKILL.md` for Claude Code, when the project has a `.claude` directory or a `CLAUDE.md`, or `claude` is on your PATH. `--claude` writes it regardless, `--no-claude` skips it.
+- A section in `AGENTS.md`, read by Codex, Cursor and others following that convention, when no other entry point was written. `--agents-md` writes it regardless, `--no-agents-md` skips it.
+
+The guide ships inside the installed package, so re-run with `--force` after an upgrade. `fastapi-rtk agent uninstall` removes it all again, keeping your own text in `AGENTS.md` and any file you added under the guide directory. Every file that gets overwritten or removed is copied to `<name>.<YYYYmmdd-HHMMSS>.bak` first.
+
 ### Recommended Project Structure
 
 ```

{fastapi_rtk-2.15.0 → fastapi_rtk-2.17.0}/fastapi_rtk/__init__.py

@@ -37,6 +37,19 @@ __all__ = [
     # .api
     "BaseApi",
     "ModelRestApi",
+    "Params",
+    "P_ID",
+    "P_IDS",
+    "P_Q",
+    "P_SESSION",
+    "P_BODY",
+    "P_ITEM",
+    "P_ITEMS",
+    "PARAM_Q",
+    "PARAM_IDS_Q_SESSION_ITEMS",
+    "PARAM_ID_SESSION",
+    "PARAM_ID_SESSION_ITEM",
+    "PARAM_BODY_SESSION",
     # .auth
     "FABPasswordHelper",
     "Authenticator",
@@ -185,6 +198,7 @@ __all__ = [
     "ignore_g_user",
     "relationship_filter",
     "docs",
+    "priority",
     # .dependencies
     "set_global_user",
     "current_permissions",
@@ -193,6 +207,10 @@ __all__ = [
     "raise_exception",
     "FastAPIReactToolkitException",
     "RolesMismatchException",
+    "RoleNotFoundException",
+    "RoleAlreadyExistsException",
+    "RoleInUseException",
+    "ColumnNotSupportedException",
     "HTTPWithValidationException",
     # .fastapi_react_toolkit
     "FastAPIReactToolkit",

fastapi_rtk-2.17.0/fastapi_rtk/_version.py

@@ -0,0 +1 @@
+__version__ = "2.17.0"

fastapi_rtk-2.17.0/fastapi_rtk/agent_docs/adapters/agents-md/AGENTS.md

@@ -0,0 +1,38 @@
+## fastapi-rtk
+
+This project uses [fastapi-rtk](https://codeberg.org/datatactics/fastapi-rtk), a full-stack toolkit
+whose Python backend generates CRUD endpoints from SQLAlchemy models and whose React frontend
+consumes them through `ApiProvider`. Treat the two halves as one system, not two independent stacks.
+
+Detailed guidance ships with the package and was installed into this project:
+
+- `docs/agents/fastapi-rtk/overview.md`: start here. Maps each feature to its backend and frontend
+  halves, and says which of the files below to open.
+- `docs/agents/fastapi-rtk/backend.md`: models, `ModelRestApi`, hooks, filters, permissions,
+  migrations, file uploads, bulk handlers, OAuth.
+- `docs/agents/fastapi-rtk/frontend.md`: `Provider`, `ApiProvider`, `useApi`, `NextGenDataGrid`,
+  `useForms`, dialogs, JsonForms, i18n.
+- `docs/agents/fastapi-rtk/legacy.md`: workarounds for older releases, keyed by symptom. Open it only
+  when this project pins an older fastapi-rtk than the guide was verified against.
+
+Read the file that covers the half you are touching before writing fastapi-rtk code.
+
+### Rules that always apply
+
+1. `resource_name` is the contract. Backend `resource_name = "items"` and frontend
+   `<ApiProvider resource_name="items">` must match exactly; a typo breaks it silently.
+2. Extend the generated endpoints through `pre_*` / `post_*` hooks rather than hand-rolled routes,
+   and render resource tables with `NextGenDataGrid` configured through `columnProps` rather than a
+   raw table. Reserve `@expose` for endpoints that are not CRUD on a model.
+3. Async-first: use async drivers (`sqlite+aiosqlite`, `postgresql+asyncpg`), write hooks as
+   `async def`, and bridge sync code with `smart_run`.
+4. Filter relationship options on the backend with `@relationship_filter` or
+   `add_query_rel_fields` / `edit_query_rel_fields`, never in JS.
+5. Frontend provider order is MantineProvider, then the fastapi-rtk `Provider`, then the app. CSS
+   imports go Mantine first, fastapi-rtk last.
+
+Refresh this section and the guide after upgrading fastapi-rtk:
+
+```bash
+fastapi-rtk agent install --force
+```

fastapi_rtk-2.17.0/fastapi_rtk/agent_docs/adapters/claude/skill.frontmatter

@@ -0,0 +1,2 @@
+name: rtk-developer
+description: Full-stack development with the FastAPI React Toolkit (fastapi-rtk), a tightly coupled Python (FastAPI + SQLAlchemy + Pydantic + Alembic) backend and React (Mantine-based) frontend framework that generates CRUD endpoints from models and consumes them automatically through an ApiProvider. Use this skill whenever the user is building, modifying, or debugging anything in a fastapi-rtk project: Python models, ModelRestApi / BaseApi endpoints, pre/post hooks, permissions, migrations, file uploads, bulk operations, or the React side (Provider setup, ApiProvider, useApi, NextGenDataGrid, useForms, dialogs, JsonForms). Also use it when the user mentions fastapi-rtk, rtk, "rtk backend", "rtk frontend", or describes a problem that touches both sides at once (e.g. adding a model and surfacing it in a grid). Prefer this skill over plain FastAPI or React skills whenever the project imports from `fastapi_rtk` or `fastapi-rtk` (JS package).