An app to create any form in django admin panel.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for M3HDi from gravatar.com M3HDi

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Mahdi Asadnejad
  • Maintainer: Mahdi Asadnejad
  • Tags django, form, generator, form_generator, django_form_generator
  • Requires: Python >=3.10
Classifiers

Project description

Django Form Generator

django form generator will help you create forms very easily. you can use it any where in your html files.

there is an API-manager tool for you to call some APIs on loading form or after submit.

Installation

  • install it via pip:

    pip install django-form-generator

  • add ('django_form_generator', 'django_htmx', 'crispy_forms', 'crispy_bootstrap5', 'captcha', 'tempus_dominus', 'rest_framework', 'drf_recaptcha') to your INSTALLED_APPS:

    INSTALLED_APPS = [
    ...
    'django_htmx',
    'crispy_forms',
    'crispy_bootstrap5',
    'captcha',
    'tempus_dominus',
    'rest_framework',
    'drf_recaptcha',
    'django_form_generator',
]

  • do a migrate:

    python manage.py migrate

  • do a collectstatic:

    python manage.py collectstatic

  • finally include django_form_generator urls to your urls.py

    from django.contrib import admin
from django.urls import path, include

urlpatterns = [
  path('admin/', admin.site.urls),
  ...
  path('form-generator/', include(('django_form_generator.urls', 'django_form_generator'), namespace='django_form_generator')),
  ...
]

Requirements

  • Python >= 3.10
  • Django >= 4.0

Form Usage

  • regular html usage:

    <!doctype html>
<html lang="en">
<head>
...
</head>

