karni-approvals 0.3.1__tar.gz

karni_approvals-0.3.1/.gitignore

@@ -0,0 +1,38 @@
+.learning/
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Build artifacts
+dist/
+build/
+packages/karni-cli/karni_cli/_templates/
+packages/karni-cli/karni_cli/_agent/
+packages/karni-cli/karni_cli/_changelog/
+packages/karni-cli/karni_cli/_errorcodes/
+
+# Node
+node_modules/
+storybook-static/
+*.tsbuildinfo
+
+# Local env / editor / tooling
+.env
+.env.*
+!.env.example
+.DS_Store
+.idea/
+.claude/scheduled_tasks.lock
+.claude/settings.local.json
+
+# MkDocs build output
+site/

karni_approvals-0.3.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

karni_approvals-0.3.1/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.5
+Name: karni-approvals
+Version: 0.3.1
+Summary: Maker-checker approvals module for the Karni Django + React framework: a second person approves high-value changes before they are written, with a queue, an API, notifications and a full audit trail.
+Project-URL: Homepage, https://github.com/cbsshekhawat18-lab/karni
+Project-URL: Documentation, https://cbsshekhawat18-lab.github.io/karni/
+Project-URL: Repository, https://github.com/cbsshekhawat18-lab/karni
+Project-URL: Issues, https://github.com/cbsshekhawat18-lab/karni/issues
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: approvals,django,four-eyes,karni,maker-checker,react,workflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: karni<0.4,>=0.3
+Description-Content-Type: text/markdown
+
+# karni-approvals
+
+Second-person (maker-checker) approval for high-value changes in a
+[Karni](https://github.com/cbsshekhawat18-lab/karni) project. A model opts
+in; from then on a guarded change by anyone — through the API, the admin or
+plain code — becomes a **pending change holding the diff instead of a
+write**. A checker holding the approve permission applies or rejects it,
+with a reason. The maker can never be the checker, in code.
+
+## Install
+
+```sh
+pip install karni-approvals
+karni add approvals
+karni migrate
+```
+
+`karni add approvals` adds the dependency, wires `karni_approvals` into the
+`# karni:apps` block and records this module's agent guidance. No URL
+include is needed: the API rides the auto-router. Keep the Celery worker
+running — notifications and the hourly timeout sweep are tasks.
+
+## Opt a model in
+
+```python
+from datetime import timedelta
+from karni.models import BaseModel
+
+class Invoice(BaseModel):
+    ...
+    class Karni:
+        requires_approval = ["amount", "status"]   # or True: any change, create and delete too
+        approvals_required = 2                      # default KARNI_APPROVALS_REQUIRED (1)
+        approver_roles = ["finance"]                # default KARNI_APPROVALS_APPROVER_ROLES ([])
+        approval_timeout = timedelta(hours=48)      # or hours as a number; default the setting (never)
+        approval_on_timeout = "escalate"            # or "expire" (the default)
+        approval_escalation_roles = ["cfo"]         # default KARNI_APPROVALS_ESCALATION_ROLES
+```
+
+The model must be a `karni.models.BaseModel` (every `save()` and `delete()`
+sends `karni.signals.pre_write`; that is the hook). `karni check` fails the
+build for a guarded model that is not, for a malformed policy, and for
+approver roles `KARNI_ROLES` does not declare (`APR007`).
+
+## What happens
+
+- **A guarded write is held.** When a signed-in user changes a guarded
+  field (a list) or anything at all (`True`), a `PendingChange` records the
+  whole change as `{field: [old, new]}` and the write is stopped before any
+  SQL: the API answers **202** with the pending change, the admin shows
+  "sent for approval" and returns to the list, plain code gets
+  `karni.exceptions.KarniWriteDeferred` (code `APR001`). The row is not
+  touched; the change is itself history (`karni.audit`).
+- **Writes pass through** with no current user (migrations, seeds,
+  management commands), inside the module's own apply, and inside
+  `karni_approvals.interception.bypass(reason="...")` for trusted code.
+  Bulk SQL (`QuerySet.update()`) is never seen — `karni check`'s
+  `audited-bulk-write` rule catches it on audited models.
+- **Deciding** is `karni_approvals.services.decide(pending, checker, "approve" | "reject", reason)`,
+  behind the API (`POST /api/pending-changes/{id}/approve/` and `reject/`)
+  and the admin queue. Every rule lives there, so it holds wherever a
+  decision comes from:
+  - the maker can never be the checker (`APR002`), superuser or not;
+  - a checker needs the `karni_approvals.pendingchange:approve` (or
+    `:reject`) grant and, when the model declares `approver_roles`, one of
+    those roles (`APR003`);
+  - a checker sees and decides only pending changes whose row lies inside
+    their own scope — a branch checker, their branch (`APR003`); a create
+    has no row yet and is visible to whoever may view every row of that
+    model;
+  - one decision per person (`APR004`); a decided change is final (`APR005`);
+  - the change is applied as the last approver once `approvals_required`
+    approvals are in — the row's own history then names the checker — and
+    refused as stale when any recorded old value no longer matches
+    (`APR006`, status `failed`).
+- **Timeouts.** A change past `approval_timeout` is swept hourly: `expire`
+  marks it expired; `escalate` emails the escalation roles and extends it by
+  the same timeout.
+- **Notifications.** On proposal the checkers are emailed from a Celery task
+  (`KARNI_APPROVALS_NOTIFY`, a dotted path called with the pending change;
+  `""` switches it off; replace it to post elsewhere).
+- **Audit.** `PendingChange` and `Decision` are audited models: every
+  proposal, approval and rejection is a `karni.audit` entry with its actor.
+
+## Where it shows
+
+| Surface | What |
+| --- | --- |
+| Admin → Karni approvals → Pending changes | the queue in the checker's scope, each change's diff and decisions, **Approve selected** / **Reject selected** with a reason |
+| `GET /api/pending-changes/` | the queue (filters: `status`, `action`, `content_type`, `maker`), scoped; makers with an `own` grant see their own |
+| `POST /api/pending-changes/{id}/approve/`, `…/reject/` | `{"reason": "..."}` → the updated pending change; 403 `APR002`/`APR003`, 400 for the rest |
+| `GET /api/pending-changes/count/` | `{"pending": n}` the requester may decide — the badge |
+| `@karni/approvals-ui` | `<ApprovalsBadge/>`, `<ApprovalsQueue/>`, `usePendingCount`, `usePendingChanges`, `useDecidePendingChange` |
+
+## Settings
+
+Every setting arrives through the module's settings fragment
+(`karni_approvals.conf.DEFAULTS`) and is overridable in the project's
+`settings.py` or by its environment variable; each has a per-model override
+in `class Karni`.
+
+| Setting | Env var | Default | Meaning |
+| --- | --- | --- | --- |
+| `KARNI_APPROVALS_REQUIRED` | `KARNI_APPROVALS_REQUIRED` | `1` | approvals a change needs |
+| `KARNI_APPROVALS_APPROVER_ROLES` | `KARNI_APPROVALS_APPROVER_ROLES` | `[]` | roles that may approve, on top of the grant (`[]` = any holder) |
+| `KARNI_APPROVALS_TIMEOUT_HOURS` | `KARNI_APPROVALS_TIMEOUT_HOURS` | `0` | hours before a change times out (`0` = never) |
+| `KARNI_APPROVALS_ON_TIMEOUT` | `KARNI_APPROVALS_ON_TIMEOUT` | `expire` | `expire` or `escalate` |
+| `KARNI_APPROVALS_ESCALATION_ROLES` | `KARNI_APPROVALS_ESCALATION_ROLES` | `[]` | roles emailed on escalation |
+| `KARNI_APPROVALS_NOTIFY` | `KARNI_APPROVALS_NOTIFY` | `karni_approvals.notify.email_checkers` | the notifier (`""` = off) |
+| `KARNI_APPROVALS_FROM_EMAIL` | `KARNI_APPROVALS_FROM_EMAIL` | `""` | sender; `""` uses `DEFAULT_FROM_EMAIL` |
+
+## Escape hatches
+
+- `requires_approval` per model, and every policy knob per model
+  (`class Karni`) or project-wide (the settings above).
+- `karni_approvals.interception.bypass(reason=...)` for trusted code; no
+  current user (`karni.middleware.current_user(None)`) has the same effect.
+- `KARNI_APPROVALS_NOTIFY` replaces the notifier; `notify.checkers_for` is
+  the reusable half.
+- `services.propose`, `decide`, `apply`, `visible_to`, `sweep` are plain
+  functions: call them from your own views, commands or tasks.
+- The API viewset and the admin class are ordinary Karni classes: subclass
+  `PendingChangeViewSet` (set `auto_register = False` on it) or register
+  your own admin for `PendingChange` (explicit registrations win).
+- This module ships an explicit `admin.py` (the queue); `Decision` is not
+  registered on its own (an inline of the queue).
+
+## Limits
+
+Many-to-many changes are not part of a diff (they are written after
+`save()` and never pass through `pre_write`); hold them behind a guarded
+field or a service of your own. A change is held whole: an update touching
+a guarded and an unguarded field waits as one.

karni_approvals-0.3.1/README.md

@@ -0,0 +1,133 @@
+# karni-approvals
+
+Second-person (maker-checker) approval for high-value changes in a
+[Karni](https://github.com/cbsshekhawat18-lab/karni) project. A model opts
+in; from then on a guarded change by anyone — through the API, the admin or
+plain code — becomes a **pending change holding the diff instead of a
+write**. A checker holding the approve permission applies or rejects it,
+with a reason. The maker can never be the checker, in code.
+
+## Install
+
+```sh
+pip install karni-approvals
+karni add approvals
+karni migrate
+```
+
+`karni add approvals` adds the dependency, wires `karni_approvals` into the
+`# karni:apps` block and records this module's agent guidance. No URL
+include is needed: the API rides the auto-router. Keep the Celery worker
+running — notifications and the hourly timeout sweep are tasks.
+
+## Opt a model in
+
+```python
+from datetime import timedelta
+from karni.models import BaseModel
+
+class Invoice(BaseModel):
+    ...
+    class Karni:
+        requires_approval = ["amount", "status"]   # or True: any change, create and delete too
+        approvals_required = 2                      # default KARNI_APPROVALS_REQUIRED (1)
+        approver_roles = ["finance"]                # default KARNI_APPROVALS_APPROVER_ROLES ([])
+        approval_timeout = timedelta(hours=48)      # or hours as a number; default the setting (never)
+        approval_on_timeout = "escalate"            # or "expire" (the default)
+        approval_escalation_roles = ["cfo"]         # default KARNI_APPROVALS_ESCALATION_ROLES
+```
+
+The model must be a `karni.models.BaseModel` (every `save()` and `delete()`
+sends `karni.signals.pre_write`; that is the hook). `karni check` fails the
+build for a guarded model that is not, for a malformed policy, and for
+approver roles `KARNI_ROLES` does not declare (`APR007`).
+
+## What happens
+
+- **A guarded write is held.** When a signed-in user changes a guarded
+  field (a list) or anything at all (`True`), a `PendingChange` records the
+  whole change as `{field: [old, new]}` and the write is stopped before any
+  SQL: the API answers **202** with the pending change, the admin shows
+  "sent for approval" and returns to the list, plain code gets
+  `karni.exceptions.KarniWriteDeferred` (code `APR001`). The row is not
+  touched; the change is itself history (`karni.audit`).
+- **Writes pass through** with no current user (migrations, seeds,
+  management commands), inside the module's own apply, and inside
+  `karni_approvals.interception.bypass(reason="...")` for trusted code.
+  Bulk SQL (`QuerySet.update()`) is never seen — `karni check`'s
+  `audited-bulk-write` rule catches it on audited models.
+- **Deciding** is `karni_approvals.services.decide(pending, checker, "approve" | "reject", reason)`,
+  behind the API (`POST /api/pending-changes/{id}/approve/` and `reject/`)
+  and the admin queue. Every rule lives there, so it holds wherever a
+  decision comes from:
+  - the maker can never be the checker (`APR002`), superuser or not;
+  - a checker needs the `karni_approvals.pendingchange:approve` (or
+    `:reject`) grant and, when the model declares `approver_roles`, one of
+    those roles (`APR003`);
+  - a checker sees and decides only pending changes whose row lies inside
+    their own scope — a branch checker, their branch (`APR003`); a create
+    has no row yet and is visible to whoever may view every row of that
+    model;
+  - one decision per person (`APR004`); a decided change is final (`APR005`);
+  - the change is applied as the last approver once `approvals_required`
+    approvals are in — the row's own history then names the checker — and
+    refused as stale when any recorded old value no longer matches
+    (`APR006`, status `failed`).
+- **Timeouts.** A change past `approval_timeout` is swept hourly: `expire`
+  marks it expired; `escalate` emails the escalation roles and extends it by
+  the same timeout.
+- **Notifications.** On proposal the checkers are emailed from a Celery task
+  (`KARNI_APPROVALS_NOTIFY`, a dotted path called with the pending change;
+  `""` switches it off; replace it to post elsewhere).
+- **Audit.** `PendingChange` and `Decision` are audited models: every
+  proposal, approval and rejection is a `karni.audit` entry with its actor.
+
+## Where it shows
+
+| Surface | What |
+| --- | --- |
+| Admin → Karni approvals → Pending changes | the queue in the checker's scope, each change's diff and decisions, **Approve selected** / **Reject selected** with a reason |
+| `GET /api/pending-changes/` | the queue (filters: `status`, `action`, `content_type`, `maker`), scoped; makers with an `own` grant see their own |
+| `POST /api/pending-changes/{id}/approve/`, `…/reject/` | `{"reason": "..."}` → the updated pending change; 403 `APR002`/`APR003`, 400 for the rest |
+| `GET /api/pending-changes/count/` | `{"pending": n}` the requester may decide — the badge |
+| `@karni/approvals-ui` | `<ApprovalsBadge/>`, `<ApprovalsQueue/>`, `usePendingCount`, `usePendingChanges`, `useDecidePendingChange` |
+
+## Settings
+
+Every setting arrives through the module's settings fragment
+(`karni_approvals.conf.DEFAULTS`) and is overridable in the project's
+`settings.py` or by its environment variable; each has a per-model override
+in `class Karni`.
+
+| Setting | Env var | Default | Meaning |
+| --- | --- | --- | --- |
+| `KARNI_APPROVALS_REQUIRED` | `KARNI_APPROVALS_REQUIRED` | `1` | approvals a change needs |
+| `KARNI_APPROVALS_APPROVER_ROLES` | `KARNI_APPROVALS_APPROVER_ROLES` | `[]` | roles that may approve, on top of the grant (`[]` = any holder) |
+| `KARNI_APPROVALS_TIMEOUT_HOURS` | `KARNI_APPROVALS_TIMEOUT_HOURS` | `0` | hours before a change times out (`0` = never) |
+| `KARNI_APPROVALS_ON_TIMEOUT` | `KARNI_APPROVALS_ON_TIMEOUT` | `expire` | `expire` or `escalate` |
+| `KARNI_APPROVALS_ESCALATION_ROLES` | `KARNI_APPROVALS_ESCALATION_ROLES` | `[]` | roles emailed on escalation |
+| `KARNI_APPROVALS_NOTIFY` | `KARNI_APPROVALS_NOTIFY` | `karni_approvals.notify.email_checkers` | the notifier (`""` = off) |
+| `KARNI_APPROVALS_FROM_EMAIL` | `KARNI_APPROVALS_FROM_EMAIL` | `""` | sender; `""` uses `DEFAULT_FROM_EMAIL` |
+
+## Escape hatches
+
+- `requires_approval` per model, and every policy knob per model
+  (`class Karni`) or project-wide (the settings above).
+- `karni_approvals.interception.bypass(reason=...)` for trusted code; no
+  current user (`karni.middleware.current_user(None)`) has the same effect.
+- `KARNI_APPROVALS_NOTIFY` replaces the notifier; `notify.checkers_for` is
+  the reusable half.
+- `services.propose`, `decide`, `apply`, `visible_to`, `sweep` are plain
+  functions: call them from your own views, commands or tasks.
+- The API viewset and the admin class are ordinary Karni classes: subclass
+  `PendingChangeViewSet` (set `auto_register = False` on it) or register
+  your own admin for `PendingChange` (explicit registrations win).
+- This module ships an explicit `admin.py` (the queue); `Decision` is not
+  registered on its own (an inline of the queue).
+
+## Limits
+
+Many-to-many changes are not part of a diff (they are written after
+`save()` and never pass through `pre_write`); hold them behind a guarded
+field or a service of your own. A change is held whole: an update touching
+a guarded and an unguarded field waits as one.

karni_approvals-0.3.1/karni_approvals/AGENTS.fragment.md

@@ -0,0 +1,15 @@
+## Approvals (karni-approvals)
+- A model opts in with `class Karni: requires_approval = ["amount", "status"]`
+  (or `True` for any change, create and delete included). A guarded change by
+  a signed-in user becomes a PendingChange instead of a write: the API answers
+  202, the admin says so, code gets `KarniWriteDeferred` — never catch it to
+  write anyway; trusted scripts use `karni_approvals.interception.bypass(reason=...)`.
+- Decisions only through `karni_approvals.services.decide(pending, checker, verdict, reason)`
+  (the API's `/api/pending-changes/{id}/approve/` + `reject/`, the admin queue):
+  the maker can never be the checker, checkers need the
+  `karni_approvals.pendingchange:approve` grant (+ `approver_roles`), and see
+  only rows in their scope. Never write PendingChange/Decision rows by hand.
+- Per model: `approvals_required`, `approver_roles`, `approval_timeout`,
+  `approval_on_timeout` ("expire"|"escalate"); project defaults are the
+  `KARNI_APPROVALS_*` settings. Notifications and the hourly sweep run in Celery.
+- No URL include needed: the API rides the auto-router; `count/` is the badge.

karni_approvals-0.3.1/karni_approvals/__init__.py

@@ -0,0 +1,11 @@
+"""karni-approvals: maker-checker approvals for Karni projects.
+
+A model opts in with ``class Karni: requires_approval = [...]`` (or ``True``).
+From then on a change to those fields by anyone — through the API, the admin
+or plain code — becomes a :class:`~karni_approvals.models.PendingChange`
+holding the diff instead of a write; a second person holding the approve
+permission applies or rejects it, with a reason. The maker can never be the
+checker, in code. See the README.
+"""
+
+from __future__ import annotations