drf-orjson-rp 0.3.0

DRF renderer and parser based on orjson

DRF orjson renderer and parser

Rendering and parsing JSON with orjson. Made on example drf_orjson_renderer package.

Installation

• Install package

  pip install drf_orjson_rp
  

• Rewrite settings by example.

  REST_FRAMEWORK = {
      'DEFAULT_RENDERER_CLASSES': [
          # replace default json on orjson renderer
          'drf_orjson_rp.renderers.ORJSONRenderer',
          # defaults
          'rest_framework.renderers.BrowsableAPIRenderer',
      ],
      'DEFAULT_PARSER_CLASSES': [
          # replace default json on orjson parser
          'drf_orjson_rp.parsers.ORJSONParser',
          # defaults
          'rest_framework.parsers.FormParser',
          'rest_framework.parsers.MultiPartParser'
      ],
      # add orjson renderer option
      'ORJSON_RENDERER_OPTION': orjson.OPT_APPEND_NEWLINE | orjson.OPT_INDENT_2,
  }
  

• Check settings by default in source code DRF. DEFAULTS

• Renderer and parser made by example from source code DRF.

  • DRF Renderer
  • DRF Parser

Developing

• Clone your fork and cd into the repo directory

  git clone [e-mail]:<your username>/drf_orjson_rp.git
  cd drf_orjson_rp
  

• Create a virtual environment

  python3 -m venv .venv
  source .venv/bin/activate
  

• Install uv and dev dependencies

  pip install uv
  bash scripts/install.bash
  

• Run tests

  bash scripts/test.bash
  

• Run linters

  bash scripts/lint.bash
  

• Run test coverage

  bash scripts/coverage.bash
  

Links

• drf_ujson_renderer
• drf_orjson_renderer
• DRF stubs
• pydantic workflows
• fastapi scripts