sharedserver 0.1.0__py3-none-any.whl

sharedserver/websocket.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+import asyncio
+
+from fastapi import WebSocket, WebSocketDisconnect
+from pydantic import ValidationError
+
+from .models import ClipboardUpdate
+
+
+class ClipboardHub:
+    def __init__(self) -> None:
+        self.content = ""
+        self.clients: set[WebSocket] = set()
+        self.lock = asyncio.Lock()
+
+    async def connect(self, websocket: WebSocket) -> None:
+        await websocket.accept()
+        async with self.lock:
+            self.clients.add(websocket)
+            content = self.content
+        await websocket.send_json({"type": "clipboard", "content": content})
+
+    async def disconnect(self, websocket: WebSocket) -> None:
+        async with self.lock:
+            self.clients.discard(websocket)
+
+    async def broadcast(self, content: str) -> None:
+        async with self.lock:
+            self.content = content
+            clients = tuple(self.clients)
+        failed: list[WebSocket] = []
+        for client in clients:
+            try:
+                await client.send_json({"type": "clipboard", "content": content})
+            except (RuntimeError, WebSocketDisconnect):
+                failed.append(client)
+        if failed:
+            async with self.lock:
+                self.clients.difference_update(failed)
+
+    async def handle(self, websocket: WebSocket) -> None:
+        await self.connect(websocket)
+        try:
+            while True:
+                try:
+                    message = ClipboardUpdate.model_validate(await websocket.receive_json())
+                except (ValidationError, ValueError):
+                    await websocket.send_json(
+                        {"type": "error", "message": "invalid clipboard message"}
+                    )
+                    continue
+                await self.broadcast(message.content)
+        except WebSocketDisconnect:
+            pass
+        finally:
+            await self.disconnect(websocket)

