dj-bucket 0.1.2__tar.gz

dj_bucket-0.1.2/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2026 Gandi SAS
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

dj_bucket-0.1.2/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: dj-bucket
+Version: 0.1.2
+Summary: Use your database as a S3 storage
+Author-Email: Benjamin Hirschfield <me@bennybarry.com>
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: <4,>=3.11
+Requires-Dist: django<6.0,>=4.1
+Description-Content-Type: text/markdown
+
+# dj-bucket
+
+Store blobs into a database table.
+
+## Setup
+
+In your configuration add the dj-bucket app to the installed apps:
+
+```python
+INSTALLED_APPS: = [
+    "dj_bucket",
+]
+
+BUCKET_PATH = "bucket/"
+```
+
+Then make sure a database backend is setup, for testing you can use the SQLite:
+
+```python
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+```
+
+Run the Django database migrations to create the table that will store the
+blobs.

dj_bucket-0.1.2/README.md

@@ -0,0 +1,29 @@
+# dj-bucket
+
+Store blobs into a database table.
+
+## Setup
+
+In your configuration add the dj-bucket app to the installed apps:
+
+```python
+INSTALLED_APPS: = [
+    "dj_bucket",
+]
+
+BUCKET_PATH = "bucket/"
+```
+
+Then make sure a database backend is setup, for testing you can use the SQLite:
+
+```python
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+```
+
+Run the Django database migrations to create the table that will store the
+blobs.

dj_bucket-0.1.2/dj_bucket/__init__.py

@@ -0,0 +1,6 @@
+"""A django application made to do django media storage using postgresql."""
+
+from importlib.metadata import version
+
+__version__ = version("dj-bucket")
+__all__ = ["__version__"]

dj_bucket-0.1.2/dj_bucket/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class DjBucketConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "dj_bucket"

dj_bucket-0.1.2/dj_bucket/migrations/0001_initial.py

@@ -0,0 +1,32 @@
+# Generated by Django 4.2.29 on 2026-04-07 08:39
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="BucketItem",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("raw", models.BinaryField(help_text="Raw bytes representing the file")),
+                ("path", models.CharField(max_length=255, unique=True)),
+                ("mimetype", models.CharField(max_length=64)),
+                ("accessed_at", models.DateTimeField()),
+                ("created_at", models.DateTimeField()),
+                ("modified_at", models.DateTimeField()),
+            ],
+        ),
+    ]

dj_bucket-0.1.2/dj_bucket/models.py

