Skip to main content

A package to help bridge the gap between Django's Forms and VueFormGenerator's Schemas using DjangoRestFramework.

Project description

https://badge.fury.io/py/django-vueformgenerator.png https://travis-ci.org/player1537/django-vueformgenerator.png?branch=master

A package to help bridge the gap between Django’s Forms and VueFormGenerator’s Schemas using DjangoRestFramework.

Documentation

The full documentation is at https://django-vueformgenerator.readthedocs.org.

Quickstart

Install Django-VueFormGenerator:

pip install django-vueformgenerator

Then use it in a project:

from django_vueformgenerator.schema import Schema
from django import forms
import json

class TestForm(forms.Form):
    title = forms.CharField(max_length=128)
    content = forms.TextField(max_length=1280)

form = TestForm()  # or TestForm(data={'title':'My Title'})
schema = Schema().render(form)
print(json.dumps(schema))

Features

  • TODO

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements_test.txt
(myenv) $ python runtests.py

Credits

Tools used in rendering this package:

History

0.2.3 (2016-11-03)

  • Add support for dotted models. Use this feature by defining your Form with a field that has a name with double-underscores (e.g. “foo__bar__baz”, which will become “foo.bar.baz” in the schema’s model field).

0.2.2 (2016-11-01)

  • Fix implementation of using initial data in forms. Previously, if you used CharField(initial=’foo’) then this information would not be preserved when creating the schema.

0.2.1 (2016-10-27)

  • Fix bug in tests so that the tests run successfully in Python 2.7.

0.2.0 (2016-10-25)

  • Add ability to use existing data in form

  • DEPRECATED: Any code which previously used Schema().render(MyForm) should now use Schema().render(MyForm()) (in other words, render() accepts an instance of a form, rather than a form itself). To check if you are calling the function against contract, you can run your code with python -Wd (e.g. python -Wd manage.py runserver).

0.1.1 (2016-10-18)

  • Add additional tests for schema generation

  • Add components for numbers and for selecting between choices

  • Add Python 2 support

  • Add better documentation

  • Fix exception raised on bad widget

0.1.0 (2016-10-11)

  • First release on PyPI.

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-vueformgenerator-0.2.3.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

django_vueformgenerator-0.2.3-py2.py3-none-any.whl (9.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page