vaalboks 0.1.0__tar.gz

vaalboks-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 vaalboks contributors
+
+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.

vaalboks-0.1.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: vaalboks
+Version: 0.1.0
+Summary: Simple local-network file sharing over HTTPS
+Author: vaalboks contributors
+License-Expression: MIT
+Keywords: django,file-sharing,lan,self-hosted
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: Django
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=46.0.0
+Requires-Dist: django>=6.1.1
+Requires-Dist: gunicorn>=26.2.0
+Requires-Dist: uvicorn>=0.52.4
+Requires-Dist: uvicorn-worker>=0.4.0
+Requires-Dist: whitenoise>=6.12.0
+Requires-Dist: zstandard>=0.25.0
+Dynamic: license-file
+
+# vaalboks
+
+<p align="center">
+  <img src="share/static/share/logo.svg" alt="vaalboks logo" width="520">
+</p>
+
+Vaalboks is a small file-sharing server for a local network. Drop files or
+folders in the browser, then download them from another device on the same
+network.
+
+The name is Afrikaans for “dull box” — a straightforward tool for moving files
+between computers without a separate hosted service.
+
+## Stack
+
+- Python 3.14, Django 6.1, uv
+- Frontend: plain HTML/CSS/JS + htmx 4.0
+- Uploads use XHR for live progress and speed tracking; downloads use streaming
+  `fetch`
+
+## Run
+
+After installing the package, start the server with:
+
+```sh
+uvx vaalboks
+```
+
+This starts HTTPS on `0.0.0.0:8443` with two workers. Runtime data is stored
+in `./vaalboks-data`, and a self-signed certificate is generated there on
+first launch. Migrations and static-file collection run automatically. Use
+`--http` for plain HTTP on port 8123. The CLI uses Gunicorn on Linux and macOS
+and Uvicorn on Windows.
+
+When running from this checkout:
+
+```sh
+uv run python manage.py runserver 0.0.0.0:8123
+```
+
+Then open `http://<your-LAN-IP>:8123/` from any device on the network.
+(Find your IP with `ipconfig getifaddr en0`.)
+
+## Use as a Django app
+
+The file-sharing interface can also be mounted in an existing Django project.
+Install `vaalboks`, add `share` to `INSTALLED_APPS`, configure the directory
+used for uploads, and include the app URLs:
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # ...
+    "share",
+]
+
+VAALBOKS_SHARED_ROOT = BASE_DIR / "shared"
+```
+
+```python
+# urls.py
+from django.urls import include, path
+
+urlpatterns = [
+    path("share/", include("share.urls")),
+]
+```
+
+The app does not require the bundled `vaalboks` settings, middleware, or
+server. The host project remains responsible for Django middleware, static
+files, CSRF, and deployment configuration.
+
+## Direct Gunicorn HTTPS + zstd
+
+This section applies to Linux and macOS. Windows users should use the `vaalboks`
+command, which selects Uvicorn automatically.
+
+Gunicorn can terminate HTTPS, and Django compresses eligible text responses
+with zstd:
+
+```sh
+uv run gunicorn vaalboks.asgi:application \
+  --worker-class uvicorn_worker.UvicornWorker \
+  --workers 2 \
+  --bind 0.0.0.0:8443 \
+  --certfile certs/vaalboks-cert.pem \
+  --keyfile certs/vaalboks-key.pem
+```
+
+Open `https://<your-LAN-IP>:8443/` and trust the self-signed certificate on
+each device that will connect. This setup provides HTTPS and zstd compression.
+
+The CLI also accepts `--host`, `--port`, `--workers`, `--data-dir`,
+`--certfile`, and `--keyfile`.
+
+## Publishing
+
+Build artifacts locally with:
+
+```sh
+uv build
+```
+
+The repository includes GitHub Actions for quality checks and publishing on a
+published GitHub release. Configure PyPI trusted publishing for the GitHub
+repository before creating the first release; no long-lived PyPI token is
+required.
+
+## How it works
+
+- `GET /` — single page with drop zone and live file listing
+- `GET /api/files/` — htmx partial that re-renders the listing after uploads
+- `POST /api/upload/` — multipart upload; folders are traversed client-side
+  (`webkitGetAsEntry`) and each file is sent with its relative path
+- `GET /files/<path>` — download a shared file (path-traversal protected)

vaalboks-0.1.0/README.md

