[](https://codecov.io/gh/kevinhowbrook/wagtail-jotform)
[](https://github.com/psf/black) [](https://lgtm.com/projects/g/kevinhowbrook/wagtail-jotform/alerts/)
# Wagtail Jotform
Embedable [Jotform](https://www.jotform.com) forms for Wagtail pages.
Wagtail Jotform works by providing a new `EmbeddedFormPage` page type with a form choice field. Values for this form field are populated from the Jotform API.
## Installation
Install from [pypi](https://pypi.org/project/wagtail-jotform/):
```bash
pip install wagtail-jotform
```
## Configuration
You will need an API key from Jotform. Add the following variables to your settings:
```python
WAGTAIL_JOTFORM = {
"API_KEY": "somekey",
"API_URL": "https://api.jotform.com",
"LIMIT": 50,
}
```
`LIMIT` is the number of results in each result set for form list. Default is 50. Maximum is 1000.
If your Jotform account is in [EU safe mode](https://www.jotform.com/eu-safe-forms/), your `JOTFORM_API_URL` should be `https://eu-api.jotform.com`.
Add the following to your `INSTALLED_APPS` in settings, and note that `wagtail_jotform` depends on `routable_page`:
```python
INSTALLED_APPS = [
...
"wagtail_jotform",
"wagtail.contrib.routable_page",
]
```
## Thank you page
Thank you pages work via Wagtail's [RoutablePageMixin](https://docs.wagtail.io/en/latest/reference/contrib/routablepage.html).
When a form is created, the Jotform `thankurl` is set with your created form's thank you page URL, e.g. `https://mysite.com/formpage/thank-you`. When the form is submitted, the user will be redirected accordingly and be show the 'thank you' data specified on on the form page added.
## Overriding templates
Wagtail Jotform has two templates:
- embedded_form_page.html
- thank_you.html
You can override these templates in your project by adding them in the following location:
- your_project_root/
- templates/
- wagtail_jotform/
- embed_form_page.html
- thank_you.html
## Contributing
We welcome contributions to this project. Please follow the [contributing instructions](docs/CONTRIBUTING.md) to get started.
## Release process
To release a new version, the [Release documentation](docs/RELEASE.md) should be followed.
Raw data
{
"_id": null,
"home_page": "https://github.com/torchbox/wagtail-jotform",
"name": "wagtail-jotform",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Kevin Howbrook",
"author_email": "kevin.howbrook@torchbox.com",
"download_url": "https://files.pythonhosted.org/packages/ef/05/ec7e4bda4b5b0baac1e8ff431189e6577284965f6bbcb228a4ad7b027e8d/wagtail-jotform-2.2.0.tar.gz",
"platform": null,
"description": "\n[](https://codecov.io/gh/kevinhowbrook/wagtail-jotform)\n[](https://github.com/psf/black) [](https://lgtm.com/projects/g/kevinhowbrook/wagtail-jotform/alerts/)\n\n# Wagtail Jotform\n\nEmbedable [Jotform](https://www.jotform.com) forms for Wagtail pages.\n\nWagtail Jotform works by providing a new `EmbeddedFormPage` page type with a form choice field. Values for this form field are populated from the Jotform API.\n\n## Installation\n\nInstall from [pypi](https://pypi.org/project/wagtail-jotform/):\n\n```bash\npip install wagtail-jotform\n```\n\n## Configuration\n\nYou will need an API key from Jotform. Add the following variables to your settings:\n\n```python\nWAGTAIL_JOTFORM = {\n \"API_KEY\": \"somekey\",\n \"API_URL\": \"https://api.jotform.com\",\n \"LIMIT\": 50,\n}\n```\n\n`LIMIT` is the number of results in each result set for form list. Default is 50. Maximum is 1000.\n\nIf your Jotform account is in [EU safe mode](https://www.jotform.com/eu-safe-forms/), your `JOTFORM_API_URL` should be `https://eu-api.jotform.com`.\n\nAdd the following to your `INSTALLED_APPS` in settings, and note that `wagtail_jotform` depends on `routable_page`:\n\n```python\nINSTALLED_APPS = [\n ...\n \"wagtail_jotform\",\n \"wagtail.contrib.routable_page\",\n]\n```\n\n## Thank you page\n\nThank you pages work via Wagtail's [RoutablePageMixin](https://docs.wagtail.io/en/latest/reference/contrib/routablepage.html).\n\nWhen a form is created, the Jotform `thankurl` is set with your created form's thank you page URL, e.g. `https://mysite.com/formpage/thank-you`. When the form is submitted, the user will be redirected accordingly and be show the 'thank you' data specified on on the form page added.\n\n## Overriding templates\n\nWagtail Jotform has two templates:\n\n- embedded_form_page.html\n- thank_you.html\n\nYou can override these templates in your project by adding them in the following location:\n\n- your_project_root/\n - templates/\n - wagtail_jotform/\n - embed_form_page.html\n - thank_you.html\n\n## Contributing\n\nWe welcome contributions to this project. Please follow the [contributing instructions](docs/CONTRIBUTING.md) to get started.\n\n## Release process\n\nTo release a new version, the [Release documentation](docs/RELEASE.md) should be followed.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Embed Jotform forms in wagtail.",
"version": "2.2.0",
"project_urls": {
"Homepage": "https://github.com/torchbox/wagtail-jotform"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "485e264d3bc0316494f3e94f21638970d9bf4bf591875c66c4f391a636aa7ee1",
"md5": "51526c17736fbb1c7569867673027cf2",
"sha256": "1d211790ffd0612af49e91236a8dcfb79f4afca440d65fe75c7f87391803497f"
},
"downloads": -1,
"filename": "wagtail_jotform-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "51526c17736fbb1c7569867673027cf2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11132,
"upload_time": "2024-03-07T04:16:31",
"upload_time_iso_8601": "2024-03-07T04:16:31.218594Z",
"url": "https://files.pythonhosted.org/packages/48/5e/264d3bc0316494f3e94f21638970d9bf4bf591875c66c4f391a636aa7ee1/wagtail_jotform-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ef05ec7e4bda4b5b0baac1e8ff431189e6577284965f6bbcb228a4ad7b027e8d",
"md5": "83a8a2da67efb41e5cf83c59be08020c",
"sha256": "4662da302b9f427c0ec5774ad9cf9e59c81d0d201755daeb49a691775851a62a"
},
"downloads": -1,
"filename": "wagtail-jotform-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "83a8a2da67efb41e5cf83c59be08020c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9985,
"upload_time": "2024-03-07T04:16:32",
"upload_time_iso_8601": "2024-03-07T04:16:32.949652Z",
"url": "https://files.pythonhosted.org/packages/ef/05/ec7e4bda4b5b0baac1e8ff431189e6577284965f6bbcb228a4ad7b027e8d/wagtail-jotform-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-07 04:16:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "torchbox",
"github_project": "wagtail-jotform",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "wagtail-jotform"
}
JSON