<body>
    {% load django_form_generator %}

    {% render_form 1 %} {# it will render the form that has id of 1 #}

</body>

</html>

  • RichText fields:

    To use this tags on a Richtext field like CKeditor or tinymce.

    Note: In some richtext packages some elements (specialy jinja elements) will be removed from the field there are some tweaks to solve this problems on the packages documentations.

    • Admin panel:

      CK-Editor example Shows an example usage on ck-editor

    • ./app_name/templates/index.html 

      <!doctype html>
<html lang="en">
<head>
...
</head>

<body>
    {% load django_form_generator %}

    {{ object.rich_text_field|eval_data }}

</body>

</html>

API manager Usage

There is also an API manager for the forms

  • Admin panel:

    • example:

      Note: first_name, last_name and job are the name of the fields that are defined in a form which this api is assigned to.

      create a body with the fields name of a form

Note: assigend apis will be called automatically. the ones with execution_time of PRE will be called when form renders. and the ones with execution_time of POST will be called after form submition.

Note: in the response field you can write HTML tags it will be rendrend as safe.

Note: You have access to request globaly in api manager

Also you have access to the response of the api. so you can use Jinja syntax to access data. You can use this feature on the (url, body, response) fields of APIManager model

  • Creating API

    • example:

    get response of an API

    Note: To show the response use the template tag of {% render_pre_api form_id api_id %} inside your html file that the form is there.

  • Response

    example:

    • output of the api:

      {
  "result": [
    {
    "first_name": "john",
    "last_name": "doe",
    "avatar": "https://www.example.com/img/john-doe.png",
    },
    {
    "first_name": "mary",
    "last_name": "doe",
    "avatar": "https://www.example.com/img/mary-doe.png",
    }
  ]
}

    • in the response field you can do:

      <h1> Response of the API: </h1>
{% for item in result %}

  <p>{{item.first_name}}</p>
  <p>{{item.last_name}}</p>
  <img src="{{item.avatar}}">

{% endfor %}

  • html usage:

    <!doctype html>
<html lang="en">
<head>
...
</head>

<body>
    {% load django_form_generator %}

    {% render_pre_api 1 %} {# it will render all pre apis that are assigned to a form with id of 1 #}

    {% render_pre_api 1 6 %} {# it will render the pre api with id of 6 which is assigned to a form with id of 1 #}


    {% render_post_api 1 %} {# it will render all pre apis that are assigned to a form with id of 1 #}

    {% render_post_api 1 7 %} {# it will render the post api with id of 7 which is assigned to a form with id of 1 #}

</body>

</html>

Extra

  • API Manager:

    you can access the whole submited data by adding {{ form_data }} to your api body.

  • Form Theme:

    to have multiple themes the html of template_name_p (attribute of django.forms.Form) will be replace by our html file. ({{form.as_p}})

    there are 3 themes(or actualy styel of rendering fields) for the forms:

    1. In-line Theme[^1].

    2. In-order Theme[^2].

    3. Dynamic Theme[^3].

    [^1]: In every line two fields will be rendered.

    [^2]: In every line one field will be rendered.

    [^3]: this theme will render fields respect to the field position (inline, inorder, break)

    Note: If you want to render two fields inline and one field inorder you should use break for the second field

    • example:
      • field1 inline
      • field2 break
      • field3 inorder

    Note: You can add your custom themes by create new TextChoices object and add it to settings.py

    • example:
      1. myapp/const.py 
        from django.db.models import TextChoices

class CustomFormGeneratorTheme(TextChoices):
  MY_THEME = "myapp/templates/my_theme.html", 'My Custom Theme'
  ...
      2. myproject/settings.py 
          DJANGO_FORM_GENERATOR = {
    "FORM_THEME_CHOICES": "myapp.const.CustomFormGeneratorTheme"
  }

  • URLS:

    # to access the form you can call this url:
"""GET: http://127.0.0.1:8000/form-generator/form/1/"""
#or 
reverse('django_form_generator:form_detail', kwargs={'pk': 1})
#api:
reverse('django_form_generator:api_form_detail', kwargs={'pk': 1})


# to access the response of the form you can call this url the kwarg_lookup is UUID field
"""GET: http://127.0.0.1:8000/form-generator/form-response/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/"""
#or
reverse('django_form_generator:form_response', kwargs={'unique_id': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'})
#api:
reverse('django_form_generator:api_form_response', kwargs={'unique_id': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'})

  • Settings:

    below is the default settings for django_form_generator. you can change them by adding it to your settings.py

        DJANGO_FORM_GENERATOR = {
      'FORM_RESPONSE_SAVE': 'django_form_generator.models.save_form_response',
      'FORM_EVALUATIONS': {'form_data': '{{form_data}}'},
      'MAX_UPLOAD_FILE_SIZE': 5242880, # default: 50 mb 
      'FORM_GENERATOR_FORM': 'django_form_generator.forms.FormGeneratorForm',
      'FORM_RESPONSE_FORM': 'django_form_generator.forms.FormGeneratorResponseForm',
      'FORM_THEME_CHOICES': 'django_form_generator.const.FormTheme',
      'FORM_MANAGER': 'django_form_generator.managers.FormManager',
      'FORM_GENERATOR_SERIALIZER': 'django_form_generator.api.serializers.FormGeneratorSerializer',
      'FORM_RESPONSE_SERIALIZER': 'django_form_generator.api.serializers.FormGeneratorResponseSerializer',
    }

Attention

To have nice styled fields you can add crispy-form to your settings.py

  CRISPY_ALLOWED_TEMPLATE_PACKS = 'bootstrap5'
  CRISPY_TEMPLATE_PACK = 'bootstrap5'

To access google recaptcha you should add these to your settings.py

Note: you can have public & private keys by registring your domain on Google recaptcha admin console

  RECAPTCHA_PUBLIC_KEY = 'public_key'
  RECAPTCHA_PRIVATE_KEY = 'private_key'
  # ===== FOR DRF =========
  DRF_RECAPTCHA_SECRET_KEY = "YOUR SECRET KEY"

Note: If you don't want to use google-recaptcha(django-recaptcah) you should add below code to your settings.py

SILENCED_SYSTEM_CHECKS = ['captcha.recaptcha_test_key_error']

Dependency Packages

  1. HTMX
  2. CRISPY-FORMS (crispy-bootstrap5 )
  3. REQUESTS
  4. DJANGO-RECAPTCHA
  5. DJANGO-TEMPUS-DOMINUS

License

MIT

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for M3HDi from gravatar.com M3HDi

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Mahdi Asadnejad
  • Maintainer: Mahdi Asadnejad
  • Tags django, form, generator, form_generator, django_form_generator
  • Requires: Python >=3.10
Classifiers

Release history Release notifications | RSS feed

0.0.55

0.0.54

0.0.53

0.0.52

0.0.51

0.0.50

0.0.49

0.0.48

0.0.47

0.0.45

0.0.44

0.0.43

0.0.42

0.0.41

0.0.40

0.0.39

0.0.38

0.0.37

0.0.36

This version

0.0.35

0.0.34

0.0.33

0.0.32

0.0.31

0.0.30

0.0.29

0.0.28

0.0.27

0.0.26

0.0.24

0.0.23

0.0.22

0.0.21

0.0.20

0.0.19

0.0.18

0.0.17

0.0.16

0.0.15

0.0.14

0.0.13

0.0.12

0.0.11

0.0.10

0.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_form_generator-0.0.35.tar.gz (130.3 kB view details)

Uploaded Source

Built Distribution

django_form_generator-0.0.35-py3-none-any.whl (135.0 kB view details)

Uploaded Python 3

File details

Details for the file django_form_generator-0.0.35.tar.gz.

File metadata

File hashes

Hashes for django_form_generator-0.0.35.tar.gz
Algorithm Hash digest
SHA256 87a9be09654c9f5c40aefcd9e58b82a580708c859e2d59665c28374c207975c0
MD5 f475bbe7baae55d8843d95333f525bdf
BLAKE2b-256 8026dfde41d456ee8cff43bd72e10c878e04084c69416b04560cf5d5fd580295

See more details on using hashes here.

File details

Details for the file django_form_generator-0.0.35-py3-none-any.whl.

File metadata

File hashes

Hashes for django_form_generator-0.0.35-py3-none-any.whl
Algorithm Hash digest
SHA256 139fe442d1ddc8c24e12fefeaf40e02b94d0848eebc9ca4f5bfa43db8f3438b1
MD5 916e45b3aaedea8d5abb9fb35d656e32
BLAKE2b-256 824a0de896006731bed03f17f485a1932474489ee612ed9506df1009daad07f8

See more details on using hashes here.

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