@@ -0,0 +1,133 @@
+import mimetypes
+from datetime import datetime
+from io import BytesIO, StringIO
+from urllib.parse import urljoin
+
+from django.core.files import File
+from django.core.files.storage import Storage
+from django.db import models
+from django.utils.deconstruct import deconstructible
+from django.utils.encoding import filepath_to_uri
+from django.utils.timezone import now
+
+from .settings import BUCKET_PATH
+
+
+class BucketItem(models.Model):
+    app_label = "dj_bucket"
+
+    raw = models.BinaryField()
+    path = models.CharField(max_length=255, unique=True)
+    mimetype = models.CharField(max_length=64)
+    accessed_at = models.DateTimeField()
+    created_at = models.DateTimeField()
+    modified_at = models.DateTimeField()
+
+
+@deconstructible(path="dj_bucket.infrastructure.dj_bucket.models.Bucket")
+class Bucket(Storage):
+    def _open(self, name: str, mode: str) -> StringIO | BytesIO:
+        # Figure out if mode should be handled
+        if mode.startswith("w"):
+            if "b" in mode:
+                return BytesIO()
+            return StringIO()
+        elif mode.startswith("r"):
+            item = BucketItem.objects.filter(path=name).first()
+            if not item:
+                raise FileNotFoundError(f"No such file: {name}")
+            if "b" in mode:
+                return BytesIO(item.raw)
+        return StringIO(item.raw.decode("utf-8"))
+
+    def _save(self, name: str, content: File) -> str:
+        raw = content.read()
+        content_type, _ = mimetypes.guess_type(name)
+        current_dt = now()
+        _, created = BucketItem.objects.update_or_create(
+            path=name,
+            defaults={
+                "path": name,
+                "raw": raw,
+                "mimetype": content_type,
+                "accessed_at": current_dt,
+                "created_at": current_dt,
+                "modified_at": current_dt,
+            },
+        )
+        if not created:
+            raise ValueError(f"Could not save upload '{name}' ({content_type})")
+        return name
+
+    def delete(self, name: str) -> None:
+        """
+        Delete the specified file from the storage system.
+        """
+        BucketItem.objects.filter(path=name).delete()
+
+    @property
+    def base_url(self) -> str:
+        return f"/{BUCKET_PATH}"
+
+    def exists(self, name: str) -> bool:
+        """
+        Return True if a file referenced by the given name already exists in the
+        storage system, or False if the name is available for a new file.
+        """
+        return bool(BucketItem.objects.filter(path=name).count())
+
+    def size(self, name: str) -> int:
+        """
+        Return the total size, in bytes, of the file specified by name.
+        """
+        item = (
+            BucketItem.objects.annotate(
+                raw_length=models.Func("raw", function="OCTET_LENGTH")
+            )
+            .values("raw_length")
+            .first()
+        )
+        if item:
+            return item["raw_length"]
+        raise FileNotFoundError(f"No such file: {name}")
+
+    def url(self, name: str) -> str:
+        """
+        Return an absolute URL where the file's contents can be accessed
+        directly by a web browser.
+        """
+        item = BucketItem.objects.filter(path=name).first()
+        if item:
+            url = filepath_to_uri(item.path)
+            return urljoin(self.base_url, url)
+        raise FileNotFoundError(f"No such file: {name}")
+
+    def get_accessed_time(self, name: str) -> datetime:
+        """
+        Return the last accessed time (as a datetime) of the file specified by
+        name. The datetime will be timezone-aware if USE_TZ=True.
+        """
+        item = BucketItem.objects.filter(path=name).first()
+        if item:
+            return item.accessed_at
+        raise FileNotFoundError(f"No such file: {name}")
+
+    def get_created_time(self, name: str) -> datetime:
+        """
+        Return the creation time (as a datetime) of the file specified by name.
+        The datetime will be timezone-aware if USE_TZ=True.
+        """
+        item = BucketItem.objects.filter(path=name).first()
+        if item:
+            return item.created_at
+        raise FileNotFoundError(f"No such file: {name}")
+
+    def get_modified_time(self, name: str) -> datetime:
+        """
+        Return the last modified time (as a datetime) of the file specified by
+        name. The datetime will be timezone-aware if USE_TZ=True.
+        """
+        item = BucketItem.objects.filter(path=name).first()
+        if item:
+            return item.modified_at
+        raise FileNotFoundError(f"No such file: {name}")

dj_bucket-0.1.2/dj_bucket/settings.py

@@ -0,0 +1 @@
+BUCKET_PATH = "bucket/"

dj_bucket-0.1.2/dj_bucket/urls.py

@@ -0,0 +1,12 @@
+from django.urls import re_path
+
+from .settings import BUCKET_PATH
+from .views import dj_bucket
+
+urlpatterns = [
+    re_path(
+        f"^{BUCKET_PATH}/(?P<name>.+)/?$",
+        dj_bucket,
+        name="dj_bucket",
+    )
+]

dj_bucket-0.1.2/dj_bucket/views.py

@@ -0,0 +1,17 @@
+from io import BytesIO
+from pathlib import Path
+
+from django.http import (
+    FileResponse,
+    Http404,
+    HttpRequest,
+)
+
+from .models import BucketItem
+
+
+def dj_bucket(request: HttpRequest, name: str) -> FileResponse:
+    item = BucketItem.objects.filter(path=name).first()
+    if item:
+        return FileResponse(BytesIO(item.raw), filename=Path(name).name)
+    raise Http404

dj_bucket-0.1.2/pyproject.toml