@@ -0,0 +1,115 @@
+# vaalboks
+
+<p align="center">
+  <img src="share/static/share/logo.svg" alt="vaalboks logo" width="520">
+</p>
+
+Vaalboks is a small file-sharing server for a local network. Drop files or
+folders in the browser, then download them from another device on the same
+network.
+
+The name is Afrikaans for “dull box” — a straightforward tool for moving files
+between computers without a separate hosted service.
+
+## Stack
+
+- Python 3.14, Django 6.1, uv
+- Frontend: plain HTML/CSS/JS + htmx 4.0
+- Uploads use XHR for live progress and speed tracking; downloads use streaming
+  `fetch`
+
+## Run
+
+After installing the package, start the server with:
+
+```sh
+uvx vaalboks
+```
+
+This starts HTTPS on `0.0.0.0:8443` with two workers. Runtime data is stored
+in `./vaalboks-data`, and a self-signed certificate is generated there on
+first launch. Migrations and static-file collection run automatically. Use
+`--http` for plain HTTP on port 8123. The CLI uses Gunicorn on Linux and macOS
+and Uvicorn on Windows.
+
+When running from this checkout:
+
+```sh
+uv run python manage.py runserver 0.0.0.0:8123
+```
+
+Then open `http://<your-LAN-IP>:8123/` from any device on the network.
+(Find your IP with `ipconfig getifaddr en0`.)
+
+## Use as a Django app
+
+The file-sharing interface can also be mounted in an existing Django project.
+Install `vaalboks`, add `share` to `INSTALLED_APPS`, configure the directory
+used for uploads, and include the app URLs:
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # ...
+    "share",
+]
+
+VAALBOKS_SHARED_ROOT = BASE_DIR / "shared"
+```
+
+```python
+# urls.py
+from django.urls import include, path
+
+urlpatterns = [
+    path("share/", include("share.urls")),
+]
+```
+
+The app does not require the bundled `vaalboks` settings, middleware, or
+server. The host project remains responsible for Django middleware, static
+files, CSRF, and deployment configuration.
+
+## Direct Gunicorn HTTPS + zstd
+
+This section applies to Linux and macOS. Windows users should use the `vaalboks`
+command, which selects Uvicorn automatically.
+
+Gunicorn can terminate HTTPS, and Django compresses eligible text responses
+with zstd:
+
+```sh
+uv run gunicorn vaalboks.asgi:application \
+  --worker-class uvicorn_worker.UvicornWorker \
+  --workers 2 \
+  --bind 0.0.0.0:8443 \
+  --certfile certs/vaalboks-cert.pem \
+  --keyfile certs/vaalboks-key.pem
+```
+
+Open `https://<your-LAN-IP>:8443/` and trust the self-signed certificate on
+each device that will connect. This setup provides HTTPS and zstd compression.
+
+The CLI also accepts `--host`, `--port`, `--workers`, `--data-dir`,
+`--certfile`, and `--keyfile`.
+
+## Publishing
+
+Build artifacts locally with:
+
+```sh
+uv build
+```
+
+The repository includes GitHub Actions for quality checks and publishing on a
+published GitHub release. Configure PyPI trusted publishing for the GitHub
+repository before creating the first release; no long-lived PyPI token is
+required.
+
+## How it works
+
+- `GET /` — single page with drop zone and live file listing
+- `GET /api/files/` — htmx partial that re-renders the listing after uploads
+- `POST /api/upload/` — multipart upload; folders are traversed client-side
+  (`webkitGetAsEntry`) and each file is sent with its relative path
+- `GET /files/<path>` — download a shared file (path-traversal protected)

vaalboks-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[project]
+name = "vaalboks"
+version = "0.1.0"
+description = "Simple local-network file sharing over HTTPS"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.14"
+authors = [{ name = "vaalboks contributors" }]
+keywords = ["django", "file-sharing", "lan", "self-hosted"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Framework :: Django",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
+]
+dependencies = [
+    "cryptography>=46.0.0",
+    "django>=6.1.1",
+    "gunicorn>=26.2.0",
+    "uvicorn>=0.52.4",
+    "uvicorn-worker>=0.4.0",
+    "whitenoise>=6.12.0",
+    "zstandard>=0.25.0",
+]
+
+[project.scripts]
+vaalboks = "vaalboks.cli:main"
+
+[build-system]
+requires = ["setuptools>=80"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["vaalboks", "vaalboks.*", "share", "share.*"]
+
+[tool.setuptools.package-data]
+share = ["templates/**/*.html", "static/**/*"]
+
+[tool.ruff]
+target-version = "py314"
+line-length = 100
+extend-exclude = ["shared", "vaalboks-data", "build", "certs"]
+
+#[tool.ruff.lint]
+#select = ["E", "F", "I", "B", "UP", "RUF"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ty.environment]
+python-version = "3.14"
+
+[tool.ty.src]
+include = ["manage.py", "vaalboks", "share"]
+exclude = ["shared/**", "vaalboks-data/**", "build/**"]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.16.6",
+    "ty>=0.0.78",
+]

vaalboks-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vaalboks-0.1.0/share/admin.py

@@ -0,0 +1 @@
+# Register your models here.

vaalboks-0.1.0/share/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class ShareConfig(AppConfig):
+    name = "share"

vaalboks-0.1.0/share/middleware.py

