drf-toon 0.1.0__tar.gz

drf_toon-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.3
+Name: drf-toon
+Version: 0.1.0
+Summary: Native TOON parser and renderer for Django Rest Framework.
+Author: Dash Winterson
+Author-email: Dash Winterson <dashdanw@gmail.com>
+Requires-Dist: django>=5.2,<6.0
+Requires-Dist: djangorestframework>=3.15
+Requires-Dist: djangorestframework-stubs>=3.15
+Requires-Dist: toons>=0.7.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# drf-toon
+
+Native [TOON](https://toonformat.dev/) (Token Oriented Object Notation) parser and renderer for [Django REST Framework](https://www.django-rest-framework.org/).
+
+TOON is a token-efficient serialization format designed for LLM contexts. It can result in **30–60% fewer tokens** than JSON.
+
+`drf-toon` is built on [`toons`](https://github.com/alesanfra/toons), a high-performance Rust implementation meant to mimic the native python `json` package.
+
+## Compatibility
+
+`drf-toon` supports **Django 5.2 LTS** on **Python 3.10–3.13**, matching
+Django's own [support matrix](https://docs.djangoproject.com/en/stable/faq/install/#what-python-version-can-i-use-with-django).
+Every supported Python version is exercised in CI.
+
+| Django  | Python                 |
+| ------- | ---------------------- |
+| 5.2 LTS | 3.10, 3.11, 3.12, 3.13 |
+
+Support for additional Django releases can be added later by extending the CI
+matrix.
+
+## Installation
+
+```bash
+pip install drf-toon
+```
+
+## Usage
+
+Add the parser and renderer to your DRF settings:
+
+```python
+# settings.py
+REST_FRAMEWORK = {
+    "DEFAULT_PARSER_CLASSES": [
+        "drf_toon.parsers.TOONParser",
+        "rest_framework.parsers.JSONParser",
+    ],
+    "DEFAULT_RENDERER_CLASSES": [
+        "drf_toon.renderers.TOONRenderer",
+        "rest_framework.renderers.JSONRenderer",
+    ],
+}
+```
+
+Or enable them per-view:
+
+```python
+from rest_framework.views import APIView
+from rest_framework.response import Response
+
+from drf_toon.parsers import TOONParser
+from drf_toon.renderers import TOONRenderer
+
+
+class UserView(APIView):
+    parser_classes = [TOONParser]
+    renderer_classes = [TOONRenderer]
+
+    def get(self, request):
+        return Response({"name": "Alice", "age": 30})
+```
+
+Both classes use the `application/toon` media type. Send requests with
+`Content-Type: application/toon` to parse, and `Accept: application/toon`
+(or `?format=toon`) to render.
+
+## Development
+
+Install the dev dependencies and run the checks with uv:
+
+```bash
+uv sync --dev
+
+uv run ruff check .          # lint
+uv run ruff format .         # format
+uv run ruff format --check . # format check (CI)
+uv run mypy                  # type check
+uv run pytest                # tests + coverage
+```
+
+Optionally install the git hooks:
+
+```bash
+uv run pre-commit install --install-hooks
+```
+
+This wires up both a **pre-commit** hook (autofix + format) and a **pre-push**
+hook that blocks the push if the code is not properly linted/formatted.
+
+## License
+
+MIT

drf_toon-0.1.0/README.md

@@ -0,0 +1,93 @@
+# drf-toon
+
+Native [TOON](https://toonformat.dev/) (Token Oriented Object Notation) parser and renderer for [Django REST Framework](https://www.django-rest-framework.org/).
+
+TOON is a token-efficient serialization format designed for LLM contexts. It can result in **30–60% fewer tokens** than JSON.
+
+`drf-toon` is built on [`toons`](https://github.com/alesanfra/toons), a high-performance Rust implementation meant to mimic the native python `json` package.
+
+## Compatibility
+
+`drf-toon` supports **Django 5.2 LTS** on **Python 3.10–3.13**, matching
+Django's own [support matrix](https://docs.djangoproject.com/en/stable/faq/install/#what-python-version-can-i-use-with-django).
+Every supported Python version is exercised in CI.
+
+| Django  | Python                 |
+| ------- | ---------------------- |
+| 5.2 LTS | 3.10, 3.11, 3.12, 3.13 |
+
+Support for additional Django releases can be added later by extending the CI
+matrix.
+
+## Installation
+
+```bash
+pip install drf-toon
+```
+
+## Usage
+
+Add the parser and renderer to your DRF settings:
+
+```python
+# settings.py
+REST_FRAMEWORK = {
+    "DEFAULT_PARSER_CLASSES": [
+        "drf_toon.parsers.TOONParser",
+        "rest_framework.parsers.JSONParser",
+    ],
+    "DEFAULT_RENDERER_CLASSES": [
+        "drf_toon.renderers.TOONRenderer",
+        "rest_framework.renderers.JSONRenderer",
+    ],
+}
+```
+
+Or enable them per-view:
+
+```python
+from rest_framework.views import APIView
+from rest_framework.response import Response
+
+from drf_toon.parsers import TOONParser
+from drf_toon.renderers import TOONRenderer
+
+
+class UserView(APIView):
+    parser_classes = [TOONParser]
+    renderer_classes = [TOONRenderer]
+
+    def get(self, request):
+        return Response({"name": "Alice", "age": 30})
+```
+
+Both classes use the `application/toon` media type. Send requests with
+`Content-Type: application/toon` to parse, and `Accept: application/toon`
+(or `?format=toon`) to render.
+
+## Development
+
+Install the dev dependencies and run the checks with uv:
+
+```bash
+uv sync --dev
+
+uv run ruff check .          # lint
+uv run ruff format .         # format
+uv run ruff format --check . # format check (CI)
+uv run mypy                  # type check
+uv run pytest                # tests + coverage
+```
+
+Optionally install the git hooks:
+
+```bash
+uv run pre-commit install --install-hooks
+```
+
+This wires up both a **pre-commit** hook (autofix + format) and a **pre-push**
+hook that blocks the push if the code is not properly linted/formatted.
+
+## License
+
+MIT

drf_toon-0.1.0/pyproject.toml

@@ -0,0 +1,78 @@
+[project]
+name = "drf-toon"
+version = "0.1.0"
+description = "Native TOON parser and renderer for Django Rest Framework."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "django>=5.2,<6.0",
+    "djangorestframework>=3.15",
+    "djangorestframework-stubs>=3.15",
+    "toons>=0.7.0",
+]
+
+[[project.authors]]
+name = "Dash Winterson"
+email = "dashdanw@gmail.com"
+
+[build-system]
+requires = ["uv_build>=0.11.24,<0.12.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "drf-spectacular>=0.27.0",
+    "mypy>=1.10.0",
+    "pre-commit>=3.7.0",
+    "pytest>=8.0.0",
+    "pytest-cov>=5.0.0",
+    "pytest-django>=4.8.0",
+    "ruff>=0.6.0",
+]
+
+[tool.pytest.ini_options]
+python_files = ["test_*.py"]
+testpaths = ["tests"]
+addopts = "--cov=drf_toon --cov-report=term-missing"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+src = [
+    "src",
+    "tests",
+]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "W",
+    "F",
+    "I",
+    "B",
+    "UP",
+    "C4",
+]
+ignore = []
+
+[tool.ruff.lint.isort]
+known-first-party = ["drf_toon"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.mypy]
+python_version = "3.10"
+files = [
+    "src",
+    "tests",
+]
+ignore_missing_imports = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+
+[tool.coverage.run]
+source = ["drf_toon"]
+
+[tool.coverage.report]
+show_missing = true

drf_toon-0.1.0/pyproject.toml.orig

@@ -0,0 +1,73 @@
+[project]
+name = "drf-toon"
+version = "0.1.0"
+description = "Native TOON parser and renderer for Django Rest Framework."
+readme = "README.md"
+authors = [
+    { name = "Dash Winterson", email = "dashdanw@gmail.com" }
+]
+requires-python = ">=3.10"
+dependencies = [
+    "django>=5.2,<6.0",
+    "djangorestframework>=3.15",
+    "djangorestframework-stubs>=3.15",
+    "toons>=0.7.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.11.24,<0.12.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "drf-spectacular>=0.27.0",
+    "mypy>=1.10.0",
+    "pre-commit>=3.7.0",
+    "pytest>=8.0.0",
+    "pytest-cov>=5.0.0",
+    "pytest-django>=4.8.0",
+    "ruff>=0.6.0",
+]
+
+
+[tool.pytest.ini_options]
+python_files = ["test_*.py"]
+testpaths = ["tests"]
+addopts = "--cov=drf_toon --cov-report=term-missing"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle errors
+    "W",    # pycodestyle warnings
+    "F",    # pyflakes
+    "I",    # isort
+    "B",    # flake8-bugbear
+    "UP",   # pyupgrade
+    "C4",   # flake8-comprehensions
+]
+ignore = []
+
+[tool.ruff.lint.isort]
+known-first-party = ["drf_toon"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.mypy]
+python_version = "3.10"
+files = ["src", "tests"]
+ignore_missing_imports = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+
+[tool.coverage.run]
+source = ["drf_toon"]
+
+[tool.coverage.report]
+show_missing = true
+

drf_toon-0.1.0/src/drf_toon/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class TOONConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "drf_toon"

drf_toon-0.1.0/src/drf_toon/parsers.py

@@ -0,0 +1,20 @@
+import codecs
+
+import toons
+from django.conf import settings
+from rest_framework.exceptions import ParseError
+from rest_framework.parsers import BaseParser
+
+
+class TOONParser(BaseParser):
+    media_type = "application/toon"
+
+    def parse(self, stream, media_type=None, parser_context=None):
+        parser_context = parser_context or {}
+        encoding = parser_context.get("encoding", settings.DEFAULT_CHARSET)
+        decoded_stream = codecs.getreader(encoding)(stream)
+
+        try:
+            return toons.load(decoded_stream)
+        except toons.ToonDecodeError as e:
+            raise ParseError(f"TOON parse error - {str(e)}") from e

drf_toon-0.1.0/src/drf_toon/renderers.py

@@ -0,0 +1,10 @@
+import toons
+from rest_framework.renderers import BaseRenderer
+
+
+class TOONRenderer(BaseRenderer):
+    media_type = "application/toon"
+    format = "toon"
+
+    def render(self, data, accepted_media_type=None, renderer_context=None):
+        return toons.dumps(data).encode(self.charset)