huncholaneEnhanced time synchronization for drf views.
edit readme
huncholane1 file changed, +13 -13
+13-13README.md
| @@ -9,7 +9,7 @@ It adds a structured way to compare client and server timestamps, detect when up | ||
| 9 | 9 | ## Features |
| 10 | 10 | |
| 11 | 11 | - ✅ `PlusRequest`: subclass of DRF’s `Request` with timestamp parsing & comparison |
| 12 | -- 🧠 `TimestampOp`: context-aware timestamp diff logic (`client_is_newer`, etc.) | |
| 12 | +- 🧠 `TimestampOp`: context-aware timestamp diff logic (`raise_get`, etc.) | |
| 13 | 13 | - ⚙️ Configurable via `PlusRequestConf` (env vars or `settings.PLUSREQUEST_CONF`) |
| 14 | 14 | - 🧾 Typed request metadata with `Meta`, `PlusMeta`, and `DefaultMeta` |
| 15 | 15 | - 🔒 Built-in error handling for missing or invalid timestamps |
| @@ -47,15 +47,15 @@ def view(request: PlusRequest): | ||
| 47 | 47 | |
| 48 | 48 | The `TimestampOp` class is accessed via `request.top_builder(...)`. It automatically: |
| 49 | 49 | |
| 50 | -* Extracts server timestamps from a model instance | |
| 51 | -* Parses client timestamps from headers or body | |
| 52 | -* Validates datetime format | |
| 53 | -* Raises errors or returns status flags | |
| 50 | +- Extracts server timestamps from a model instance | |
| 51 | +- Parses client timestamps from headers or body | |
| 52 | +- Validates datetime format | |
| 53 | +- Raises errors or returns status flags | |
| 54 | 54 | |
| 55 | 55 | ### Supported behaviors |
| 56 | 56 | |
| 57 | -* `raise_get` | |
| 58 | -* `raise_update` | |
| 57 | +- `raise_get` | |
| 58 | +- `raise_update` | |
| 59 | 59 | |
| 60 | 60 | --- |
| 61 | 61 | |
| @@ -89,17 +89,17 @@ def view(request: PlusRequest): | ||
| 89 | 89 | |
| 90 | 90 | ### Meta Types |
| 91 | 91 | |
| 92 | -* `DefaultMeta`: Core Django fields (e.g. `HTTP_HOST`, `REQUEST_METHOD`) | |
| 93 | -* `PlusMeta`: Common API headers (e.g. `HTTP_AUTHORIZATION`, `HTTP_X_APP_VERSION`) | |
| 94 | -* `Meta`: Union of both | |
| 92 | +- `DefaultMeta`: Core Django fields (e.g. `HTTP_HOST`, `REQUEST_METHOD`) | |
| 93 | +- `PlusMeta`: Common API headers (e.g. `HTTP_AUTHORIZATION`, `HTTP_X_APP_VERSION`) | |
| 94 | +- `Meta`: Union of both | |
| 95 | 95 | |
| 96 | 96 | --- |
| 97 | 97 | |
| 98 | 98 | ## Exceptions |
| 99 | 99 | |
| 100 | -* `InvalidClientDatetimeField` | |
| 101 | -* `InvalidServerDatetimeField` | |
| 102 | -* `NoUpdate` | |
| 100 | +- `InvalidClientDatetimeField` | |
| 101 | +- `InvalidServerDatetimeField` | |
| 102 | +- `NoUpdate` | |
| 103 | 103 | |
| 104 | 104 | Raised when timestamps are missing, malformatted, or update should be skipped. |
| 105 | 105 |