django-bolt 0.1.0__cp310-abi3-win_amd64.whl → 0.1.1__cp310-abi3-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of django-bolt might be problematic. Click here for more details.

Files changed (56) hide show
  1. django_bolt/__init__.py +2 -2
  2. django_bolt/_core.pyd +0 -0
  3. django_bolt/_json.py +169 -0
  4. django_bolt/admin/static_routes.py +15 -21
  5. django_bolt/api.py +181 -61
  6. django_bolt/auth/__init__.py +2 -2
  7. django_bolt/decorators.py +15 -3
  8. django_bolt/dependencies.py +30 -24
  9. django_bolt/error_handlers.py +2 -1
  10. django_bolt/openapi/plugins.py +3 -2
  11. django_bolt/openapi/schema_generator.py +65 -20
  12. django_bolt/pagination.py +2 -1
  13. django_bolt/responses.py +3 -2
  14. django_bolt/serialization.py +5 -4
  15. {django_bolt-0.1.0.dist-info → django_bolt-0.1.1.dist-info}/METADATA +179 -197
  16. {django_bolt-0.1.0.dist-info → django_bolt-0.1.1.dist-info}/RECORD +18 -55
  17. django_bolt/auth/README.md +0 -464
  18. django_bolt/auth/REVOCATION_EXAMPLE.md +0 -391
  19. django_bolt/tests/__init__.py +0 -0
  20. django_bolt/tests/admin_tests/__init__.py +0 -1
  21. django_bolt/tests/admin_tests/conftest.py +0 -6
  22. django_bolt/tests/admin_tests/test_admin_with_django.py +0 -278
  23. django_bolt/tests/admin_tests/urls.py +0 -9
  24. django_bolt/tests/cbv/__init__.py +0 -0
  25. django_bolt/tests/cbv/test_class_views.py +0 -570
  26. django_bolt/tests/cbv/test_class_views_django_orm.py +0 -703
  27. django_bolt/tests/cbv/test_class_views_features.py +0 -1173
  28. django_bolt/tests/cbv/test_class_views_with_client.py +0 -622
  29. django_bolt/tests/conftest.py +0 -165
  30. django_bolt/tests/test_action_decorator.py +0 -399
  31. django_bolt/tests/test_auth_secret_key.py +0 -83
  32. django_bolt/tests/test_decorator_syntax.py +0 -159
  33. django_bolt/tests/test_error_handling.py +0 -481
  34. django_bolt/tests/test_file_response.py +0 -192
  35. django_bolt/tests/test_global_cors.py +0 -172
  36. django_bolt/tests/test_guards_auth.py +0 -441
  37. django_bolt/tests/test_guards_integration.py +0 -303
  38. django_bolt/tests/test_health.py +0 -283
  39. django_bolt/tests/test_integration_validation.py +0 -400
  40. django_bolt/tests/test_json_validation.py +0 -536
  41. django_bolt/tests/test_jwt_auth.py +0 -327
  42. django_bolt/tests/test_jwt_token.py +0 -458
  43. django_bolt/tests/test_logging.py +0 -837
  44. django_bolt/tests/test_logging_merge.py +0 -419
  45. django_bolt/tests/test_middleware.py +0 -492
  46. django_bolt/tests/test_middleware_server.py +0 -230
  47. django_bolt/tests/test_model_viewset.py +0 -323
  48. django_bolt/tests/test_models.py +0 -24
  49. django_bolt/tests/test_pagination.py +0 -1258
  50. django_bolt/tests/test_parameter_validation.py +0 -178
  51. django_bolt/tests/test_syntax.py +0 -626
  52. django_bolt/tests/test_testing_utilities.py +0 -163
  53. django_bolt/tests/test_testing_utilities_simple.py +0 -123
  54. django_bolt/tests/test_viewset_unified.py +0 -346
  55. {django_bolt-0.1.0.dist-info → django_bolt-0.1.1.dist-info}/WHEEL +0 -0
  56. {django_bolt-0.1.0.dist-info → django_bolt-0.1.1.dist-info}/entry_points.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: django-bolt
3
- Version: 0.1.0
3
+ Version: 0.1.1
4
4
  Classifier: Development Status :: 3 - Alpha
