Skip to main content

Management commands in Django that give defintions for Django models returned by DRF along with any model fields limited by choices

Project description

# Django TS Bridge

Creates a set of management commands that makes it easy to create TypeScript files that easy the usage of Django models within TypeScript

## Settings

  • DJANGO_TS_BRIDGE_EXCLUDED_APPS - Array of apps that shouldn’t be included in generation. Default: [‘rest_framework’, ‘wagtail.api.v2’]

  • DJANGO_TS_BRIDGE_CHOICE_DEFINITION_IMPORT_PATH - The path used to import the generated TypeScript file of the choices available for all Django models. Default: ‘ts/django/django-model-choices’

  • DJANGO_TS_BRIDGE_CHOICE_DEFINITION_OUTPUT_PATH - The output path for the generated Typescript file of the choices available for all Django models. Default: ‘src/ts/django/django-model-choices.ts’

  • DJANGO_TS_BRIDGE_MODEL_DEFINITION_OUTPUT_PATH - The output path for the generated Typescript declaration file for all Django models. Default: ‘src/ts/@types/django-models.d.ts

  • DJANGO_TS_BRIDGE_CHOICE_VAR_NAME - The name of the variable that will hold all Django model choices. Default: ‘Choices’

## Management Commands

  • create_ts_choice_defs - Creates a TypeScript file that defines all model choice fields based on its [models.TextChoices/models.IntegerChoices](https://docs.djangoproject.com/en/dev/ref/models/fields/#enumeration-types) class

  • create_ts_serializer_types - Creates a TypeScript declaration file that defines all the interfaces that will be used by Django Rest Framework Serializer classes

  • create_ts_files - Convience function to run both create_ts_choice_defs and create_ts_serializer_types at the same time

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

django-ts-bridge-1.3.3.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

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

django_ts_bridge-1.3.3-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file django-ts-bridge-1.3.3.tar.gz.

File metadata

  • Download URL: django-ts-bridge-1.3.3.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.5

File hashes

Hashes for django-ts-bridge-1.3.3.tar.gz
Algorithm Hash digest
SHA256 048bbd135bf144b1964be854c2bc289ed510296f49abf4e0decf10af1ed954f3
MD5 b1745fda1349646b6bab37a6afe6835f
BLAKE2b-256 56e6e2fe4184d623ac392a691f5ab659c2b3eefaea8a3c54732fb7a9a9d68a07

See more details on using hashes here.

File details

Details for the file django_ts_bridge-1.3.3-py3-none-any.whl.

File metadata

  • Download URL: django_ts_bridge-1.3.3-py3-none-any.whl
  • Upload date:
  • Size: 24.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.5

File hashes

Hashes for django_ts_bridge-1.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e0b5a795be60cb5ca03b3e2ae487e0f9da5cff4f97501715a1522fb4698df75f
MD5 4f8a917818b5e14ee3ee2d26e93ac839
BLAKE2b-256 58aa6604e2538463eae1932409c5e1d7741c3f0df950c0ae1befa5ceb9586943

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