orbit-web-framework 1.0.2__tar.gz

orbit_web_framework-1.0.2/CHANGELOG_v1.0.2.md

@@ -0,0 +1,322 @@
+# Orbit Framework - v1.0.2 Release Notes
+
+## Release Date: February 7, 2026
+
+## Major Feature: Access Logging System ✨
+
+This release adds comprehensive logging infrastructure to make Orbit production-ready.
+
+---
+
+## 🎯 New Features
+
+### 1. **Multi-Logger Architecture** ✅
+
+Orbit now uses specialized loggers for different purposes:
+
+- **`orbit.access`** - HTTP access logs (every request)
+- **`orbit.security`** - Security events (rate limits, anomalies)
+- **`orbit.server`** - Server lifecycle (startup, shutdown)
+- **`orbit`** - Application-level events
+
+### 2. **Access Logging** ✅
+
+Every HTTP request is now logged with:
+- Client IP address
+- HTTP method
+- Request path
+- Response status code
+- Request duration (milliseconds)
+
+**Format:**
+```
+2026-02-07 04:27:19 - orbit.access - INFO - 127.0.0.1 | GET / | 200 | 0ms
+```
+
+### 3. **Security Logging** ✅
+
+Security events are logged separately:
+
+#### Rate Limiting
+```
+orbit.security - WARNING - 192.168.1.10 | GET /api/data | RATE_LIMIT | 60/60 req/min
+```
+
+#### Malformed Requests
+```
+orbit.security - WARNING - 192.168.1.10 | MALFORMED | No HTTP headers separator
+```
+
+#### Payload Too Large
+```
+orbit.security - WARNING - 192.168.1.10 | POST /upload | PAYLOAD_TOO_LARGE | 15728640 bytes
+```
+
+#### Parse Errors (Potential Attacks)
+```
+orbit.security - WARNING - 192.168.1.10 | GET /../etc/passwd | PARSE_ERROR | Path traversal attempt
+```
+
+---
+
+## 📊 Log Output Examples
+
+### Normal Operation
+```
+INFO - Orbit server starting on 0.0.0.0:8080
+INFO - 127.0.0.1 | GET / | 200 | 2ms
+INFO - 127.0.0.1 | GET /api/users | 200 | 15ms
+INFO - 127.0.0.1 | POST /api/data | 201 | 8ms
+INFO - Shutdown signal received
+INFO - Server stopped
+```
+
+### With Security Events
+```
+INFO - Orbit server starting on 0.0.0.0:8080
+INFO - 192.168.1.10 | GET /api/data | 200 | 3ms
+INFO - 192.168.1.10 | GET /api/data | 200 | 2ms
+WARNING - 192.168.1.10 | GET /api/data | RATE_LIMIT | 60/60 req/min
+INFO - 192.168.1.10 | GET /api/data | 429 | 1ms
+```
+
+---
+
+## 🔧 Technical Changes
+
+### Modified Files
+
+#### `orbit/http/server.py`
+- Added `access_logger` and `security_logger`
+- Enhanced `_process_request()` with timing and logging
+- IP address extraction from socket
+- Security event detection and logging
+
+#### `orbit/core/middleware.py`
+- Enhanced `RateLimitMiddleware` with security logging
+- Added logger instance to middleware
+
+---
+
+## 📈 Improvements
+
+### Before (v1.0.1)
+```
+INFO - Orbit server starting on 0.0.0.0:8080
+[No logs when requests arrive]
+INFO - Server stopped
+```
+
+❌ **Problem:** No visibility into what's happening
+
+### After (v1.0.2)
+```
+INFO - Orbit server starting on 0.0.0.0:8080
+INFO - 127.0.0.1 | GET / | 200 | 2ms
+INFO - 127.0.0.1 | GET /api/test | 200 | 5ms
+WARNING - 127.0.0.1 | GET /api/test | RATE_LIMIT | 5/5 req/min
+INFO - 127.0.0.1 | GET /api/test | 429 | 1ms
+INFO - Server stopped
+```
+
+✅ **Solution:** Full visibility with clean, structured logs
+
+---
+
+## 🎨 Log Levels
+
+| Level | Usage | Example |
+|-------|-------|---------|
+| `INFO` | Normal operations | Access logs, startup, shutdown |
+| `WARNING` | Security events | Rate limits, suspicious activity |
+| `ERROR` | Server errors | Processing failures, bugs |
+
+**Note:** DEBUG level is available in debug mode but not spammy.
+
+---
+
+## 🚀 Usage
+
+No code changes needed! Logging is automatic:
+
+```python
+from orbit import Orbit, Request, Response
+
+app = Orbit(debug=False)  # Production mode
+
+def hello(request: Request) -> Response:
+    return Response.json({'message': 'Hello!'})
+
+app.route('/hello', ['GET'], hello)
+
+if __name__ == '__main__':
+    app.run(port=8080)
+    # Access logs will appear automatically!
+```
+
+---
+
+## 🛡️ Security Benefits
+
+1. **Attack Detection**
+   - See rate limit violations
+   - Detect malformed requests
+   - Identify suspicious patterns
+
+2. **Forensics**
+   - Track requests by IP
+   - Audit trail for compliance
+   - Incident investigation
+
+3. **Monitoring**
+   - Response time tracking
+   - Error rate monitoring
+   - Traffic patterns
+
+---
+
+## 📦 PyPI Ready
+
+This release is optimized for PyPI:
+- Removed test demo files
+- Kept only essential tests
+- Clean package structure
+
+---
+
+## 🔄 Migration Guide
+
+From v1.0.1 to v1.0.2:
+
+### No Code Changes Needed! ✅
+
+Your existing code works as-is:
+
+```python
+# Your existing app.py
+from orbit import Orbit, Request, Response
+
+app = Orbit()
+
+def home(request):
+    return Response.html('<h1>Hello</h1>')
+
+app.route('/', ['GET'], home)
+app.run(port=8080)
+
+# NEW: Access logs now appear automatically!
+```
+
+### Optional: Customize Logging
+
+If you want custom log format:
+
+```python
+import logging
+
+# Configure before creating Orbit app
+logging.basicConfig(
+    format='%(asctime)s | %(name)s | %(levelname)s | %(message)s',
+    level=logging.INFO
+)
+
+app = Orbit()
+# ... rest of your code
+```
+
+---
+
+## 📊 Performance Impact
+
+- **Minimal overhead** (~1ms per request)
+- **Async-safe** logging
+- **No blocking** on log writes
+- **Same throughput** as v1.0.1
+
+---
+
+## ✅ Backwards Compatibility
+
+**100% backwards compatible** with v1.0.1:
+- No breaking changes
+- No API modifications
+- Existing apps work unchanged
+- Only new features added
+
+---
+
+## 🧪 Testing
+
+All tests pass:
+```bash
+$ python test_orbit.py
+All tests passed! ✓
+```
+
+---
+
+## 📝 Version History
+
+- **v1.0.2** - Access logging system (current)
+- **v1.0.1** - Bugfix: Silent timeouts, idempotent shutdown
+- **v1.0.0** - Initial release
+
+---
+
+## 🎯 What's Next
+
+Planned for v1.1.0:
+- Log file rotation
+- Custom log formatters
+- Metrics collection
+- Performance dashboard
+
+---
+
+## 📚 Documentation
+
+Updated documentation:
+- README.md - Updated with logging info
+- API_REFERENCE.md - Logging configuration
+- QUICKSTART.md - Log examples
+
+---
+
+## 🙏 Credits
+
+Access logging designed for:
+- Production visibility
+- Security monitoring
+- Developer experience
+
+---
+
+## 📥 Installation
+
+```bash
+# From PyPI (coming soon)
+pip install orbit-framework
+
+# From source
+git clone https://github.com/yourusername/orbit.git
+cd orbit
+pip install -e .
+```
+
+---
+
+## 🎉 Summary
+
+**v1.0.2** makes Orbit production-ready with:
+- ✅ Complete access logging
+- ✅ Security event tracking
+- ✅ IP-based monitoring
+- ✅ Performance metrics
+- ✅ PyPI-ready package
+- ✅ Zero breaking changes
+
+**Upgrade now** for better visibility and security! 🚀
+
+---
+
+**Orbit v1.0.2** - See everything, secure everything. 👁️

orbit_web_framework-1.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Orbit Framework
+
+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.

orbit_web_framework-1.0.2/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include CHANGELOG_v1.0.1.md
+include CHANGELOG_v1.0.2.md
+include QUICKSTART.md
+recursive-include orbit *.py
+recursive-exclude * __pycache__
+recursive-exclude * *.pyc