skyhook-rayan 1.0.0__tar.gz

skyhook_rayan-1.0.0/PKG-INFO

@@ -0,0 +1,313 @@
+Metadata-Version: 2.4
+Name: skyhook-rayan
+Version: 1.0.0
+Summary: A secure, zero-config CLI file server with upload capabilities and encrypted transport
+Author: Skyhook Contributors
+License: MIT
+Project-URL: Homepage, https://github.com/skyhook/skyhook
+Project-URL: Documentation, https://github.com/skyhook/skyhook#readme
+Project-URL: Repository, https://github.com/skyhook/skyhook
+Keywords: file-server,upload,cli,fastapi,security
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.109.0
+Requires-Dist: uvicorn[standard]>=0.27.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: jinja2>=3.1.2
+Requires-Dist: typer>=0.9.0
+Requires-Dist: cryptography>=41.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: httpx>=0.26.0; extra == "dev"
+
+# 🚀 Skyhook
+
+> A secure, zero-config CLI file server with upload capabilities and encrypted transport
+
+Skyhook is a modern replacement for `python -m http.server` with authentication, HTTPS support, and file upload capabilities. Perfect for quickly sharing files between machines or within a local network.
+
+## ✨ Features
+
+- **🔐 Secure by Default**: Optional HTTP Basic Auth and self-signed SSL certificates
+- **📤 Upload Support**: Drag-and-drop file uploads via web interface
+- **⚡ Fast**: Launch a server in any directory in under 1 second
+- **🎨 Modern UI**: Beautiful, responsive web interface that works on mobile
+- **🔍 Search & Filter**: Quickly find files in large directories
+- **🛡️ Security Hardened**: Path sanitization prevents directory traversal attacks
+- **📱 Mobile Friendly**: Upload files from your phone's browser
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install skyhook
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/skyhook/skyhook.git
+cd skyhook
+pip install -e .
+```
+
+### Basic Usage
+
+```bash
+# Serve current directory on port 8000
+skyhook
+
+# Serve a specific directory
+skyhook /path/to/files
+
+# Custom port
+skyhook --port 8080
+
+# Enable authentication
+skyhook --auth username:password
+
+# Enable HTTPS with self-signed certificate
+skyhook --ssl
+
+# Full configuration
+skyhook /data --port 8443 --auth admin:secret --ssl
+```
+
+## 📖 Usage Examples
+
+### Simple File Sharing
+
+Share files in the current directory:
+
+```bash
+skyhook
+```
+
+Then visit `http://localhost:8000` in your browser.
+
+### Secure File Transfer
+
+Enable authentication and HTTPS for secure transfers:
+
+```bash
+skyhook --auth myuser:mypass --ssl
+```
+
+Access via `https://localhost:8000` (you'll need to accept the self-signed certificate warning).
+
+### Remote Access
+
+Bind to all interfaces to allow remote connections:
+
+```bash
+skyhook --host 0.0.0.0 --port 8000 --auth user:pass
+```
+
+Now accessible from other devices on your network at `http://YOUR_IP:8000`.
+
+### Quick File Upload
+
+Upload files to a specific directory:
+
+```bash
+cd /tmp/uploads
+skyhook --auth upload:secret
+```
+
+Open the URL in your browser and drag files to upload.
+
+## 🎯 Use Cases
+
+- **Dev Workflow**: Quickly share build artifacts between machines
+- **Network Transfers**: Move files between computers without USB drives
+- **Mobile Uploads**: Upload photos from your phone to your computer
+- **Team Collaboration**: Share files within a local network
+- **Remote Work**: Securely transfer files to/from a remote server
+
+## 🔒 Security Features
+
+### Authentication
+
+HTTP Basic Authentication protects your files from unauthorized access:
+
+```bash
+skyhook --auth username:password
+```
+
+Credentials are checked using constant-time comparison to prevent timing attacks.
+
+### SSL/TLS Encryption
+
+Enable HTTPS to encrypt all traffic:
+
+```bash
+skyhook --ssl
+```
+
+Skyhook automatically generates a self-signed certificate. For production use, configure a proper certificate with a reverse proxy like nginx.
+
+### Path Sanitization
+
+All file paths are strictly validated to prevent directory traversal attacks. Attempts to access files outside the served directory are blocked:
+
+```
+# These attacks are automatically prevented:
+../../../etc/passwd  ❌ Blocked
+../../secret.txt     ❌ Blocked
+/etc/hosts           ❌ Blocked
+```
+
+## 🔧 CLI Reference
+
+```
+Usage: skyhook [PATH] [OPTIONS]
+
+Arguments:
+  PATH  Directory to serve [default: current directory]
+
+Options:
+  -p, --port INTEGER       Port to bind to [default: 8000]
+  -h, --host TEXT          Host interface to bind to [default: 0.0.0.0]
+  -a, --auth TEXT          Enable auth (format: username:password)
+  --ssl                    Enable HTTPS with self-signed certificate
+  --reload                 Enable auto-reload for development
+  --help                   Show this message and exit
+
+Commands:
+  serve    Start the file server (default command)
+  version  Show Skyhook version
+```
+
+## 🌐 API Endpoints
+
+Skyhook provides a RESTful API:
+
+| Endpoint           | Method | Description             |
+| ------------------ | ------ | ----------------------- |
+| `/`                | GET    | List root directory     |
+| `/browse/{path}`   | GET    | List specific directory |
+| `/download/{path}` | GET    | Download a file         |
+| `/upload`          | POST   | Upload files            |
+| `/health`          | GET    | Health check            |
+
+### Upload via curl
+
+```bash
+# Upload single file
+curl -F "files=@myfile.txt" http://localhost:8000/upload
+
+# Upload with authentication
+curl -u username:password -F "files=@myfile.txt" http://localhost:8000/upload
+
+# Upload multiple files
+curl -F "files=@file1.txt" -F "files=@file2.txt" http://localhost:8000/upload
+
+# Upload to subdirectory
+curl -F "files=@myfile.txt" -F "path=subdir" http://localhost:8000/upload
+```
+
+## 🧪 Development
+
+### Running Tests
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Run security tests specifically
+pytest tests/test_skyhook.py::TestSecurity -v
+```
+
+### Project Structure
+
+```
+skyhook/
+├── src/
+│   └── skyhook/
+│       ├── __init__.py
+│       ├── main.py          # CLI entrypoint
+│       ├── server.py        # FastAPI application
+│       ├── security.py      # Auth & SSL logic
+│       └── templates/
+│           └── index.html   # Web UI
+├── tests/
+│   └── test_skyhook.py      # Test suite
+├── pyproject.toml           # Project metadata
+└── README.md
+```
+
+## 📊 Performance
+
+- **Memory footprint**: < 100MB during 1GB file transfers
+- **Startup time**: < 1 second
+- **Concurrent uploads**: Supported via async I/O
+- **Large files**: Handled efficiently with chunked streaming
+
+## 🗺️ Roadmap
+
+### v1.1 (Planned)
+
+- [ ] Support for `.zip` folder downloads
+- [ ] Directory compression on-the-fly
+- [ ] File preview for common formats
+
+### v1.2 (Planned)
+
+- [ ] Searchable file indexing for deep directories
+- [ ] Advanced filtering (by date, size, type)
+- [ ] Thumbnail generation for images
+
+### v2.0 (Future)
+
+- [ ] P2P mode using WebRTC (bypass firewalls)
+- [ ] End-to-end encryption
+- [ ] Multi-user support with permissions
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📝 License
+
+MIT License - see LICENSE file for details
+
+## 🙏 Acknowledgments
+
+- Built with [FastAPI](https://fastapi.tiangolo.com/)
+- Powered by [Uvicorn](https://www.uvicorn.org/)
+- CLI built with [Typer](https://typer.tiangolo.com/)
+
+## ⚠️ Security Notes
+
+- Self-signed SSL certificates will trigger browser warnings (this is expected)
+- For production use, configure proper SSL certificates via reverse proxy
+- Always use authentication when exposing to untrusted networks
+- Keep dependencies updated for security patches
+
+## 📞 Support
+
+- Issues: [GitHub Issues](https://github.com/skyhook/skyhook/issues)
+- Documentation: [GitHub Wiki](https://github.com/skyhook/skyhook/wiki)
+
+---
+
+Made with ❤️ by the Skyhook team

skyhook_rayan-1.0.0/README.md

@@ -0,0 +1,282 @@
+# 🚀 Skyhook
+
+> A secure, zero-config CLI file server with upload capabilities and encrypted transport
+
+Skyhook is a modern replacement for `python -m http.server` with authentication, HTTPS support, and file upload capabilities. Perfect for quickly sharing files between machines or within a local network.
+
+## ✨ Features
+
+- **🔐 Secure by Default**: Optional HTTP Basic Auth and self-signed SSL certificates
+- **📤 Upload Support**: Drag-and-drop file uploads via web interface
+- **⚡ Fast**: Launch a server in any directory in under 1 second
+- **🎨 Modern UI**: Beautiful, responsive web interface that works on mobile
+- **🔍 Search & Filter**: Quickly find files in large directories
+- **🛡️ Security Hardened**: Path sanitization prevents directory traversal attacks
+- **📱 Mobile Friendly**: Upload files from your phone's browser
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install skyhook
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/skyhook/skyhook.git
+cd skyhook
+pip install -e .
+```
+
+### Basic Usage
+
+```bash
+# Serve current directory on port 8000
+skyhook
+
+# Serve a specific directory
+skyhook /path/to/files
+
+# Custom port
+skyhook --port 8080
+
+# Enable authentication
+skyhook --auth username:password
+
+# Enable HTTPS with self-signed certificate
+skyhook --ssl
+
+# Full configuration
+skyhook /data --port 8443 --auth admin:secret --ssl
+```
+
+## 📖 Usage Examples
+
+### Simple File Sharing
+
+Share files in the current directory:
+
+```bash
+skyhook
+```
+
+Then visit `http://localhost:8000` in your browser.
+
+### Secure File Transfer
+
+Enable authentication and HTTPS for secure transfers:
+
+```bash
+skyhook --auth myuser:mypass --ssl
+```
+
+Access via `https://localhost:8000` (you'll need to accept the self-signed certificate warning).
+
+### Remote Access
+
+Bind to all interfaces to allow remote connections:
+
+```bash
+skyhook --host 0.0.0.0 --port 8000 --auth user:pass
+```
+
+Now accessible from other devices on your network at `http://YOUR_IP:8000`.
+
+### Quick File Upload
+
+Upload files to a specific directory:
+
+```bash
+cd /tmp/uploads
+skyhook --auth upload:secret
+```
+
+Open the URL in your browser and drag files to upload.
+
+## 🎯 Use Cases
+
+- **Dev Workflow**: Quickly share build artifacts between machines
+- **Network Transfers**: Move files between computers without USB drives
+- **Mobile Uploads**: Upload photos from your phone to your computer
+- **Team Collaboration**: Share files within a local network
+- **Remote Work**: Securely transfer files to/from a remote server
+
+## 🔒 Security Features
+
+### Authentication
+
+HTTP Basic Authentication protects your files from unauthorized access:
+
+```bash
+skyhook --auth username:password
+```
+
+Credentials are checked using constant-time comparison to prevent timing attacks.
+
+### SSL/TLS Encryption
+
+Enable HTTPS to encrypt all traffic:
+
+```bash
+skyhook --ssl
+```
+
+Skyhook automatically generates a self-signed certificate. For production use, configure a proper certificate with a reverse proxy like nginx.
+
+### Path Sanitization
+
+All file paths are strictly validated to prevent directory traversal attacks. Attempts to access files outside the served directory are blocked:
+
+```
+# These attacks are automatically prevented:
+../../../etc/passwd  ❌ Blocked
+../../secret.txt     ❌ Blocked
+/etc/hosts           ❌ Blocked
+```
+
+## 🔧 CLI Reference
+
+```
+Usage: skyhook [PATH] [OPTIONS]
+
+Arguments:
+  PATH  Directory to serve [default: current directory]
+
+Options:
+  -p, --port INTEGER       Port to bind to [default: 8000]
+  -h, --host TEXT          Host interface to bind to [default: 0.0.0.0]
+  -a, --auth TEXT          Enable auth (format: username:password)
+  --ssl                    Enable HTTPS with self-signed certificate
+  --reload                 Enable auto-reload for development
+  --help                   Show this message and exit
+
+Commands:
+  serve    Start the file server (default command)
+  version  Show Skyhook version
+```
+
+## 🌐 API Endpoints
+
+Skyhook provides a RESTful API:
+
+| Endpoint           | Method | Description             |
+| ------------------ | ------ | ----------------------- |
+| `/`                | GET    | List root directory     |
+| `/browse/{path}`   | GET    | List specific directory |
+| `/download/{path}` | GET    | Download a file         |
+| `/upload`          | POST   | Upload files            |
+| `/health`          | GET    | Health check            |
+
+### Upload via curl
+
+```bash
+# Upload single file
+curl -F "files=@myfile.txt" http://localhost:8000/upload
+
+# Upload with authentication
+curl -u username:password -F "files=@myfile.txt" http://localhost:8000/upload
+
+# Upload multiple files
+curl -F "files=@file1.txt" -F "files=@file2.txt" http://localhost:8000/upload
+
+# Upload to subdirectory
+curl -F "files=@myfile.txt" -F "path=subdir" http://localhost:8000/upload
+```
+
+## 🧪 Development
+
+### Running Tests
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Run security tests specifically
+pytest tests/test_skyhook.py::TestSecurity -v
+```
+
+### Project Structure
+
+```
+skyhook/
+├── src/
+│   └── skyhook/
+│       ├── __init__.py
+│       ├── main.py          # CLI entrypoint
+│       ├── server.py        # FastAPI application
+│       ├── security.py      # Auth & SSL logic
+│       └── templates/
+│           └── index.html   # Web UI
+├── tests/
+│   └── test_skyhook.py      # Test suite
+├── pyproject.toml           # Project metadata
+└── README.md
+```
+
+## 📊 Performance
+
+- **Memory footprint**: < 100MB during 1GB file transfers
+- **Startup time**: < 1 second
+- **Concurrent uploads**: Supported via async I/O
+- **Large files**: Handled efficiently with chunked streaming
+
+## 🗺️ Roadmap
+
+### v1.1 (Planned)
+
+- [ ] Support for `.zip` folder downloads
+- [ ] Directory compression on-the-fly
+- [ ] File preview for common formats
+
+### v1.2 (Planned)
+
+- [ ] Searchable file indexing for deep directories
+- [ ] Advanced filtering (by date, size, type)
+- [ ] Thumbnail generation for images
+
+### v2.0 (Future)
+
+- [ ] P2P mode using WebRTC (bypass firewalls)
+- [ ] End-to-end encryption
+- [ ] Multi-user support with permissions
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📝 License
+
+MIT License - see LICENSE file for details
+
+## 🙏 Acknowledgments
+
+- Built with [FastAPI](https://fastapi.tiangolo.com/)
+- Powered by [Uvicorn](https://www.uvicorn.org/)
+- CLI built with [Typer](https://typer.tiangolo.com/)
+
+## ⚠️ Security Notes
+
+- Self-signed SSL certificates will trigger browser warnings (this is expected)
+- For production use, configure proper SSL certificates via reverse proxy
+- Always use authentication when exposing to untrusted networks
+- Keep dependencies updated for security patches
+
+## 📞 Support
+
+- Issues: [GitHub Issues](https://github.com/skyhook/skyhook/issues)
+- Documentation: [GitHub Wiki](https://github.com/skyhook/skyhook/wiki)
+
+---
+
+Made with ❤️ by the Skyhook team

skyhook_rayan-1.0.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "skyhook-rayan"
+version = "1.0.0"
+description = "A secure, zero-config CLI file server with upload capabilities and encrypted transport"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [
+    {name = "Skyhook Contributors"}
+]
+keywords = ["file-server", "upload", "cli", "fastapi", "security"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+dependencies = [
+    "fastapi>=0.109.0",
+    "uvicorn[standard]>=0.27.0",
+    "python-multipart>=0.0.6",
+    "jinja2>=3.1.2",
+    "typer>=0.9.0",
+    "cryptography>=41.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-asyncio>=0.21.0",
+    "httpx>=0.26.0",
+]
+
+[project.scripts]
+skyhook = "skyhook.main:app"
+
+[project.urls]
+Homepage = "https://github.com/skyhook/skyhook"
+Documentation = "https://github.com/skyhook/skyhook#readme"
+Repository = "https://github.com/skyhook/skyhook"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["skyhook*"]
+
+[tool.setuptools.package-data]
+skyhook = ["templates/*.html"]

skyhook_rayan-1.0.0/setup.cfg

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

skyhook_rayan-1.0.0/src/skyhook/__init__.py

@@ -0,0 +1,10 @@
+"""Skyhook - Secure file server with upload capabilities."""
+
+__version__ = "1.0.0"
+__author__ = "Skyhook Contributors"
+__description__ = "A secure, zero-config CLI file server with upload capabilities and encrypted transport"
+
+from .main import app as cli_app
+from .server import create_app
+
+__all__ = ["cli_app", "create_app", "__version__"]