django-rest-formly

How to install

Just install it with npm:

    npm install -g django-rest-formly

This will install django-rest-formly globall and let you using the cli tool from anywhere.

** P.S: ** It's recommended to use VerboseMetadata class of djangorestframework-utils package, to explore all features of this project.

Usage

This package install a command line tool that let you render angular-formly fields' configuration for your Django Rest Framework endpoints.

Arguments

• -h, --host <HOST> Specifies host address (by default: 127.0.0.1)
• -p, --port <PORT> Specifies port number (by default 8000)
• --root <PATH> Specifies API root path (by default '/')
• -c, --color Colorize the command output, this option has effect only on the list command or the form command when it's used with --prettify option
• --prettify Prettify the json output

Listing endpoint

The command list will list all existing endpoints for the specified API root (by default '/'). You can specify the API root with --root option. Note also, that you can change host (resp. port) value with --host (resp. --port) option.

$ django-rest-formly --host 192.168.99.100 --port 5000 --root /api

Generate Formly form configuration

The command form will generate angular-formly's form configuration for the specified endpoint, example:

$ django-rest-formly --host 192.168.99.100 --port 5000 --root /api users

The output will be the form's configuration for endpoint located on 192.168.99.100:5000/api/users

Project Status

The project is already in development status, and not all fields are supported and there is a lot of things to improve. For the moment, we support the below fields:

• IntegerField
• BooleanField
• CharField
• EmailField (HTML5)
• PasswordField
• RegexField (HTML5)
• URLField (HTML5)
• IPAddressField (HTML5)
• DecimalField
• FloatField
• DateField (HTML5)
• TimeField (HTML5)
• DateTimeField (HTML5)

For further details, see Change Log.

Contributing

Contributions are welcome and appreciated. You can find django-rest-formly on GitHub, feel free to start an issue or create a pull requests.