@@ -0,0 +1,37 @@
+import zstandard
+
+
+class ZstdMiddleware:
+    """Compress eligible non-streaming responses when the client supports zstd."""
+
+    min_size = 1024
+
+    def __init__(self, get_response):
+        self.get_response = get_response
+        self.compressor = zstandard.ZstdCompressor(level=3)
+
+    def __call__(self, request):
+        response = self.get_response(request)
+        accepts_zstd = "zstd" in request.headers.get("Accept-Encoding", "").lower()
+        content_type = response.headers.get("Content-Type", "").lower()
+
+        if (
+            accepts_zstd
+            and not response.streaming
+            and response.status_code not in (204, 304)
+            and "Content-Encoding" not in response.headers
+            and (
+                content_type.startswith("text/")
+                or "javascript" in content_type
+                or "json" in content_type
+                or "xml" in content_type
+            )
+        ):
+            body = b"".join(response)
+            if len(body) >= self.min_size:
+                response.content = self.compressor.compress(body)
+                response.headers["Content-Encoding"] = "zstd"
+                response.headers.pop("Content-Length", None)
+                response.headers["Vary"] = "Accept-Encoding"
+
+        return response

vaalboks-0.1.0/share/models.py

@@ -0,0 +1 @@
+# Create your models here.

vaalboks-0.1.0/share/static/share/app.css

@@ -0,0 +1,103 @@
+:root {
+  color-scheme: light dark;
+  --bg: light-dark(#f6f7f9, #14161a);
+  --panel: light-dark(#ffffff, #1d2026);
+  --border: light-dark(#e2e5ea, #30343d);
+  --accent: #4f7cff;
+  --text: light-dark(#1b1e24, #e8eaee);
+  --muted: light-dark(#6b7280, #9aa1ad);
+}
+* { box-sizing: border-box; }
+body {
+  margin: 0;
+  font-family: system-ui, -apple-system, sans-serif;
+  background: var(--bg);
+  color: var(--text);
+  display: flex;
+  justify-content: center;
+  padding: 2rem 1rem;
+}
+main { width: min(720px, 100%); }
+.brand-logo {
+  display: block;
+  width: min(100%, 360px);
+  height: auto;
+  margin: 0 auto 1.25rem;
+}
+h1 { font-size: 1.05rem; margin: 0 0 1.25rem; }
+h1 .subtitle { color: var(--muted); font-weight: 400; }
+#dropzone {
+  border: 2px dashed var(--border);
+  border-radius: 12px;
+  background: var(--panel);
+  padding: 3rem 1.5rem;
+  text-align: center;
+  color: var(--muted);
+  transition: border-color .15s, background .15s;
+  cursor: pointer;
+}
+#dropzone.dragover {
+  border-color: var(--accent);
+  background: color-mix(in srgb, var(--accent) 8%, var(--panel));
+  color: var(--text);
+}
+#dropzone p { margin: .35rem 0; }
+#dropzone .big { font-size: 1.05rem; color: var(--text); }
+#progress-wrap { margin-top: 1rem; display: none; }
+#progress-wrap.active { display: block; }
+progress { width: 100%; height: 8px; }
+#progress-label { font-size: .85rem; color: var(--muted); margin-top: .3rem; }
+#stats {
+  margin-top: 1rem;
+  display: flex;
+  gap: 1.25rem;
+  font-size: .82rem;
+  color: var(--muted);
+  font-variant-numeric: tabular-nums;
+}
+#stats b { color: var(--text); font-weight: 600; }
+#file-list {
+  margin-top: 1.5rem;
+  background: var(--panel);
+  border: 1px solid var(--border);
+  border-radius: 12px;
+  overflow: hidden;
+}
+#file-list:empty::after {
+  content: "Nothing shared yet — drop some files above.";
+  display: block;
+  padding: 1.5rem;
+  color: var(--muted);
+  text-align: center;
+}
+.row {
+  display: flex;
+  align-items: center;
+  gap: .6rem;
+  padding: .55rem 1rem;
+  border-top: 1px solid var(--border);
+  font-size: .92rem;
+}
+.row:first-child { border-top: none; }
+.folder-toggle {
+  width: 1.1em;
+  padding: 0;
+  border: 0;
+  background: none;
+  color: var(--muted);
+  font: inherit;
+  font-size: 1.3rem;
+  line-height: 1;
+  cursor: pointer;
+  transition: transform .15s;
+}
+.folder-toggle[aria-expanded="true"] { transform: rotate(90deg); }
+.folder-toggle.empty { visibility: hidden; cursor: default; }
+.children { display: none; padding-left: 1.4rem; }
+.children.open { display: block; }
+.row .icon { width: 1.1em; text-align: center; }
+.row .name { overflow: hidden; text-overflow: ellipsis; white-space: nowrap; }
+.row .size { margin-left: auto; color: var(--muted); font-variant-numeric: tabular-nums; }
+.row a { color: var(--accent); text-decoration: none; }
+.row a:hover { text-decoration: underline; }
+.row.dir { color: var(--muted); }