@@ -0,0 +1,67 @@
+[project]
+name = "dj-bucket"
+version = "0.1.2"
+authors = [
+    { name = "Benjamin Hirschfield", email = "me@bennybarry.com" },
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Django",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Internet :: WWW/HTTP",
+]
+description = "Use your database as a S3 storage"
+requires-python = ">=3.11,<4"
+readme = "README.md"
+dependencies = [
+    "django >=4.1,<6.0",
+]
+
+[project.license]
+text = "MIT"
+
+[dependency-groups]
+dev = [
+    "mypy >=2.3.1,<3",
+    "pytest >=9.1.1,<10",
+    "pytest-cov >=7.1.0,<8",
+    "pytest-django >=4.14.0,<5",
+    "ruff >=0.15.18,<1",
+]
+
+[tool.pyright]
+typeCheckingMode = "basic"
+
+[tool.ruff]
+line-length = 88
+target-version = "py312"
+extend-exclude = [
+    "dj_bucket/migrations",
+]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "tests.settings"
+
+[tool.mypy]
+ignore_missing_imports = true
+exclude = "migrations/"
+
+[[tool.mypy.overrides]]
+module = "dj_bucket.*"
+disallow_any_generics = true
+disallow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = [
+    "django.*",
+    "wagtail.*",
+]
+ignore_missing_imports = true
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"

dj_bucket-0.1.2/tests/settings.py

@@ -0,0 +1,34 @@
+"""
+Django settings for tests project.
+
+Generated by 'django-admin startproject' using Django 5.2.17.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+# Application definition
+
+INSTALLED_APPS: list[str] = [
+    "dj_bucket",
+]
+
+# Database
+# https://docs.djangoproject.com/en/5.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+BUCKET_PATH = "bucket/"

dj_bucket-0.1.2/tests/test_dj_bucket.py

@@ -0,0 +1,58 @@
+from io import BytesIO
+
+from django.test import TestCase
+
+from dj_bucket.models import Bucket, BucketItem
+
+
+class DjBucketTestCase(TestCase):
+    @classmethod
+    def setUpTestData(cls) -> None:
+        cls.text = b"Hello World"
+        cls.red_pixel = (
+            b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00"
+            b"\x00\x01\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\t"
+            b"pHYs\x00\x00.#\x00\x00.#\x01x\xa5?v\x00\x00\x00\rIDAT\x08[c"
+            b"\xf8\xcf\xc0\xf0\x1f\x00\x05\x00\x01\xff"
+            b"\x17Qp\x06\x00\x00\x00\x00IEND\xaeB`\x82"
+        )
+
+    def test_upload_text(self):
+        file_path = "file.txt"
+        storage = Bucket()
+        fd = BytesIO(self.text)
+
+        name = storage.save(file_path, fd)
+        self.assertEqual(file_path, name)
+
+        fd = storage.open(name)
+        self.assertEqual(self.text, fd.read())
+        self.assertTrue(storage.exists(file_path))
+
+        model = BucketItem.objects.first()
+        self.assertIsNotNone(model)
+        self.assertEqual(model.raw, self.text)  # type: ignore
+        self.assertEqual(model.mimetype, "text/plain")  # type: ignore
+        self.assertEqual(storage.size(name), len(self.text))
+
+        self.assertEqual("/bucket/file.txt", storage.url(name))
+
+    def test_upload_blob(self):
+        file_path = "images/red_pixel.png"
+        storage = Bucket()
+        fd = BytesIO(self.red_pixel)
+
+        name = storage.save(file_path, fd)
+        self.assertEqual(file_path, name)
+
+        fd = storage.open(name)
+        self.assertEqual(self.red_pixel, fd.read())
+        self.assertTrue(storage.exists(file_path))
+
+        model = BucketItem.objects.first()
+        self.assertIsNotNone(model)
+        self.assertEqual(model.raw, self.red_pixel)  # type: ignore
+        self.assertEqual(model.mimetype, "image/png")  # type: ignore
+        self.assertEqual(storage.size(name), len(self.red_pixel))
+
+        self.assertEqual("/bucket/images/red_pixel.png", storage.url(name))