{ "info": { "author": "Omni Digital", "author_email": "dev@omni-digital.co.uk", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.11", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "Omni Forms\n==========\n\nOmni forms is a simple form builder with admin integration for django\nversions >= 1.8 that allows you to easily create forms for your django website.\n\nInstallation\n------------\n\n``pip install omniforms``\n\nOnce the package has been installed just add ``omni_forms`` to\n``INSTALLED_APPS`` in your settings file:\n\n``INSTALLED_APPS = ['omniforms', ...]``\n\nOnce you've done this run ``python manage.py migrate`` to migrate your\ndatabase.\n\nConfiguration\n-------------\n\nThe OmniForms application can be configured in a number of different\nways:\n\nPermitted content types\n~~~~~~~~~~~~~~~~~~~~~~~\n\nYou may not want administrators to be able to create forms for *all*\ndifferent types of content in your database. There are 2 different ways\nof restricting the types of content that can be associated with model\nforms created through the admin interface:\n\nOMNI\\_FORMS\\_CONTENT\\_TYPES\n---------------------------\n\nIt is possible to define specific apps and/or models which can be used\nby the omniforms app using the ``OMNI_FORMS_CONTENT_TYPES`` setting.\n\nFor example:\n\nThe following configuration would allow *any* of the models in the app\n``foo`` and the ``modelone`` and ``modeltwo`` models within the ``bar``\napp to be used.\n\n::\n\n OMNI_FORMS_CONTENT_TYPES = [\n {'app_label': 'foo'},\n {'app_label': 'bar', 'model': 'modelone'},\n {'app_label': 'bar', 'model': 'modeltwo'},\n ]\n\nIf the ``OMNI_FORMS_CONTENT_TYPES`` setting is not defined it will\ndefault to ``None`` and the ``OMNI_FORMS_EXCLUDED_CONTENT_TYPES``\nsetting will be used instead (default values or otherwise).\n\nOMNI\\_FORMS\\_EXCLUDED\\_CONTENT\\_TYPES\n-------------------------------------\n\nIt is possible to prevent model forms from being created for specific\napps or specific models using the ``OMNI_FORMS_EXCLUDED_CONTENT_TYPES``\nsetting.\n\nFor example:\n\nThe following configuration would prevent forms being created for *any*\nof the models in the app ``foo`` and for the ``modelone`` and\n``modeltwo`` models within the ``bar`` app.\n\n::\n\n OMNI_FORMS_EXCLUDED_CONTENT_TYPES = [\n {'app_label': 'foo'},\n {'app_label': 'bar', 'model': 'modelone'},\n {'app_label': 'bar', 'model': 'modeltwo'},\n ]\n\nIf you do not specify this setting it will default to the following:\n\n::\n\n OMNI_FORMS_EXCLUDED_CONTENT_TYPES = [\n {'app_label': 'omniforms'}\n ]\n\nThis will prevent administrators from creating form\\_builder forms with\nthe formbuilder itself. It's worth mentioning that allowing\nadministrators to do this represents a potential security risk and\nshould be avoided. As such, if you need to define your own\n``OMNI_FORMS_EXCLUDED_CONTENT_TYPES`` setting it would be wise to\nexclude all ``omniforms`` models as shown above.\n\nOMNI\\_FORMS\\_CUSTOM\\_FIELD\\_MAPPING\n-----------------------------------\n\nAlthough the omniforms app accounts for the majority of use cases you\nmay have models that use custom model fields. In these instances the\nform builder will not be able to map a model field to a form field and\nyou will need to provide a custom field mapping using the\n``OMNI_FORMS_CUSTOM_FIELD_MAPPING`` setting.\n\n- Each key within the mapping dictionary must be a string (python\n dotted import path) to a model field class.\n- Each value within the mapping dictionary must be a string (python\n dotted import path) to an OmniField subclass.\n\nFor example, you can map a TagField to an OmniCharField model instance\nusing the following configuration:\n\n::\n\n OMNI_FORMS_CUSTOM_FIELD_MAPPING = {\n 'taggit.TagField': 'omniforms.models.OmniCharField',\n }\n\nWith this configuration any instances of taggit.TagField on your models\nwill be represented as charfields in the corresponding forms generated\nby omniforms.\n\nIt is also possible to create your own OmniField subclasses to use in\nyour custom form builders. For example:\n\n::\n\n OMNI_FORMS_CUSTOM_FIELD_MAPPING = {\n 'taggit.TagField': 'my_app.MySuperOmniField',\n }\n\nIt is important to note that the dictionary values defined within the\n``OMNI_FORMS_CUSTOM_FIELD_MAPPING`` MUST be subclasses of\n``omniforms.models.OmniField``. If you attempt to register Field\nhandlers that do not subclass ``omniforms.models.OmniField`` an\nImproperlyConfigured exception will be raised.\n\nWagtail Integration\n-------------------\n\nIf you would like to integrate the form builder with https://wagtail.io/ you will need to add the\n``omniforms.wagtail`` submodule to your applications ``INSTALLED_APPS`` setting as well as the ``omniforms``\nmodule e.g.\n\n::\n\n INSTALLED_APPS = [\n 'omniforms',\n 'omniforms.wagtail',\n ...\n ]\n\nOnce this has been done, run database migrations ``python manage.py migrate`` and away you go.\n\nCompatibility\n-------------\n\nDjango\n~~~~~~\n\n- Django 1.11.x\n\nWagtail\n~~~~~~~\n\n- Wagtail 1.11.x\n- Wagtail 1.12.x\n- Wagtail 1.13.x\n\nPython\n~~~~~~\n\n- Python 2.7\n- Python 3.4\n- Python 3.5\n- Python 3.6\n\nChangeLog\n---------\n\n- 0.1 - Initial Build\n- 0.2 - Adds ability to create arbitrary non model form instances\n- 0.3 - Adds OmniChoiceField and OmniMultipleChoiceField form field types and wagtail integration\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/omni-digital/omni-forms/tarball/0.4.0", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/omni-digital/omni-forms/", "keywords": "form builder", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "omniforms", "package_url": "https://pypi.org/project/omniforms/", "platform": "", "project_url": "https://pypi.org/project/omniforms/", "project_urls": { "Download": "https://github.com/omni-digital/omni-forms/tarball/0.4.0", "Homepage": "https://github.com/omni-digital/omni-forms/" }, "release_url": "https://pypi.org/project/omniforms/0.4.0/", "requires_dist": null, "requires_python": "", "summary": "A simple Django app to build forms using the admin interface.", "version": "0.4.0" }, "last_serial": 3802494, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "483290525a89bab077e8b7c75d668bf9", "sha256": "fedd57ae29d6f6ed2d70aef65b82bed0010d4e330c786ffa4d32b7d9ea9f8ace" }, "downloads": -1, "filename": "omniforms-0.1.0.tar.gz", "has_sig": false, "md5_digest": "483290525a89bab077e8b7c75d668bf9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 37034, "upload_time": "2016-12-02T15:13:20", "url": "https://files.pythonhosted.org/packages/28/37/5a016786ad7f7ff82ade8e07b42d711077fabd718314b0f9abfde2a5a352/omniforms-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "5b1cea6f78db4bc3f4e3fab8b3221742", "sha256": "9cae842502c49c291d8ef2832b3853f51c090ddc44e0673ca4f085b0c6993cc9" }, "downloads": -1, "filename": "omniforms-0.2.0.tar.gz", "has_sig": false, "md5_digest": "5b1cea6f78db4bc3f4e3fab8b3221742", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39846, "upload_time": "2018-02-16T16:49:31", "url": "https://files.pythonhosted.org/packages/7b/ea/a4ec7094cef44728280de9820223076cfa1a1542063b9584002c32a562c1/omniforms-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "f7fde6c65f13ede84f98dc07bbbbebb7", "sha256": "08fab53a0668b75c30831a1c2bd724b990276e9bc57efedd886260d0c34f24d8" }, "downloads": -1, "filename": "omniforms-0.3.0.tar.gz", "has_sig": false, "md5_digest": "f7fde6c65f13ede84f98dc07bbbbebb7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 60026, "upload_time": "2018-04-11T13:48:41", "url": "https://files.pythonhosted.org/packages/99/b9/6e4eb7614fc23811cb69382dc0b4f5210e90e3e56bac99564b47ca9f471b/omniforms-0.3.0.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "111b2f43a62a381d348b3eb3a74ab8c7", "sha256": "bba180678141a36951526bfc397a33b0f3e786c1b69973b3ad343efac8bbc3e7" }, "downloads": -1, "filename": "omniforms-0.4.0.tar.gz", "has_sig": false, "md5_digest": "111b2f43a62a381d348b3eb3a74ab8c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 63947, "upload_time": "2018-04-24T11:56:35", "url": "https://files.pythonhosted.org/packages/de/4e/a3bcf52a02e763e60a669f257d0cb7b9a1200ea5cf739e5072128c85df6e/omniforms-0.4.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "111b2f43a62a381d348b3eb3a74ab8c7", "sha256": "bba180678141a36951526bfc397a33b0f3e786c1b69973b3ad343efac8bbc3e7" }, "downloads": -1, "filename": "omniforms-0.4.0.tar.gz", "has_sig": false, "md5_digest": "111b2f43a62a381d348b3eb3a74ab8c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 63947, "upload_time": "2018-04-24T11:56:35", "url": "https://files.pythonhosted.org/packages/de/4e/a3bcf52a02e763e60a669f257d0cb7b9a1200ea5cf739e5072128c85df6e/omniforms-0.4.0.tar.gz" } ] }