https://github.com/jinkanhq/django-rest-tsg

A typescript code generator for Django Rest Framework.
https://github.com/jinkanhq/django-rest-tsg

codegen dataclasses django django-rest-framework typescript

Last synced: 3 months ago
JSON representation

A typescript code generator for Django Rest Framework.

• Host: GitHub
• URL: https://github.com/jinkanhq/django-rest-tsg
• Owner: jinkanhq
• License: mit
• Created: 2021-11-27T14:09:48.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-31T04:06:22.000Z (7 months ago)
• Last Synced: 2024-07-05T03:31:44.666Z (4 months ago)
• Topics: codegen, dataclasses, django, django-rest-framework, typescript
• Language: Python
• Homepage:
• Size: 60.5 KB
• Stars: 14
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-django-rest-framework - django-rest-tsg

README

        
.. |coverage-passing| image:: https://github.com/jinkanhq/django-rest-tsg/actions/workflows/coverage.yml/badge.svg

    :target: https://github.com/jinkanhq/django-rest-tsg/actions/workflows/coverage.yml

.. |coverage| image:: https://codecov.io/gh/jinkanhq/django-rest-tsg/branch/main/graph/badge.svg?token=LX8E3QB541

    :target: https://codecov.io/gh/jinkanhq/django-rest-tsg

.. |pypi| image:: https://badge.fury.io/py/django-rest-tsg.svg

    :target: https://badge.fury.io/py/django-rest-tsg

|coverage-passing| |coverage| |pypi|

django-rest-tsg

====================

A TypeScript code generator for Django Rest Framework, which saved your hand-working and guaranteed consistency

between Python codes and modern frontend codes written in TypeScript.

Features

----------

It generates TypeScript codes from following Python types.

* Django REST Framework serializers: manual working on ``Serializer``, ``ModelSerializer``

  derived from Django ORM models, ``DataclassSerializer`` via `djangorestframework-dataclasses`_.

* Python dataclasses: Classes decorated by ``dataclasses.dataclass``.

* Python enums: Subclasses of ``enum.Enum``.

It also supports nested types and composite types.

.. _djangorestframework-dataclasses: https://github.com/oxan/djangorestframework-dataclasses

Requirements

--------------

* Python >=3.9

* Django >=3.2

* Django REST Framework >=3.12

Usage

--------

Install using ``pip``.

.. code-block:: bash

  $ pip install django_rest_tsg

Put a ``tsgconfig.py`` file with build tasks into your django project's root.

.. code-block:: python

    from django.conf import settings

    from django_rest_tsg.build import build

    BUILD_DIR = settings.BASE_DIR / "app/src/core"

    BUILD_TASKS = [

        build(Foo),

        build(BarSerializer, {"alias": "Foobar"}),

    ]

Add ``django_rest_tsg`` to your ``INSTALLED_APPS``.

.. code-block:: python

    INSTALLED_APPS = [

        ...

        "django_rest_tsg"

    ]

Run ``buildtypescript`` command on ``manage.py``.

.. code-block:: bash

    $ python manage.py buildtypescript

Or you can switch to another place.

.. code-block:: bash

    $ python manage.py buildtypescript --build-dir /somewhere/you/cannot/explain

Examples

-----------------

Input: Serializer

.. code-block:: python

    class PathSerializer(serializers.Serializer):

        name = serializers.CharField()

        suffix = serializers.CharField()

        suffixes = serializers.ListField(child=serializers.CharField())

        stem = serializers.CharField()

        is_directory = serializers.BooleanField(source="is_dir")

        size = serializers.IntegerField(source="stat.st_size")

Output: Interface

.. code-block:: typescript

    export interface Path {

      name: string;

      suffix: string;

      suffixes: string[];

      stem: string;

      isDirectory: boolean;

      size: number;

    }

There are more examples in `test cases`_.

.. _test cases: https://github.com/jinkanhq/django-rest-tsg/tree/main/tests

Build Options

-----------------

All options are listed in the table below.

+--------------------+-------------+--------------------+

| Name               | Context     | Value              |

+====================+=============+====================+

| alias              | All         | ``str``            |

+--------------------+-------------+--------------------+

| build_dir          | All         | ``str`` | ``Path`` |

+--------------------+-------------+--------------------+

| enforce_uppercase  | Enum        | ``bool`` (False)   |

+--------------------+-------------+--------------------+