karni-storage 0.5.0__tar.gz

karni_storage-0.5.0/.gitignore

@@ -0,0 +1,44 @@
+.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/
+packages/karni-cli/karni_cli/_settings/
+packages/karni-cli/karni_cli/_catalog/
+packages/karni-cli/karni_cli/_ui/
+
+# Node
+node_modules/
+storybook-static/
+*.tsbuildinfo
+
+# Local env / editor / tooling
+.env
+.env.*
+!.env.example
+.DS_Store
+.idea/
+
+# MkDocs build output
+site/
+.github/ci/prod_e2e/test-results/
+
+# Contributors' own agent working files stay on their machines
+/CLAUDE.md
+/.claude/

karni_storage-0.5.0/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_storage-0.5.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.5
+Name: karni-storage
+Version: 0.5.0
+Summary: Protected files for Karni: files a row owns, in S3 or an S3-compatible service, served only to whoever may read that row, with direct uploads and thumbnails. Karni is an open-source Django + React framework for building with AI coding agents. Your agent writes only your domain. The API, admin, permissions and React screens come from a package you upgrade, not code it rewrites in each project. One rule set covers every coding agent. The build fails when an agent hand-writes what Karni ships.
+Project-URL: Homepage, https://github.com/cbsshekhawat18-lab/karni
+Project-URL: Documentation, https://cbsshekhawat18-lab.github.io/karni/storage/
+Project-URL: Repository, https://github.com/cbsshekhawat18-lab/karni
+Project-URL: Issues, https://github.com/cbsshekhawat18-lab/karni/issues
+Project-URL: Changelog, https://github.com/cbsshekhawat18-lab/karni/tree/main/docs/migrations
+Author-email: Chandrabhan Shekhawat <cbsshekhawat18@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: django,karni,minio,r2,react,s3,storage,uploads
+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: Topic :: Internet :: WWW/HTTP
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: karni[s3]<0.6,>=0.5
+Provides-Extra: images
+Requires-Dist: karni[images]<0.6,>=0.5; extra == 'images'
+Description-Content-Type: text/markdown
+
+# karni-storage
+
+Protected files for Karni: files a row owns, in S3 or an S3-compatible service, served only to whoever may read that row, with direct uploads and thumbnails.
+
+[![PyPI](https://img.shields.io/pypi/v/karni-storage)](https://pypi.org/project/karni-storage/) [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/cbsshekhawat18-lab/karni/blob/main/LICENSE) [![Docs](https://img.shields.io/badge/docs-online-FB5D08)](https://cbsshekhawat18-lab.github.io/karni/storage/)
+
+Files are kept in S3 or an S3-compatible service (or on disk in development) and handed only to whoever may read their row. It is **experimental**: its names may change in a minor release, with a CHANGELOG entry.
+
+The full guide is [docs/storage.md](https://cbsshekhawat18-lab.github.io/karni/storage/).
+
+## Install
+
+```bash
+pip install "karni-storage[images]"   # the images extra brings Pillow, for thumbnails
+karni add storage
+```
+
+Then add the URLs once to `config/urls.py`:
+
+```python
+path("api/", include("karni_storage.urls")),
+```
+
+and run `make migrate` (the module has one table, its thumbnails).
+
+## Use
+
+```python
+from karni_storage.fields import ProtectedFileField, ProtectedImageField
+
+
+class Product(BaseModel):
+    manual = ProtectedFileField(upload_to="products/manuals/", blank=True,
+                                max_size=5 * 1024 * 1024, content_types=["application/pdf"])
+    photo = ProtectedImageField(upload_to="products/photos/", blank=True)
+```
+
+In `karni.yaml` the same fields are `manual: "file:protected?"` and
+`photo: "image:protected?"`.
+
+The API gives `manual` as `/api/products/<id>/files/manual/`. A `GET` there
+retrieves the row through `ProductViewSet` first: 401 or 403 from its gate,
+404 for another user's row, a soft-deleted row or a missing one. Then it
+redirects to a signed URL in the bucket (`KARNI_STORAGE=s3`) or streams the
+file (`KARNI_STORAGE=local`). `?size=small` serves a thumbnail of an image.
+
+## Main features
+
+- `ProtectedFileField` and `ProtectedImageField`, downloaded only through the row's own viewset
+- Short-lived signed URLs, or the file streamed
+- One setting for the service: `aws`, `r2`, `minio`, `spaces`, `b2` or `gcs-interop`
+- Direct uploads with a presigned POST or PUT, and a confirm step before a row points at the file
+- Thumbnails made by a Celery task
+- React components in [`@karni/storage-ui`](https://www.npmjs.com/package/@karni/storage-ui)
+
+## Settings
+
+| Setting | Env | Default | Meaning |
+| --- | --- | --- | --- |
+| `KARNI_STORAGE_PROVIDER` | same | `aws` | The service: `aws`, `r2`, `minio`, `spaces`, `b2`, `gcs-interop`. Sets the endpoint, region and addressing style |
+| `KARNI_STORAGE_CREDENTIALS` | same | `keys` | `keys` (AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY) or `chain` (boto3's own: an AWS role or profile) |
+| `KARNI_STORAGE_BUCKET` | same | `""` | The bucket of protected files. Empty: `AWS_STORAGE_BUCKET_NAME` |
+| `KARNI_STORAGE_LOCATION` | same | `protected` | The key prefix inside the bucket |
+| `KARNI_STORAGE_ROOT` | same | `""` | The local directory. Empty: `protected` next to `MEDIA_ROOT` |
+| `KARNI_STORAGE_URL_EXPIRY` | same | `300` | Seconds a signed download URL lives |
+| `KARNI_STORAGE_UPLOAD_EXPIRY` | same | `900` | Seconds a presigned upload lives |
+| `KARNI_STORAGE_UPLOAD_METHOD` | same | `""` | `post` or `put`. Empty: the preset's |
+| `KARNI_STORAGE_MAX_SIZE` | same | `10485760` | The size limit of a field without `max_size` |
+| `KARNI_STORAGE_THUMBNAIL_SIZES` | same (JSON) | `{"small": [160, 160], "medium": [640, 640]}` | Thumbnail names and bounding boxes |
+| `KARNI_STORAGE_THUMBNAIL_FORMAT` | same | `WEBP` | The thumbnails' format |
+| `KARNI_STORAGE_THROTTLE_RATES` | same (JSON) | `{"download": "1000/hour", "upload": "120/hour", "confirm": "120/hour"}` | Rate limits per caller, scopes `storage.download`, `storage.upload`, `storage.confirm`. A rate under the scope in `REST_FRAMEWORK["DEFAULT_THROTTLE_RATES"]` wins |
+| `KARNI_STORAGE_ALIAS` | same | `protected` | A `STORAGES` alias that, when defined, replaces the module's storage |
+| `R2_ACCOUNT_ID` | same | `""` | Cloudflare R2's account id (the `r2` preset builds its endpoint from it) |
+
+Credentials stay in the environment: `AWS_ACCESS_KEY_ID`,
+`AWS_SECRET_ACCESS_KEY`, `AWS_STORAGE_BUCKET_NAME`, `AWS_S3_REGION_NAME` and,
+for R2, `R2_ACCOUNT_ID`. `karni check` fails (STORE001 to STORE006) on an
+unknown preset, missing credentials, a missing region, account id, endpoint
+or bucket, and a missing URL include.
+
+## Escape hatches
+
+- `STORAGES["protected"]` replaces the module's storage with any backend.
+- `AWS_S3_ENDPOINT_URL` wins over a preset's endpoint, `AWS_S3_ADDRESSING_STYLE`
+  over its addressing style, `KARNI_STORAGE_UPLOAD_METHOD` over its upload method.
+- `storage=` on one field, `thumbnails=False` on an image field.
+- `KARNI_THUMBNAILER` (core) replaces the thumbnail rendering.
+- The row's viewset decides who may download and upload: its `access`.
+- A `path()` of your own before the include replaces one endpoint.
+
+## Admin
+
+No `admin.py`: the thumbnails' admin is derived from `AdminMeta`.
+
+## Links
+
+- Protected files: <https://cbsshekhawat18-lab.github.io/karni/storage/>
+- React components: <https://www.npmjs.com/package/@karni/storage-ui>
+- Karni, the framework this package is part of: <https://github.com/cbsshekhawat18-lab/karni>
+- Changelog: <https://github.com/cbsshekhawat18-lab/karni/blob/main/CHANGELOG.md>
+- Issues: <https://github.com/cbsshekhawat18-lab/karni/issues>
+- License: Apache-2.0. karni-storage is released with every other Karni package, at one version.

karni_storage-0.5.0/README.md

@@ -0,0 +1,102 @@
+# karni-storage
+
+Protected files for Karni: files a row owns, in S3 or an S3-compatible service, served only to whoever may read that row, with direct uploads and thumbnails.
+
+[![PyPI](https://img.shields.io/pypi/v/karni-storage)](https://pypi.org/project/karni-storage/) [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/cbsshekhawat18-lab/karni/blob/main/LICENSE) [![Docs](https://img.shields.io/badge/docs-online-FB5D08)](https://cbsshekhawat18-lab.github.io/karni/storage/)
+
+Files are kept in S3 or an S3-compatible service (or on disk in development) and handed only to whoever may read their row. It is **experimental**: its names may change in a minor release, with a CHANGELOG entry.
+
+The full guide is [docs/storage.md](https://cbsshekhawat18-lab.github.io/karni/storage/).
+
+## Install
+
+```bash
+pip install "karni-storage[images]"   # the images extra brings Pillow, for thumbnails
+karni add storage
+```
+
+Then add the URLs once to `config/urls.py`:
+
+```python
+path("api/", include("karni_storage.urls")),
+```
+
+and run `make migrate` (the module has one table, its thumbnails).
+
+## Use
+
+```python
+from karni_storage.fields import ProtectedFileField, ProtectedImageField
+
+
+class Product(BaseModel):
+    manual = ProtectedFileField(upload_to="products/manuals/", blank=True,
+                                max_size=5 * 1024 * 1024, content_types=["application/pdf"])
+    photo = ProtectedImageField(upload_to="products/photos/", blank=True)
+```
+
+In `karni.yaml` the same fields are `manual: "file:protected?"` and
+`photo: "image:protected?"`.
+
+The API gives `manual` as `/api/products/<id>/files/manual/`. A `GET` there
+retrieves the row through `ProductViewSet` first: 401 or 403 from its gate,
+404 for another user's row, a soft-deleted row or a missing one. Then it
+redirects to a signed URL in the bucket (`KARNI_STORAGE=s3`) or streams the
+file (`KARNI_STORAGE=local`). `?size=small` serves a thumbnail of an image.
+
+## Main features
+
+- `ProtectedFileField` and `ProtectedImageField`, downloaded only through the row's own viewset
+- Short-lived signed URLs, or the file streamed
+- One setting for the service: `aws`, `r2`, `minio`, `spaces`, `b2` or `gcs-interop`
+- Direct uploads with a presigned POST or PUT, and a confirm step before a row points at the file
+- Thumbnails made by a Celery task
+- React components in [`@karni/storage-ui`](https://www.npmjs.com/package/@karni/storage-ui)
+
+## Settings
+
+| Setting | Env | Default | Meaning |
+| --- | --- | --- | --- |
+| `KARNI_STORAGE_PROVIDER` | same | `aws` | The service: `aws`, `r2`, `minio`, `spaces`, `b2`, `gcs-interop`. Sets the endpoint, region and addressing style |
+| `KARNI_STORAGE_CREDENTIALS` | same | `keys` | `keys` (AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY) or `chain` (boto3's own: an AWS role or profile) |
+| `KARNI_STORAGE_BUCKET` | same | `""` | The bucket of protected files. Empty: `AWS_STORAGE_BUCKET_NAME` |
+| `KARNI_STORAGE_LOCATION` | same | `protected` | The key prefix inside the bucket |
+| `KARNI_STORAGE_ROOT` | same | `""` | The local directory. Empty: `protected` next to `MEDIA_ROOT` |
+| `KARNI_STORAGE_URL_EXPIRY` | same | `300` | Seconds a signed download URL lives |
+| `KARNI_STORAGE_UPLOAD_EXPIRY` | same | `900` | Seconds a presigned upload lives |
+| `KARNI_STORAGE_UPLOAD_METHOD` | same | `""` | `post` or `put`. Empty: the preset's |
+| `KARNI_STORAGE_MAX_SIZE` | same | `10485760` | The size limit of a field without `max_size` |
+| `KARNI_STORAGE_THUMBNAIL_SIZES` | same (JSON) | `{"small": [160, 160], "medium": [640, 640]}` | Thumbnail names and bounding boxes |
+| `KARNI_STORAGE_THUMBNAIL_FORMAT` | same | `WEBP` | The thumbnails' format |
+| `KARNI_STORAGE_THROTTLE_RATES` | same (JSON) | `{"download": "1000/hour", "upload": "120/hour", "confirm": "120/hour"}` | Rate limits per caller, scopes `storage.download`, `storage.upload`, `storage.confirm`. A rate under the scope in `REST_FRAMEWORK["DEFAULT_THROTTLE_RATES"]` wins |
+| `KARNI_STORAGE_ALIAS` | same | `protected` | A `STORAGES` alias that, when defined, replaces the module's storage |
+| `R2_ACCOUNT_ID` | same | `""` | Cloudflare R2's account id (the `r2` preset builds its endpoint from it) |
+
+Credentials stay in the environment: `AWS_ACCESS_KEY_ID`,
+`AWS_SECRET_ACCESS_KEY`, `AWS_STORAGE_BUCKET_NAME`, `AWS_S3_REGION_NAME` and,
+for R2, `R2_ACCOUNT_ID`. `karni check` fails (STORE001 to STORE006) on an
+unknown preset, missing credentials, a missing region, account id, endpoint
+or bucket, and a missing URL include.
+
+## Escape hatches
+
+- `STORAGES["protected"]` replaces the module's storage with any backend.
+- `AWS_S3_ENDPOINT_URL` wins over a preset's endpoint, `AWS_S3_ADDRESSING_STYLE`
+  over its addressing style, `KARNI_STORAGE_UPLOAD_METHOD` over its upload method.
+- `storage=` on one field, `thumbnails=False` on an image field.
+- `KARNI_THUMBNAILER` (core) replaces the thumbnail rendering.
+- The row's viewset decides who may download and upload: its `access`.
+- A `path()` of your own before the include replaces one endpoint.
+
+## Admin
+
+No `admin.py`: the thumbnails' admin is derived from `AdminMeta`.
+
+## Links
+
+- Protected files: <https://cbsshekhawat18-lab.github.io/karni/storage/>
+- React components: <https://www.npmjs.com/package/@karni/storage-ui>
+- Karni, the framework this package is part of: <https://github.com/cbsshekhawat18-lab/karni>
+- Changelog: <https://github.com/cbsshekhawat18-lab/karni/blob/main/CHANGELOG.md>
+- Issues: <https://github.com/cbsshekhawat18-lab/karni/issues>
+- License: Apache-2.0. karni-storage is released with every other Karni package, at one version.

karni_storage-0.5.0/karni_storage/AGENTS.fragment.md

@@ -0,0 +1,14 @@
+## Protected files (karni-storage)
+- A file only the row's readers may download: `ProtectedFileField` /
+  `ProtectedImageField` from `karni_storage.fields` (karni.yaml: `file:protected`,
+  `image:protected`). Never hand-write download views, presigned URLs or boto3 calls.
+- The API gives the field as its download path, `<resource>/<id>/files/<field>/`:
+  the row is retrieved through its own viewset first, then a signed URL (bucket)
+  or a stream (local storage). `?size=<name>` serves a thumbnail.
+- Wire the URLs once in config/urls.py: `path("api/", include("karni_storage.urls"))`
+- Direct uploads: `@karni/storage-ui`'s `ProtectedFileInput` in ResourceForm
+  (`fields={{ photo: { component: ProtectedFileInput, props: { resource } } }}`).
+- KARNI_STORAGE=local in development, s3 in production. KARNI_STORAGE_PROVIDER
+  (aws|r2|minio|spaces|b2|gcs-interop) sets the endpoint. Credentials stay in .env:
+  AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_STORAGE_BUCKET_NAME,
+  AWS_S3_REGION_NAME, R2_ACCOUNT_ID. Thumbnails run in Celery.

karni_storage-0.5.0/karni_storage/__init__.py

@@ -0,0 +1,21 @@
+"""karni-storage: protected files in S3 or an S3-compatible service.
+
+Files a row owns, kept in a private bucket (or a private directory in
+development) and handed only to whoever may read the row, through the row's
+own viewset: :mod:`karni_storage.fields` (``ProtectedFileField``,
+``ProtectedImageField``), provider presets for core's S3 backend
+(:mod:`karni_storage.presets`), direct uploads with a confirm step
+(:mod:`karni_storage.views`) and thumbnails (:mod:`karni_storage.thumbnails`).
+
+Experimental: every public name here may change in a minor release, with a
+CHANGELOG entry (docs/stability.md).
+"""
+
+from __future__ import annotations
+
+from importlib import metadata as _metadata
+
+try:
+    __version__ = _metadata.version("karni-storage")  # [project] version in pyproject.toml
+except _metadata.PackageNotFoundError:  # a source tree on sys.path, never installed
+    __version__ = "0+unknown"

karni_storage-0.5.0/karni_storage/access.py

@@ -0,0 +1,150 @@
+"""Who may read or upload a protected file: whoever the row's own viewset lets through.
+
+Every endpoint of the module starts here. :func:`resolve` finds the viewset
+the API serves at ``<resource>`` and the protected field it names.
+:func:`retrieve` then runs that viewset's ``retrieve`` checks for one row
+without serializing it: its gate (``check_permissions``, so 401 or 403 as its
+own ``retrieve`` answers) and its ``get_object()``, which looks the row up
+through the read scope (404 for a row out of the caller's scope, a
+soft-deleted row and a row that does not exist). :func:`may_upload` asks the
+same viewset whether the caller may create or change rows. A field that
+``Karni.field_roles`` hides from the caller is a 404, and one it may not
+write refuses uploads.
+
+Override / escape hatch: the viewset decides, so its ``access`` declaration,
+``get_queryset`` and permission classes are the knobs. ``auto_register =
+False`` on a viewset keeps its files off the API too.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+from django.core.exceptions import FieldDoesNotExist
+from rest_framework.exceptions import APIException, NotFound, PermissionDenied
+
+from karni_storage.errorcodes import coded
+from karni_storage.fields import ProtectedFieldMixin
+
+__all__ = ["Target", "may_upload", "resolve", "retrieve", "route_for_model"]
+
+
+@dataclass(frozen=True)
+class Target:
+    """Experimental. A resource of the API and one of its protected fields."""
+
+    resource: str
+    viewset: type[Any]
+    model: type[Any]
+    #: A ProtectedFileField or ProtectedImageField.
+    field: Any
+
+
+def _registry() -> list[tuple[str, type[Any], str]]:
+    from karni.api.routers import resolve_router
+
+    router = resolve_router()
+    return list(getattr(router, "registry", None) or [])
+
+
+def route_for_model(model: type[Any]) -> str | None:
+    """Experimental. The API prefix the first viewset serving ``model`` is routed at."""
+    from karni.api.routers import serves_model
+
+    for prefix, viewset, _basename in _registry():
+        if serves_model(viewset, model):
+            return str(prefix)
+    return None
+
+
+def _served_model(viewset: type[Any]) -> type[Any] | None:
+    served = getattr(viewset, "model", None)
+    if served is None:
+        served = getattr(getattr(viewset, "queryset", None), "model", None)
+    return served
+
+
+def _not_found(message: str) -> NotFound:
+    return NotFound(coded("STORE010", message), code="STORE010")
+
+
+def resolve(resource: str, field: str) -> Target:
+    """Experimental. The viewset at ``resource`` and its protected field ``field``.
+
+    :raises rest_framework.exceptions.NotFound: ``STORE010`` when no viewset is
+        routed at ``resource`` or ``field`` is not one of its model's protected fields.
+    """
+    for prefix, viewset, _basename in _registry():
+        if prefix != resource:
+            continue
+        model = _served_model(viewset)
+        try:
+            found = model._meta.get_field(field) if model is not None else None
+        except FieldDoesNotExist:
+            found = None
+        if model is not None and isinstance(found, ProtectedFieldMixin):
+            return Target(resource, viewset, model, found)
+        break
+    raise _not_found(f"{resource}/ has no protected file field {field!r}.")
+
+
+def _view(target: Target, request: Any, action: str, pk: str | None = None) -> Any:
+    view = target.viewset()
+    view.request = request
+    view.args = ()
+    view.kwargs = {} if pk is None else {view.lookup_url_kwarg or view.lookup_field: str(pk)}
+    view.format_kwarg = None
+    view.action = action
+    view.action_map = {"get": action} if pk is not None else {"post": action}
+    view.detail = pk is not None
+    return view
+
+
+def _hidden(target: Target, request: Any) -> bool:
+    from karni.accounts.visibility import hidden_fields
+
+    return target.field.name in hidden_fields(target.model, request.user)
+
+
+def retrieve(target: Target, request: Any, pk: str) -> Any:
+    """Experimental. The row ``pk`` exactly as the viewset's ``retrieve`` finds it for ``request``.
+
+    :raises rest_framework.exceptions.NotAuthenticated: or ``PermissionDenied``
+        when the viewset's gate refuses the caller.
+    :raises django.http.Http404: when the row does not exist or is out of the
+        caller's read scope, or the field is hidden from the caller.
+    """
+    view = _view(target, request, "retrieve", pk)
+    view.check_permissions(request)
+    row = view.get_object()
+    if _hidden(target, request):
+        raise _not_found(f"{target.resource}/ has no protected file field {target.field.name!r}.")
+    return row
+
+
+def may_upload(target: Target, request: Any) -> None:
+    """Experimental. Refuse unless the caller may create or change rows of ``target``.
+
+    The viewset's gate for ``create`` is asked first, then for
+    ``partial_update``: a caller allowed either may upload. The row-level
+    check of a change still runs when the row is saved.
+
+    :raises rest_framework.exceptions.NotAuthenticated: or ``PermissionDenied``.
+    """
+    from karni.accounts.visibility import protected_fields
+
+    refusal: APIException | None = None
+    for action in ("create", "partial_update"):
+        view = _view(target, request, action)
+        try:
+            view.check_permissions(request)
+        except APIException as exc:  # NotAuthenticated, PermissionDenied: ask the next action
+            refusal = refusal or exc
+            continue
+        if _hidden(target, request) or target.field.name in protected_fields(
+            target.model, request.user
+        ):
+            raise PermissionDenied(f"You may not change {target.field.name}.")
+        return
+    raise refusal or PermissionDenied()