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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_ts_bridge-1.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0b5a795be60cb5ca03b3e2ae487e0f9da5cff4f97501715a1522fb4698df75f |
|
MD5 | 4f8a917818b5e14ee3ee2d26e93ac839 |
|
BLAKE2b-256 | 58aa6604e2538463eae1932409c5e1d7741c3f0df950c0ae1befa5ceb9586943 |