5
5
  Classifier: Intended Audience :: Developers
6
6
  Classifier: License :: OSI Approved :: MIT License
@@ -42,32 +42,23 @@ Project-URL: Bug Tracker, https://github.com/FarhanAliRaza/django-bolt/issues
42
42
  <div align="center">
43
43
  <img src="docs/logo.png" alt="Django-Bolt Logo" width="400"/>
44
44
 
45
- [![Seeking Remote Work](https://img.shields.io/badge/🌍-Actively%20Seeking%20Remote%20Work-success?style=for-the-badge)](mailto:farhanalirazaazeemi@gmail.com)
46
- </div>
45
+ [![Seeking Remote Work](https://img.shields.io/badge/🌍-Actively%20Seeking%20Remote%20Work-success?style=for-the-badge)](mailto:farhanalirazaazeemi@gmail.com)
47
46
 
48
- **High-Performance Fully Typed API Framework for Django**
47
+ </div>
49
48
 
50
- Django-Bolt is a high-performance API framework for Django that provides Rust-powered API endpoints capable of **60k+ RPS** performance. Similar to Django REST Framework or Django Ninja, it integrates seamlessly with existing Django projects while leveraging Actix Web for HTTP handling, PyO3 to bridge Python async handlers with Rust's async runtime, msgspec for fast serialization, and supports multi-process scaling with SO_REUSEPORT.
49
+ # High-Performance Fully Typed API Framework for Django
51
50
 
52
- **Key Features:**
53
-
54
- - 🚀 **High Performance** - Rust-powered HTTP server (Actix Web + Tokio + PYO3)
55
- - 🔐 **Authentication in Rust** - JWT/API Key validation without Python GIL
56
- - 📦 **msgspec Serialization** - 5-10x faster than standard JSON
57
- - 🎯 **Django Integration** - Use your existing Django models and other django features you love (django admin, django packages (All django packages will work except that use django middlware for now. I will work on some compatibilty layer to make them work but it is not a priority right now) )
58
- - 🔄 **Async/Await** - Full async support with Python coroutines
59
- - 🎛️ **Middleware System** - CORS, rate limiting, compression, custom middleware
60
- - 🔒 **Guards & Permissions** - DRF and litestar inspired route protection
61
-
62
- ---
51
+ Your first question might be: why? Well, consider this: **Faster than _FastAPI_, but with Django ORM, Django Admin, and Django packages**. That’s exactly what this project achieves. Django-Bolt is a high-performance API framework for Django, providing Rust-powered API endpoints capable of 60k+ RPS. Similar to Django REST Framework or Django Ninja, it integrates seamlessly with existing Django projects while leveraging Actix Web for HTTP handling, PyO3 to bridge Python async handlers with Rust's async runtime, and msgspec for fast serialization. You can deploy it directly—no gunicorn or uvicorn needed.
63
52
 
64
53
  ## 🚀 Quick Start
65
54
 
66
- ### Installation
55
+ ### Installation 🎉
67
56
 
68
- COMING VERY SOON NEAR YOUR DJANGO PROJECTS
57
+ ```bash
58
+ pip install django-bolt
59
+ ```
69
60
 
70
- For now you can build and use it locally if you want.
61
+ **📖 Full Documentation:** (Coming Soon).
71
62
 
72
63
  ### Run Your First API
73
64
 
@@ -93,34 +84,54 @@ async def get_user(user_id: int) -> UserSchema: # 🎉 Reponse is type validated
93
84
 
94
85
  ```bash
95
86
  # Start the server
96
- python manage.py runbolt --host 0.0.0.0 --port 8000 --processes 4 --workers 1
87
+ python manage.py runbolt --dev # for development with reload enabled
88
+ [django-bolt] OpenAPI docs enabled at /docs
89
+ [django-bolt] Django admin enabled at http://0.0.0.0:8000/admin/ #django admin
90
+ [django-bolt] Static files serving enabled
91
+ [django-bolt] Found 94 routes
92
+ [django-bolt] Registered middleware for 83 handlers
93
+ [django-bolt] Starting server on http://0.0.0.0:8000
94
+ [django-bolt] Workers: 1, Processes: 1
95
+ [django-bolt] OpenAPI docs enabled at http://0.0.0.0:8000/docs/ #swagger docs builtin
96
+
97
97
  # processes are python processes that handle request 1 actix worker
98
98
  ```
99
99
 
100
100
  ---
101
101
 
102
+ **Key Features:**
103
+
104
+ - 🚀 **High Performance** - Rust-powered HTTP server (Actix Web + Tokio + PyO3)
105
+ - 🔐 **Authentication in Rust** - JWT/API Key/Session validation without Python GIL
106
+ - 📦 **msgspec Serialization** - 5-10x faster than standard JSON
107
+ - 🎯 **Django Integration** - Use your existing Django models and other django features you love (django admin, django packages)
108
+ - 🔄 **Async/Await** - Full async support with Python coroutines
109
+ - 🎛️ **Middleware System** - CORS, rate limiting, compression (gzip/brotli/zstd)
110
+ - 🔒 **Guards & Permissions** - DRF and Litestar inspired route protection
111
+ - 📚 **OpenAPI Support** - 7 render plugins (Swagger, ReDoc, Scalar, RapidDoc, Stoplight, JSON, YAML)
112
+ - 📡 **Streaming Responses** - SSE, long-polling, async generators
113
+ - 🎨 **Class-Based Views** - ViewSet and ModelViewSet with DRF-style conventions
114
+
102
115
  ## 📊 Performance Benchmarks
103
116
 
104
117
  > **⚠️ Disclaimer:** Django-Bolt is a **feature-incomplete framework** currently in development. Benchmarks were run on a Ryzen 5600G with 16GB RAM (8 processes × 1 worker, C=100 N=10000) on localhost. Performance will vary significantly based on hardware, OS, configuration, and workload.
105
118
  >
106
- > **📁 Resources:** Example project available at [python/examples/testproject/](python/examples/testproject/). Run benchmarks with `make save-bench` or see [scripts/benchmark.sh](scripts/benchmark.sh).
119
+ > **📁 Resources:** Example project available at [python/example/](python/example/). Run benchmarks with `make save-bench` or see [scripts/benchmark.sh](scripts/benchmark.sh).
107
120
 
108
121
  | Endpoint Type | Requests/sec |
109
122
  | -------------------------- | --------------- |
110
- | Root endpoint | **~86,500 RPS** |
111
- | JSON parsing/validation | **~81,000 RPS** |
112
- | Path + Query params | **~62,500 RPS** |
113
- | HTML/Redirect responses | **~88,000 RPS** |
114
- | Form data handling | **~69,000 RPS** |
115
- | ORM reads (SQLite, 10 rec) | **~12,000 RPS** |
123
+ | Root endpoint | **~85,000 RPS** |
124
+ | JSON parsing/validation | **~80,000 RPS** |
125
+ | Path + Query params | **~83,500 RPS** |
126
+ | HTML/Redirect responses | **~86,000 RPS** |
127
+ | Form data handling | **~68,000 RPS** |
128
+ | ORM reads (SQLite, 10 rec) | **~15,000 RPS** |
116
129
 
117
130
  **Why so fast?**
118
131
 
119
- - Authentication and guards run in Rust without the Python GIL
132
+ - HTTP Parsing and Reponse is handled Actix-rs framework(One of the fastest in the world)
120
133
  - Request routing uses matchit (zero-copy path matching)
121
- - No middleware overhead if not required
122
134
  - JSON serialization with msgspec
123
- - Multi-process with SO_REUSEPORT (kernel-level load balancing)
124
135
 
125
136
  ---
126
137
 
@@ -169,17 +180,25 @@ python manage.py runbolt --host 0.0.0.0 --port 8000 --processes 4 --workers 1
169
180
 
170
181
  - Algorithms: HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512
171
182
  - Token validation in Rust (zero Python overhead)
172
- - Expiration validation
173
- - Custom claims support
183
+ - Expiration validation (`exp`) and not-before (`nbf`) checks
184
+ - Custom claims support with audience/issuer validation
174
185
  - Django User integration helpers
175
- - Token revocation support (optional)
186
+ - Token revocation support (optional: `InMemoryRevocation`, `DjangoCacheRevocation`, `DjangoORMRevocation`)
176
187
 
177
- - ✅ **API Key Authentication** - **Partial** (runs in Rust without GIL)
188
+ - ✅ **API Key Authentication** - **Complete** (runs in Rust without GIL)
178
189
 
179
- - Header-based API keys
190
+ - Header-based API keys (Bearer or ApiKey prefix)
180
191
  - Per-key permissions
192
+ - Constant-time comparison (timing attack prevention)
181
193
  - Fast validation in Rust
182
194
 
195
+ - ✅ **Session Authentication** - **Complete** (Django session integration)
196
+
197
+ - Django session backend integration
198
+ - Automatic user lookup from session
199
+ - Compatible with Django's session middleware
200
+ - Supports both cookie-based and custom session stores
201
+
183
202
  - ✅ **Permission Guards** (all run in Rust):
184
203
 
185
204
  - `AllowAny()` - Public access
@@ -190,81 +209,28 @@ python manage.py runbolt --host 0.0.0.0 --port 8000 --processes 4 --workers 1
190
209
  - `HasAnyPermission("p1", "p2")` - OR logic
191
210
  - `HasAllPermissions("p1", "p2")` - AND logic
192
211
 
193
- - ✅ **Auth Context** - Request-level auth context with user info
212
+ - ✅ **Auth Context** - Request-level auth context with user info, permissions, and backend details
194
213
  - ✅ **Token Utilities**:
195
214
 
196
- - `create_jwt_for_user(user)` - Generate JWT for Django User
215
+ - `create_jwt_for_user(user, exp_hours=24)` - Generate JWT for Django User
216
+ - Custom claims and permissions support
197
217
 
198
- - **Token Revocation** (optional):
199
- - `InMemoryRevocation` - In-memory token blacklist
200
- - `DjangoCacheRevocation` - Cache-based revocation
201
- - `DjangoORMRevocation` - Database-backed revocation
218
+ **📖 See [docs/SECURITY.md](docs/SECURITY.md) for complete authentication documentation.**
202
219
 
203
220
  ### Developer Tools ✅
204
221
 
205
222
  - ✅ **CLI** - `python -m django_bolt init` for project setup
206
- - ✅ **Management Command** - `python manage.py runbolt`
207
- - ✅ **Auto-Discovery** - Finds APIs in all Django apps
208
- - ⚠️ **Error Messages** - Clear error messages (In Progress)
223
+ - ✅ **Management Command** - `python manage.py runbolt` with auto-discovery
224
+ - ✅ **Auto-Discovery** - Finds `api.py` in project root and all Django apps
225
+ - **OpenAPI/Swagger** - 7 render plugins: Swagger UI, ReDoc, Scalar, RapidDoc, Stoplight Elements, JSON, YAML
226
+ - ✅ **Error Messages** - Clear, structured error messages with Django DEBUG integration
209
227
  - ✅ **Type Hints** - Full type hint support with msgspec
228
+ - ✅ **Dependency Injection** - `Depends()` marker with per-request caching
210
229
 
211
- ---
212
-
213
- ## 📋 TODO / Roadmap
214
-
215
- ### Must Have (Blockers) 🚨
216
-
217
- - ✅ **Core API functionality** - DONE
218
- - ✅ **Authentication** - DONE (JWT complete)
219
- - ✅ **Tests passing** - DONE (142 passed)
220
- - ✅ **Better error messages** - DONE (Enhanced exception system with structured errors)
221
- - ✅ **Health check endpoints** - DONE (`/health`, `/ready` with custom checks)
222
- - ✅ **Request/Response logging** - DONE (Integrates with Django's logging)
223
- - ❌ **PyPI package** - Missing (currently manual install)
224
-
225
- ### Should Have (Important) 🎯
226
-
227
- - ✅ **Error handling with Django DEBUG integration** - DONE
228
- - ✅ **Structured error responses** (FastAPI-compatible) - DONE
229
- - ✅ **Response compression** - DONE (gzip/brotli/zstd)
230
- - ✅ **OpenAPI/Swagger docs** - DONE (some parts remaining like grouping)
231
- - ✅ **Django admin integration** - DONE
232
- - ⚠️ **API Key auth** - Partial (only in-memory)
233
- - ⚠️ **Testing utilities** - Partial
234
-
235
- ### Nice to Have (Can defer) 📝
236
-
237
- - [ ] **Static file serving** - Efficient static file serving from Rust
238
- - [ ] **Pagination helpers** - Built-in pagination utilities
239
- - [ ] **OAuth2/OpenID** - OAuth2 and OpenID Connect support
240
- - [ ] **API Versioning** - URL/header-based versioning
241
- - [ ] **Content Negotiation** - Accept header-based content negotiation
242
- - [ ] **ETags & Conditional Requests** - Caching optimization
243
- - [ ] **Filtering & Sorting** - Query parameter-based filtering
230
+ **📖 See [docs/README.md](docs/README.md) for complete documentation index.**
244
231
 
245
232
  ---
246
233
 
247
- ## 🏗️ Architecture
248
-
249
- ### Core Components
250
-
251
- 1. **[src/lib.rs](src/lib.rs)** - Main Rust entry point, exposes PyO3 module
252
- 2. **[src/server.rs](src/server.rs)** - Actix Web server with multi-worker tokio runtime
253
- 3. **[src/router.rs](src/router.rs)** - matchit-based routing
254
- 4. **[src/middleware/](src/middleware/)** - Middleware pipeline
255
- - `auth.rs` - JWT/API Key authentication (zero GIL overhead)
256
- - `cors.rs` - CORS handling
257
- - `rate_limit.rs` - Token bucket rate limiting
258
- 5. **[src/permissions.rs](src/permissions.rs)** - Guard evaluation
259
- 6. **[python/django_bolt/api.py](python/django_bolt/api.py)** - Python decorator-based API
260
- 7. **[python/django_bolt/auth/](python/django_bolt/auth/)** - Authentication system
261
- - `backends.py` - Auth backend classes (compile to Rust metadata)
262
- - `guards.py` - Permission guard classes
263
- - `jwt_utils.py` - JWT utilities for Django User integration
264
- - `middleware.py` - Middleware decorators
265
- - `token.py` - Token handling
266
- - `revocation.py` - Token revocation stores
267
-
268
234
  ### Request Flow
269
235
 
270
236
  ```
@@ -276,9 +242,10 @@ HTTP Request → Actix Web (Rust)
276
242
  - CORS
277
243
  - Rate Limiting
278
244
 
279
- Authentication (Rust - no GIL for most part may require in future)
280
- - JWT validation
281
- - API Key validation
245
+ Authentication (Rust - no GIL)
246
+ - JWT validation (HS256/384/512, RS256/384/512, ES256/384)
247
+ - API Key validation (constant-time comparison)
248
+ - Session validation (Django session integration)
282
249
 
283
250
  Guards/Permissions (Rust - no GIL)
284
251
  - IsAuthenticated
@@ -300,6 +267,20 @@ HTTP Request → Actix Web (Rust)
300
267
 
301
268
  ---
302
269
 
270
+ ## 📖 Documentation (Coming Soon)
271
+
272
+ - **[Getting Started Guide](docs/GETTING_STARTED.md)** - Complete tutorial from installation to first API
273
+ - **[Security Guide](docs/SECURITY.md)** - Authentication, authorization, CORS, rate limiting
274
+ - **[Middleware Guide](docs/MIDDLEWARE.md)** - CORS, rate limiting, custom middleware
275
+ - **[Responses Guide](docs/RESPONSES.md)** - All response types and streaming
276
+ - **[Class-Based Views](docs/CLASS_BASED_VIEWS.md)** - ViewSet and ModelViewSet patterns
277
+ - **[OpenAPI Guide](docs/OPENAPI.md)** - Auto-generated API documentation
278
+ - **[Pagination Guide](docs/PAGINATION.md)** - PageNumber, LimitOffset, Cursor pagination
279
+ - **[Logging Guide](docs/LOGGING.md)** - Request/response logging and metrics
280
+ - **[Full Documentation Index](docs/README.md)** - Complete list of all documentation
281
+
282
+ ---
283
+
303
284
  ## 📖 Usage Examples
304
285
 
305
286
  ### Basic Routes
@@ -344,6 +325,7 @@ async def create_user(user: CreateUserRequest):
344
325
  from django_bolt import BoltAPI
345
326
  from django_bolt.auth import (
346
327
  JWTAuthentication,
328
+ APIKeyAuthentication,
347
329
  IsAuthenticated,
348
330
  IsAdminUser,
349
331
  HasPermission,
@@ -351,25 +333,25 @@ from django_bolt.auth import (
351
333
 
352
334
  api = BoltAPI()
353
335
 
354
- # Require JWT authentication
336
+ # JWT Authentication
355
337
  @api.get(
356
338
  "/protected",
357
339
  auth=[JWTAuthentication()],
358
340
  guards=[IsAuthenticated()]
359
341
  )
360
342
  async def protected_route(request):
361
- auth_context = request.get("auth", {})
362
- user_id = auth_context.get("user_id")
343
+ auth = request.get("auth", {})
344
+ user_id = auth.get("user_id")
363
345
  return {"message": f"Hello, user {user_id}"}
364
346
 
365
- # Require admin access
347
+ # API Key Authentication
366
348
  @api.get(
367
- "/admin",
368
- auth=[JWTAuthentication()],
369
- guards=[IsAdminUser()]
349
+ "/api-data",
350
+ auth=[APIKeyAuthentication(api_keys={"key1", "key2"})],
351
+ guards=[IsAuthenticated()]
370
352
  )
371
- async def admin_only(request):
372
- return {"message": "Admin access"}
353
+ async def api_data(request):
354
+ return {"message": "API key authenticated"}
373
355
 
374
356
  # Permission-based access
375
357
  @api.post(
@@ -392,11 +374,13 @@ async def login(username: str, password: str):
392
374
  return {"access_token": token, "token_type": "bearer"}
393
375
  ```
394
376
 
377
+ **📖 See [docs/SECURITY.md](docs/SECURITY.md) for complete authentication documentation.**
378
+
395
379
  ### Middleware
396
380
 
397
381
  ```python
398
382
  from django_bolt import BoltAPI
399
- from django_bolt.auth import cors, rate_limit, skip_middleware
383
+ from django_bolt.middleware import cors, rate_limit, skip_middleware
400
384
 
401
385
  # Global middleware
402
386
  api = BoltAPI(
@@ -404,29 +388,38 @@ api = BoltAPI(
404
388
  "cors": {
405
389
  "origins": ["http://localhost:3000"],
406
390
  "methods": ["GET", "POST", "PUT", "DELETE"],
391
+ "credentials": True,
407
392
  }
408
393
  }
409
394
  )
410
395
 
411
- # Per-route rate limiting
396
+ # Per-route rate limiting (runs in Rust, no GIL)
412
397
  @api.get("/limited")
413
- @rate_limit(rps=10, burst=20)
398
+ @rate_limit(rps=100, burst=200, key="ip") # 100 req/s with burst of 200
414
399
  async def limited_endpoint():
415
- return {"message": "Rate limited to 10 req/s"}
400
+ return {"message": "Rate limited"}
401
+
402
+ # Rate limiting by user ID
403
+ @api.get("/user-limited", auth=[JWTAuthentication()], guards=[IsAuthenticated()])
404
+ @rate_limit(rps=50, burst=100, key="user")
405
+ async def user_limited():
406
+ return {"message": "Per-user rate limiting"}
416
407
 
417
408
  # Custom CORS for specific route
418
409
  @api.get("/public")
419
- @cors(origins=["*"])
410
+ @cors(origins=["https://example.com"], credentials=True, max_age=3600)
420
411
  async def public_endpoint():
421
412
  return {"message": "Public endpoint with CORS"}
422
413
 
423
414
  # Skip global middleware
424
415
  @api.get("/no-cors")
425
- @skip_middleware("cors")
416
+ @skip_middleware("cors", "rate_limit")
426
417
  async def no_cors():
427
- return {"message": "CORS disabled for this route"}
418
+ return {"message": "Middleware skipped"}
428
419
  ```
429
420
 
421
+ **📖 See [docs/MIDDLEWARE.md](docs/MIDDLEWARE.md) for complete middleware documentation.**
422
+
430
423
  ### Django ORM Integration
431
424
 
432
425
  ```python
@@ -464,7 +457,10 @@ async def list_articles(limit: int = 10):
464
457
 
465
458
  ```python
466
459
  from django_bolt import BoltAPI
467
- from django_bolt.responses import PlainText, HTML, Redirect, FileResponse
460
+ from django_bolt.responses import (
461
+ PlainText, HTML, Redirect, File, FileResponse, StreamingResponse
462
+ )
463
+ import asyncio
468
464
 
469
465
  api = BoltAPI()
470
466
 
@@ -478,25 +474,22 @@ async def html_response():
478
474
 
479
475
  @api.get("/redirect")
480
476
  async def redirect_response():
481
- return Redirect("/new-location")
482
-
483
- @api.get("/download")
484
- async def download_file():
485
- # Streams file from Rust (zero-copy)
486
- return FileResponse("/path/to/file.pdf", filename="document.pdf")
487
- ```
477
+ return Redirect("/new-location", status_code=302)
488
478
 
489
- ### Streaming Responses
490
-
491
- ```python
492
- from django_bolt import BoltAPI
493
- from django_bolt.responses import StreamingResponse
494
- import asyncio
479
+ @api.get("/download-memory")
480
+ async def download_memory():
481
+ # In-memory file download
482
+ content = b"File contents here"
483
+ return File(content, filename="document.txt", media_type="text/plain")
495
484
 
496
- api = BoltAPI()
485
+ @api.get("/download-disk")
486
+ async def download_disk():
487
+ # Streams file from disk (zero-copy in Rust)
488
+ return FileResponse("/path/to/file.pdf", filename="document.pdf")
497
489
 
498
- @api.get("/stream")
499
- async def stream_data():
490
+ @api.get("/stream-sse")
491
+ async def stream_sse():
492
+ # Server-Sent Events
500
493
  async def generate():
501
494
  for i in range(100):
502
495
  yield f"data: {i}\n\n"
@@ -506,8 +499,23 @@ async def stream_data():
506
499
  generate(),
507
500
  media_type="text/event-stream"
508
501
  )
502
+
503
+ @api.get("/stream-json")
504
+ async def stream_json():
505
+ # Streaming JSON (sync generator)
506
+ def generate():
507
+ yield '{"items": ['
508
+ for i in range(1000):
509
+ yield f'{{"id": {i}}}'
510
+ if i < 999:
511
+ yield ','
512
+ yield ']}'
513
+
514
+ return StreamingResponse(generate(), media_type="application/json")
509
515
  ```
510
516
 
517
+ **📖 See [docs/RESPONSES.md](docs/RESPONSES.md) for complete response documentation.**
518
+
511
519
  ---
512
520
 
513
521
  ## 🔧 Development
@@ -538,68 +546,11 @@ make rebuild # Clean and rebuild
538
546
 
539
547
  # Testing
540
548
  make test-py # Run Python tests
541
- make smoke # Quick smoke tests
542
- make orm-smoke # ORM-specific tests
543
549
 
544
550
  # Benchmarking
545
- make bench # Run benchmarks
546
551
  make save-bench # Run and save results
547
- make bench C=100 N=50000 # Custom benchmark
548
552
 
549
553
  # Server
550
- make run-bg HOST=127.0.0.1 PORT=8000 P=2 WORKERS=2
551
- ```
552
-
553
- ---
554
-
555
- ## 📁 Project Structure
556
-
557
- ```
558
- django-bolt/
559
- ├── src/ # Rust server code
560
- │ ├── lib.rs # PyO3 module entry point
561
- │ ├── server.rs # Actix Web server
562
- │ ├── router.rs # matchit routing
563
- │ ├── middleware/
564
- │ │ ├── mod.rs
565
- │ │ ├── auth.rs # JWT/API Key auth (no GIL)
566
- │ │ ├── cors.rs # CORS handling
567
- │ │ └── rate_limit.rs # Token bucket rate limiting
568
- │ ├── permissions.rs # Guard evaluation
569
- │ └── streaming.rs # Streaming response handling
570
- ├── python/django_bolt/ # Python framework
571
- │ ├── api.py # BoltAPI class, decorators
572
- │ ├── responses.py # Response types
573
- │ ├── exceptions.py # HTTP exceptions
574
- │ ├── params.py # Parameter markers
575
- │ ├── auth/ # Authentication system
576
- │ │ ├── __init__.py
577
- │ │ ├── backends.py # Auth backends
578
- │ │ ├── guards.py # Permission guards
579
- │ │ ├── middleware.py # Middleware decorators
580
- │ │ ├── jwt_utils.py # JWT utilities
581
- │ │ ├── token.py # Token handling
582
- │ │ └── revocation.py # Token revocation
583
- │ ├── management/commands/
584
- │ │ └── runbolt.py # Django management command
585
- │ ├── cli.py # django-bolt CLI
586
- │ ├── tests/ # Test suite
587
- │ │ ├── test_auth_secret_key.py
588
- │ │ ├── test_guards_auth.py
589
- │ │ ├── test_guards_integration.py
590
- │ │ ├── test_jwt_auth.py
591
- │ │ ├── test_jwt_token.py
592
- │ │ ├── test_middleware.py
593
- │ │ └── test_syntax.py
594
- │ └── bootstrap.py # Django setup helper
595
- └── python/examples/testproject/ # Example Django project
596
- ├── manage.py
597
- ├── testproject/
598
- │ ├── settings.py
599
- │ └── api.py # Example routes
600
- └── users/ # Example app
601
- ├── models.py
602
- └── api.py
603
554
  ```
604
555
 
605
556
  ---
@@ -618,12 +569,43 @@ Contributions welcome! Here's how:
618
569
 
619
570
  ### Areas That Need Help
620
571
 
621
- - Authentication
622
- - OpenAPI/Swagger generation
623
- - More comprehensive tests and test utilities
624
- - Documentation improvements
572
+ - Testing utilities and test client
573
+ - WebSocket support
574
+ - OAuth2/OpenID Connect
575
+ - API versioning
576
+ - More examples and tutorials
625
577
 
626
578
  ---
627
579
 
628
- **Built with by developers who need speed without sacrificing Python's elegance**
629
-
580
+ ## 🙏 Acknowledgments & Inspiration
581
+
582
+ Django-Bolt stands on the shoulders of giants. We're grateful to the following projects and communities that inspired our design and implementation:
583
+
584
+ ### Core Inspirations
585
+
586
+ - **[Django REST Framework](https://github.com/encode/django-rest-framework)** - Our syntax, ViewSet patterns, and permission system are heavily inspired by DRF's elegant API design. The class-based views and guard system follow DRF's philosophy of making common patterns simple.
587
+
588
+ - **[FastAPI](https://github.com/tivy520/fastapi)** - We drew extensive inspiration from FastAPI's dependency injection system, parameter extraction patterns, and modern Python type hints usage. The codebase structure and async patterns heavily influenced our implementation.
589
+
590
+ - **[Litestar](https://github.com/litestar-org/litestar)** - Our OpenAPI plugin system is adapted from Litestar's excellent architecture. Many architectural decisions around middleware, guards, and route handling were inspired by Litestar's design philosophy.
591
+
592
+ - **[Robyn](https://github.com/sparckles/Robyn)** - Robyn's Rust-Python integration patterns and performance-first approach influenced our decision to use PyO3 and showed us the potential of Rust-powered Python web frameworks.
593
+
594
+ ### Additional Credits
595
+
596
+ - **[Actix Web](https://github.com/actix/actix-web)** - The Rust HTTP framework that powers our performance
597
+ - **[PyO3](https://github.com/PyO3/pyo3)** - For making Rust-Python interop seamless
598
+ - **[msgspec](https://github.com/jcrist/msgspec)** - For blazing-fast serialization
599
+ - **[matchit](https://github.com/ibraheemdev/matchit)** - For zero-copy routing
600
+
601
+ Thank you to all the maintainers, contributors, and communities behind these projects. Django-Bolt wouldn't exist without your incredible work.
602
+
603
+ ---
604
+
605
+ ## 📄 License
606
+
607
+ Django-Bolt is open source and available under the MIT License.
608
+
609
+ ---
610
+
611
+ For questions, issues, or feature requests, please visit our [GitHub repository](https://github.com/FarhanAliRaza/django-bolt).