Skip to main content

toonio is a package for sending data in the Toon format

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

language: Farsi -- Russian -- chinese

toonio is a package for sending data in the Toon format, which is several times faster than JSON.

This library also supports integration with Django views and provides compatibility for use in FastAPI as well.

The library offers two important features for Django. For example, you can create dynamic views that can return either JSON or Toon based on the request.

toonio — Django Integration Guide

Usage

pip install "toonio[django]"

Return Toon for all requests

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': [
        'toonio.django.render.ToonRenderer',
    ],
    'DEFAULT_PARSER_CLASSES': [
        'toonio.django.parser.ToonParser',
    ],
}

Enable dynamic mode (JSON or Toon based on headers)

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': [
         'toonio.django.render.DynamicRenderer',
    ],
    'DEFAULT_PARSER_CLASSES': [
        'toonio.django.parser.DynamicParser',
    ],
}

Header Examples

Send JSON → Receive Toon:

Content-Type: application/json
Accept: application/x-toon

Send Toon → Receive Toon:

Content-Type: application/x-toon
Accept: application/x-toon

Send Toon → Receive JSON:

Content-Type: application/x-toon
Accept: application/json

Per-View Configuration

Dynamic view

from toonio.django.parser import DynamicParser
from toonio.django.render import DynamicRenderer

class Index(APIView):
    parser_classes = [DynamicParser]
    renderer_classes = [DynamicRenderer]

    def get(self, request, *args, **kwargs):
        return Response({"message": "Hello Toon"})

Toon-only view

from toonio.django.parser import ToonParser
from toonio.django.render import ToonRenderer

class Index(APIView):
    parser_classes = [ToonParser]
    renderer_classes = [ToonRenderer]

    def get(self, request, *args, **kwargs):
        return Response({"message": "Hello Toon"})

Usage in FastApi:

pip install "toonio[standard]"
from fastapi import FastAPI

from toonio.response import Response
from toonio.status import HTTP_200_OK

app = FastAPI()


@app.get("/")
def hello_toon():
    return Response({"Hello": "Toon"}, status_code=HTTP_200_OK) # Return Toon Response

Contributing

We warmly welcome all contributions to Toonio! Whether you have an idea for improvement, found a bug, or want to add a new feature, we would be happy to have your help.

How to contribute

For small changes, feel free to open a Pull Request directly.

For larger features or significant changes, please open an Issue first so we can discuss the approach together.

Make sure your code is clean, readable, and includes any necessary tests.

🐞 Reporting Issues

If you encounter a problem:

First check whether the issue has already been reported.

If not, please open a New Issue with:

A clear description of the problem

Steps to reproduce

Python/framework/OS versions

Any relevant logs or error messages

We do our best to respond and fix issues as quickly as possible.

Toonio License (MIT-based Open License)

Copyright (c) 2025 Toonio Developers

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.

This project is completely free and open-source.
There are no costs, no licensing fees, no subscription requirements, and
you are free to use it in personal, educational, and commercial projects.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

toonio-0.1.2.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

toonio-0.1.2-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file toonio-0.1.2.tar.gz.

File metadata

  • Download URL: toonio-0.1.2.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for toonio-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6e1debc64ddf2a6a42c00fa48c23aa19bad0e1667feac885beb4d8d0c157edeb
MD5 137cf554fce76bb633d93a984c755be8
BLAKE2b-256 c9122fe014a3b1af71b7ff4199087884dfc32d56f31d0ffbf78b35223003e78b

See more details on using hashes here.

File details

Details for the file toonio-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: toonio-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for toonio-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fa42c0fbde2ca2ede82a070a705c1ca4201a00cd70054c42d85c96e619d5cfb8
MD5 7ba9f23876818044815a4ff3f93a7208
BLAKE2b-256 ab189308f04c18c9683dea5b00e9b30c0f37448b4d003fad153093a9e046ff27

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page