sharedserver-0.1.0.dist-info/METADATA

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: sharedserver
+Version: 0.1.0
+Summary: Zero-configuration LAN file sharing and real-time text clipboard
+Author: Kyi Wong
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/NihaoKangkang/sharedserver
+Project-URL: Repository, https://github.com/NihaoKangkang/sharedserver
+Project-URL: Issues, https://github.com/NihaoKangkang/sharedserver/issues
+Keywords: file-sharing,clipboard,lan,fastapi,websocket
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi<1,>=0.115
+Requires-Dist: PyYAML<7,>=6
+Requires-Dist: uvicorn<1,>=0.30
+Requires-Dist: websockets<17,>=13
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.2; extra == "dev"
+Requires-Dist: httpx2<3,>=2; extra == "dev"
+Requires-Dist: pytest<9,>=8; extra == "dev"
+Requires-Dist: twine<7,>=5; extra == "dev"
+Dynamic: license-file
+
+# SharedServer
+
+SharedServer is a zero-configuration, login-free LAN file server and real-time text clipboard. It is as easy to start as `python -m http.server`, while adding uploads, directory browsing, live text synchronization, and allowlisted clipboard actions.
+
+> SharedServer has no authentication. Run it only on a trusted home, lab, or development network. Never expose it directly to the public internet.
+
+## Features
+
+- A shared text clipboard synchronized between all open pages over WebSocket
+- A responsive file browser with directory navigation, file sizes, and modification times
+- File uploads from desktop and mobile browsers with live progress
+- Folder creation and safe, non-overwriting uploads
+- Copy actions for allowlisted text and image formats
+- Download-only behavior for other formats such as ZIP, RAR, 7z, EXE, APK, and ISO
+- Protection against path traversal, directory escape, symlink escape, and unsafe filenames
+- No accounts, database, device discovery, template engine, or frontend framework
+
+## Requirements
+
+- Python 3.10 or newer
+- A modern desktop or mobile browser
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install sharedserver
+```
+
+Install from source:
+
+```bash
+git clone https://github.com/NihaoKangkang/sharedserver.git
+cd sharedserver
+pip install .
+```
+
+## Quick start
+
+Run this command from the directory you want to share:
+
+```bash
+python -m sharedserver 8080
+```
+
+
+## CLI reference
+
+```text
+usage: sharedserver [-h] [--host HOST] [-d DIRECTORY] [-c CONFIG]
+                    [--max-upload-size MB] [--version]
+                    [port]
+```
+
+| Argument | Description |
+| --- | --- |
+| `port` | Listening port. Uses the configuration value or `8000` by default. |
+| `--host HOST` | Bind address. Defaults to `0.0.0.0`. |
+| `-d, --directory PATH` | Directory to share. Defaults to the current directory. |
+| `-c, --config PATH` | YAML configuration file. |
+| `--max-upload-size MB` | Maximum upload size in MiB. Defaults to 1024 MiB. |
+| `--version` | Print the installed version. |
+
+CLI arguments override configuration file values. Without `--config`, SharedServer automatically loads `sharedserver.yaml` from the current directory when it exists.
+
+## Configuration
+
+Copy `sharedserver.example.yaml` to `sharedserver.yaml` and edit it as needed:
+
+```yaml
+server:
+  host: 0.0.0.0
+  port: 8080
+
+share:
+  directory: ./
+  max_upload_size: 1073741824
+
+clipboard:
+  max_text_size: 2097152
+  text_extensions:
+    - .txt
+    - .md
+  image_extensions:
+    - .png
+    - .jpg
+```
+
+Relative shared directory paths are resolved from the configuration file's directory. Custom extension lists replace the defaults, and matching is case-insensitive.
+
+Default text extensions:
+
+```text
+.txt .md .json .xml .yaml .yml .csv .log .py .js .html .css .java .c .cpp
+```
+
+Default image extensions:
+
+```text
+.png .jpg .jpeg .webp
+```
+
+## Security model
+
+- Every user-supplied path is resolved with `Path.resolve()` and checked against the shared root.
+- Absolute paths and `..` path segments are rejected.
+- Symlinks are hidden from directory listings and rejected by file operations.
+- Upload filenames are stripped of path components, control characters, and unsafe cross-platform characters.
+- Uploads are written to a temporary file and published without overwriting an existing file.
+- Both `Content-Length` validation and streamed byte counting enforce the upload limit.
+- Clipboard actions and server read endpoints use the same strict extension allowlists.
+- Browser WebSocket connections from a different origin are rejected.
+- Shared text exists only in process memory and is cleared when the server stops.
+
+SharedServer intentionally has no login or authorization layer. Every device that can reach the server can read and write the shared directory and shared text.
+
+## Development
+
+Clone the project and create a virtual environment:
+
+```bash
+git clone https://github.com/NihaoKangkang/sharedserver.git
+cd sharedserver
+python -m venv .venv
+```
+
+Activate the environment, then install development dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Start a development server:
+
+```bash
+python -m sharedserver 8080 --directory .
+```
+
+
+## License
+
+[MIT](LICENSE)

sharedserver-0.1.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+sharedserver/__init__.py,sha256=fcXQwomL1kmmlLnKRSx_v3eeMDHiskXHGWOdqrgPpBA,52
+sharedserver/__main__.py,sha256=14FfnaF7zY550dRxcOV5XinMWDf5fRBJZkgTBoqeVj8,63
+sharedserver/cli.py,sha256=InIP39ACgt_YL9xjHHqCStjqJdqT8NSbbNuCq0HbVg8,2447
+sharedserver/clipboard.py,sha256=y_Kn30yJnJbhNL1isybDLiKv_6XdZ5Xh__vjIrbxkXY,1102
+sharedserver/config.py,sha256=pPMbLFuSiQhT5mL52ro8rxhKPKdSguFDumVdcWIWF-M,5018
+sharedserver/file_manager.py,sha256=wAKIPy-yY1iQaBTbEQsqUIrDrBEK8Ca5bhV-K8S1T8U,5049
+sharedserver/models.py,sha256=8UNpOFRBFUsZKTEcPD5qN5w_xX9BFlZLHHyGovlTsbA,725
+sharedserver/security.py,sha256=qrH-wiST8rOQLAJY4S3zU12wlWk5SNnWRryXnnZXbB0,1734
+sharedserver/server.py,sha256=rO-9Pw2dxOmCN7A1OhVXtHxzYELOTM7NKKuBaGrZlTA,5902
+sharedserver/websocket.py,sha256=o7G9ZWFYGncxN9cpSWP0mqC8SOohSCugkvQe-Tzs3Xg,1930
+sharedserver/static/app.css,sha256=Ll-940sgztrniR-1HUxzcaLMqjDdc6pftzJd78q3uPs,9186
+sharedserver/static/app.js,sha256=6e4nUsZPPjJhihUz4X4Cq-OKb_dmlk9Gy5Ew7IlYQZI,12818
+sharedserver/templates/index.html,sha256=5rG2p52LH2tuulrhjOtz8gbfhuof0TOfdha1mJYf_uw,3380
+sharedserver-0.1.0.dist-info/licenses/LICENSE,sha256=inYxby017tQkLDQchOc_uUz2nDVLJSY___IjpZcGid4,1066
+sharedserver-0.1.0.dist-info/METADATA,sha256=WDcyZRyLVmtJ6Z89kke03G7eAbgm3f0LnX-0Lmw5Huc,5553
+sharedserver-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+sharedserver-0.1.0.dist-info/entry_points.txt,sha256=rsNs9N4tdGREmL84F9dD50h-8eUBjD9L_MAsJzmtY6c,55
+sharedserver-0.1.0.dist-info/top_level.txt,sha256=TRb9rewpeC-6OHWWPSBGa-b2CrV3hMmusWV-KhpRgX0,13
+sharedserver-0.1.0.dist-info/RECORD,,

sharedserver-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sharedserver-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sharedserver = sharedserver.cli:main

sharedserver-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Kyi Wong
+
+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.
+

sharedserver-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+sharedserver