django-capo-s3 0.0.1__tar.gz

django_capo_s3-0.0.1/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

django_capo_s3-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dmitrii Anfimov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_capo_s3-0.0.1/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.5
+Name: django-capo-s3
+Version: 0.0.1
+Summary: Support for S3 storage backend in Django
+Project-URL: Documentation, https://github.com/danfimov/django-capo-s3
+Project-URL: Repository, https://github.com/danfimov/django-capo-s3
+Project-URL: Changelog, https://github.com/danfimov/django-capo-s3/releases
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Django :: 6.1
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Requires-Dist: capo-s3>=0.11.0
+Requires-Dist: cryptography>=50.0.0
+Requires-Dist: django>=5.2
+Description-Content-Type: text/markdown
+
+# django-capo-s3
+
+A Django file storage backend for S3-compatible object stores, built on the [capo-s3](https://pypi.org/project/capo-s3/)
+client instead of boto3 — a drop-in alternative to `django-storages[s3]`.
+
+## Features
+
+- **Media and static storages** — `S3Storage` for media, plus `S3StaticStorage` (plain) and `S3ManifestStaticStorage`
+  (content-hashed names + `staticfiles.json` manifest for cache-busting) for `collectstatic`. The manifest can live in
+  the bucket or in a separate storage.
+- **URLs** — presigned URLs by default (with per-call `expire` and response overrides like `response_content_disposition`),
+  unsigned public URLs, or CloudFront-signed URLs for a custom domain.
+- **Uploads** — streaming single-`PUT` uploads that automatically switch to a concurrent multipart transfer above a
+  configurable threshold.
+- **Transparent gzip** — eligible content types are stored compressed and decompressed on read.
+- **Server-side encryption, storage class, cache-control, metadata, ...** — via `object_parameters`, passed straight
+  through to the underlying request.
+- **Flexible networking options** — custom endpoint (e.g. MinIO), path- or virtual-host addressing, TLS verification and
+  custom CA  bundles, connection timeouts, pool size, HTTP/HTTPS/SOCKS5 proxies, and retry attempts.
+- **Fully typed** — this is already the bare minimum for new packages.
+
+## Installation
+
+```bash
+uv add django-capo-s3   # or: pip install django-capo-s3
+```
+
+## Configuration
+
+Register the backend in Django's `STORAGES` setting; everything under `OPTIONS` is passed to the backend:
+
+```python
+STORAGES = {
+    "default": {
+        "BACKEND": "django_capo_s3.S3Storage",
+        "OPTIONS": {
+            "bucket": "my-bucket",
+            "region": "eu-central-1",
+            "location": "media",
+        },
+    },
+    "staticfiles": {
+        "BACKEND": "django_capo_s3.S3ManifestStaticStorage",
+        "OPTIONS": {"bucket": "my-bucket", "location": "static"},
+    },
+}
+```
+
+## Usage
+
+### On a model field
+
+Most apps never touch storage directly. With `STORAGES["default"]` configured (above), `FileField` /
+`ImageField` just work — uploads, `.url`, `.size`, and `.open()` all go through the backend.
+
+```python
+from django.db import models
+
+class Report(models.Model):
+    csv = models.FileField(upload_to="reports/")
+
+report = Report.objects.create(csv=uploaded_file)
+report.csv.url            # presigned URL to the object
+report.csv.size           # size in bytes
+report.csv.open().read()  # file contents
+```
+
+### Direct storage access
+
+Grab the configured default storage from the registry and use the `Storage` API directly.
+
+```python
+from django.core.files.base import ContentFile
+from django.core.files.storage import storages
+
+storage = storages["default"]
+name = storage.save("reports/june.csv", ContentFile(b"col1,col2\n"))  # returns the stored name
+storage.exists(name)          # True
+storage.size(name)            # size in bytes
+with storage.open(name) as f:
+    data = f.read()
+storage.delete(name)          # no error if it's already gone
+```
+
+### Download URLs
+
+`url()` is presigned by default. Override the lifetime per call, or add response headers — for example, to
+force a browser "Save as" with a filename.
+
+```python
+storage.url("reports/june.csv")                # presigned, default lifetime (url_expire)
+storage.url("reports/june.csv", expire=60)     # presigned, valid for 60 seconds
+storage.url(
+    "reports/june.csv",
+    parameters={"response_content_disposition": 'attachment; filename="june.csv"'},
+)
+```
+
+For a public bucket, set `"querystring_auth": False` in `OPTIONS` to get plain, cacheable URLs instead.
+
+### Static files with cache-busting
+
+Point `STORAGES["staticfiles"]` at `S3ManifestStaticStorage`. `collectstatic` then stores each file under a
+content-hashed name and `{% static %}` resolves through the manifest, so assets can be served with
+long-lived caching. Keep the manifest local so web workers don't fetch it from S3 on startup.
+
+```python
+from django.core.files.storage import FileSystemStorage
+
+STORAGES["staticfiles"] = {
+    "BACKEND": "django_capo_s3.S3ManifestStaticStorage",
+    "OPTIONS": {
+        "bucket": "my-bucket",
+        "location": "static",
+        "manifest_storage": FileSystemStorage(location=BASE_DIR / ".static-manifest"),
+    },
+}
+```
+
+### Serving through a CDN (CloudFront)
+
+Set `custom_domain` for plain CDN URLs, or add a CloudFront key pair to sign them for a private
+distribution.
+
+```python
+"OPTIONS": {
+    "bucket": "my-bucket",
+    "custom_domain": "d123.cloudfront.net",
+    "cloudfront_key": cloudfront_private_key_pem,  # PEM contents
+    "cloudfront_key_id": "K1ABCDEF",
+    "url_expire": 300,
+}
+# storage.url(name) -> https://d123.cloudfront.net/...?Expires=...&Signature=...&Key-Pair-Id=...
+```
+
+### Large uploads and gzip
+
+Uploads switch to a concurrent multipart transfer above `multipart_threshold`; text assets can be stored
+gzip-compressed and are transparently decompressed on read.
+
+```python
+"OPTIONS": {
+    "bucket": "my-bucket",
+    "multipart_threshold": 32 * 1024 * 1024,  # start multipart at 32 MiB
+    "multipart_chunksize": 16 * 1024 * 1024,
+    "multipart_concurrency": 8,               # parts uploaded in parallel
+    "gzip": True,                             # compress CSS/JS/JSON/... at rest
+}
+```
+
+### Encryption, storage class, and other object metadata
+
+Whatever `object_parameters` contains is passed straight to each upload — e.g. SSE-KMS plus a storage class
+and cache header.
+
+```python
+"OPTIONS": {
+    "bucket": "my-bucket",
+    "default_acl": "private",
+    "object_parameters": {
+        "server_side_encryption": "aws:kms",
+        "ssekms_key_id": "arn:aws:kms:eu-central-1:123456789012:key/abcd-...",
+        "storage_class": "STANDARD_IA",
+        "cache_control": "max-age=86400",
+    },
+}
+```
+
+### Networking (endpoint tuning, proxies)
+
+Tune timeouts, the connection pool, retries, TLS verification, and proxies as needed.
+
+```python
+"OPTIONS": {
+    "bucket": "my-bucket",
+    "connect_timeout": 5.0,
+    "read_timeout": 30.0,
+    "max_connections_per_host": 50,
+    "retry_max_attempts": 5,
+    "verify": "/etc/ssl/certs/internal-ca.pem",   # or False to disable TLS verification
+    "proxies": {"https": "http://proxy.internal:8080"},
+}
+```

django_capo_s3-0.0.1/README.md

@@ -0,0 +1,183 @@
+# django-capo-s3
+
+A Django file storage backend for S3-compatible object stores, built on the [capo-s3](https://pypi.org/project/capo-s3/)
+client instead of boto3 — a drop-in alternative to `django-storages[s3]`.
+
+## Features
+
+- **Media and static storages** — `S3Storage` for media, plus `S3StaticStorage` (plain) and `S3ManifestStaticStorage`
+  (content-hashed names + `staticfiles.json` manifest for cache-busting) for `collectstatic`. The manifest can live in
+  the bucket or in a separate storage.
+- **URLs** — presigned URLs by default (with per-call `expire` and response overrides like `response_content_disposition`),
+  unsigned public URLs, or CloudFront-signed URLs for a custom domain.
+- **Uploads** — streaming single-`PUT` uploads that automatically switch to a concurrent multipart transfer above a
+  configurable threshold.
+- **Transparent gzip** — eligible content types are stored compressed and decompressed on read.
+- **Server-side encryption, storage class, cache-control, metadata, ...** — via `object_parameters`, passed straight
+  through to the underlying request.
+- **Flexible networking options** — custom endpoint (e.g. MinIO), path- or virtual-host addressing, TLS verification and
+  custom CA  bundles, connection timeouts, pool size, HTTP/HTTPS/SOCKS5 proxies, and retry attempts.
+- **Fully typed** — this is already the bare minimum for new packages.
+
+## Installation
+
+```bash
+uv add django-capo-s3   # or: pip install django-capo-s3
+```
+
+## Configuration
+
+Register the backend in Django's `STORAGES` setting; everything under `OPTIONS` is passed to the backend:
+
+```python
+STORAGES = {
+    "default": {
+        "BACKEND": "django_capo_s3.S3Storage",
+        "OPTIONS": {
+            "bucket": "my-bucket",
+            "region": "eu-central-1",
+            "location": "media",
+        },
+    },
+    "staticfiles": {
+        "BACKEND": "django_capo_s3.S3ManifestStaticStorage",
+        "OPTIONS": {"bucket": "my-bucket", "location": "static"},
+    },
+}
+```
+
+## Usage
+
+### On a model field
+
+Most apps never touch storage directly. With `STORAGES["default"]` configured (above), `FileField` /
+`ImageField` just work — uploads, `.url`, `.size`, and `.open()` all go through the backend.
+
+```python
+from django.db import models
+
+class Report(models.Model):
+    csv = models.FileField(upload_to="reports/")
+
+report = Report.objects.create(csv=uploaded_file)
+report.csv.url            # presigned URL to the object
+report.csv.size           # size in bytes
+report.csv.open().read()  # file contents
+```
+
+### Direct storage access
+
+Grab the configured default storage from the registry and use the `Storage` API directly.
+
+```python
+from django.core.files.base import ContentFile
+from django.core.files.storage import storages
+
+storage = storages["default"]
+name = storage.save("reports/june.csv", ContentFile(b"col1,col2\n"))  # returns the stored name
+storage.exists(name)          # True
+storage.size(name)            # size in bytes
+with storage.open(name) as f:
+    data = f.read()
+storage.delete(name)          # no error if it's already gone
+```
+
+### Download URLs
+
+`url()` is presigned by default. Override the lifetime per call, or add response headers — for example, to
+force a browser "Save as" with a filename.
+
+```python
+storage.url("reports/june.csv")                # presigned, default lifetime (url_expire)
+storage.url("reports/june.csv", expire=60)     # presigned, valid for 60 seconds
+storage.url(
+    "reports/june.csv",
+    parameters={"response_content_disposition": 'attachment; filename="june.csv"'},
+)
+```
+
+For a public bucket, set `"querystring_auth": False` in `OPTIONS` to get plain, cacheable URLs instead.
+
+### Static files with cache-busting
+
+Point `STORAGES["staticfiles"]` at `S3ManifestStaticStorage`. `collectstatic` then stores each file under a
+content-hashed name and `{% static %}` resolves through the manifest, so assets can be served with
+long-lived caching. Keep the manifest local so web workers don't fetch it from S3 on startup.
+
+```python
+from django.core.files.storage import FileSystemStorage
+
+STORAGES["staticfiles"] = {
+    "BACKEND": "django_capo_s3.S3ManifestStaticStorage",
+    "OPTIONS": {
+        "bucket": "my-bucket",
+        "location": "static",
+        "manifest_storage": FileSystemStorage(location=BASE_DIR / ".static-manifest"),
+    },
+}
+```
+
+### Serving through a CDN (CloudFront)
+
+Set `custom_domain` for plain CDN URLs, or add a CloudFront key pair to sign them for a private
+distribution.
+
+```python
+"OPTIONS": {
+    "bucket": "my-bucket",
+    "custom_domain": "d123.cloudfront.net",
+    "cloudfront_key": cloudfront_private_key_pem,  # PEM contents
+    "cloudfront_key_id": "K1ABCDEF",
+    "url_expire": 300,
+}
+# storage.url(name) -> https://d123.cloudfront.net/...?Expires=...&Signature=...&Key-Pair-Id=...
+```
+
+### Large uploads and gzip
+
+Uploads switch to a concurrent multipart transfer above `multipart_threshold`; text assets can be stored
+gzip-compressed and are transparently decompressed on read.
+
+```python
+"OPTIONS": {
+    "bucket": "my-bucket",
+    "multipart_threshold": 32 * 1024 * 1024,  # start multipart at 32 MiB
+    "multipart_chunksize": 16 * 1024 * 1024,
+    "multipart_concurrency": 8,               # parts uploaded in parallel
+    "gzip": True,                             # compress CSS/JS/JSON/... at rest
+}
+```
+
+### Encryption, storage class, and other object metadata
+
+Whatever `object_parameters` contains is passed straight to each upload — e.g. SSE-KMS plus a storage class
+and cache header.
+
+```python
+"OPTIONS": {
+    "bucket": "my-bucket",
+    "default_acl": "private",
+    "object_parameters": {
+        "server_side_encryption": "aws:kms",
+        "ssekms_key_id": "arn:aws:kms:eu-central-1:123456789012:key/abcd-...",
+        "storage_class": "STANDARD_IA",
+        "cache_control": "max-age=86400",
+    },
+}
+```
+
+### Networking (endpoint tuning, proxies)
+
+Tune timeouts, the connection pool, retries, TLS verification, and proxies as needed.
+
+```python
+"OPTIONS": {
+    "bucket": "my-bucket",
+    "connect_timeout": 5.0,
+    "read_timeout": 30.0,
+    "max_connections_per_host": 50,
+    "retry_max_attempts": 5,
+    "verify": "/etc/ssl/certs/internal-ca.pem",   # or False to disable TLS verification
+    "proxies": {"https": "http://proxy.internal:8080"},
+}
+```