# Giant Newsletter
A re-usable package which can be used in any project that requires a generic `Newletter` app.
This will include the basic formatting and functionality such as model creation via the admin and email sending.
## Installation
To install with the package manager, run:
$ poetry add giant-newsletter
You should then add `"newsletter"` to the `INSTALLED_APPS` in your settings file and to the `Makefile`.
In `base.py` there should also be a `DEFAULT_FROM_EMAIL` and a `DEFAULT_TO_EMAIL`. This is used by the email sending method.
## Context Processor
If you wish to use the Contact form with the context processor you will need to add `newsletter.context_processors.subscription_form` into the `TEMPLATES` context processors list. This will allow you to access the form in templates.
## Configuration
- `NEWSLETTER_FORM_FIELDS` allows the user to customise what fields are displayed on the form. This must be a list
- `NEWSLETTER_FORM_FIELD_PLACEHOLDERS` allows the user to customise the field placeholder text. This must be a dict containing the fieldnames
- `NEWSLETTER_FORM_REQUIRED_FIELDS` allows the user to customise what fields are required on the form. This must be a list
- `NEWSLETTER_FORM_LABELS` allows the user to customise what the field labels are on the form. This must be a dict of field names and their corresponding label
- `NEWSLETTER_FORM_WIDGETS` allows the user to customise what the field widgets are on the form. This must be a dict of field names and their corresponding widget
- `NEWSLETTER_HTTP_REFERER` allows the user to customise the success url and return the user to the referer page after submission
Raw data
{
"_id": null,
"home_page": "https://github.com/giantmade/giant-newsletter",
"name": "giant-newsletter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "newsletter,app",
"author": "Will-Hoey",
"author_email": "will.hoey@giantmade.com",
"download_url": "https://files.pythonhosted.org/packages/7d/a3/37aea2869a78f01cc5c468ffd7b56cd1f480e50c8057cce9beda6420135b/giant_newsletter-0.3.5.tar.gz",
"platform": null,
"description": "# Giant Newsletter\n\nA re-usable package which can be used in any project that requires a generic `Newletter` app. \n\nThis will include the basic formatting and functionality such as model creation via the admin and email sending.\n\n## Installation\n\nTo install with the package manager, run:\n\n $ poetry add giant-newsletter\n\nYou should then add `\"newsletter\"` to the `INSTALLED_APPS` in your settings file and to the `Makefile`. \n\nIn `base.py` there should also be a `DEFAULT_FROM_EMAIL` and a `DEFAULT_TO_EMAIL`. This is used by the email sending method.\n\n ## Context Processor\n If you wish to use the Contact form with the context processor you will need to add `newsletter.context_processors.subscription_form` into the `TEMPLATES` context processors list. This will allow you to access the form in templates.\n \n ## Configuration\n\n- `NEWSLETTER_FORM_FIELDS` allows the user to customise what fields are displayed on the form. This must be a list\n- `NEWSLETTER_FORM_FIELD_PLACEHOLDERS` allows the user to customise the field placeholder text. This must be a dict containing the fieldnames\n- `NEWSLETTER_FORM_REQUIRED_FIELDS` allows the user to customise what fields are required on the form. This must be a list\n- `NEWSLETTER_FORM_LABELS` allows the user to customise what the field labels are on the form. This must be a dict of field names and their corresponding label\n- `NEWSLETTER_FORM_WIDGETS` allows the user to customise what the field widgets are on the form. This must be a dict of field names and their corresponding widget\n- `NEWSLETTER_HTTP_REFERER` allows the user to customise the success url and return the user to the referer page after submission",
"bugtrack_url": null,
"license": "MIT",
"summary": "A small reusable package that adds a Newsletter app to a project",
"version": "0.3.5",
"project_urls": {
"Homepage": "https://github.com/giantmade/giant-newsletter",
"Repository": "https://github.com/giantmade/giant-newsletter"
},
"split_keywords": [
"newsletter",
"app"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a97fd0ead5c2f00d42768e5c633e7d2e3aced8e55519fe81b31775bdd62ce5ee",
"md5": "7cd6a177ad7e4c12f7f47ee0e8ec9d48",
"sha256": "f94056a6f669725164e9d7e0224043b1685d8a9f647bcbe45ab564673970f41a"
},
"downloads": -1,
"filename": "giant_newsletter-0.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7cd6a177ad7e4c12f7f47ee0e8ec9d48",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 12649,
"upload_time": "2023-07-19T14:33:35",
"upload_time_iso_8601": "2023-07-19T14:33:35.407106Z",
"url": "https://files.pythonhosted.org/packages/a9/7f/d0ead5c2f00d42768e5c633e7d2e3aced8e55519fe81b31775bdd62ce5ee/giant_newsletter-0.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7da337aea2869a78f01cc5c468ffd7b56cd1f480e50c8057cce9beda6420135b",
"md5": "c926de92559d9f78734d66adfae9cf56",
"sha256": "98dbec7c67d965d5bd719d2aa7e5b378df5f933a0ac3d6d0e8a783391980e60e"
},
"downloads": -1,
"filename": "giant_newsletter-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "c926de92559d9f78734d66adfae9cf56",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 7102,
"upload_time": "2023-07-19T14:33:37",
"upload_time_iso_8601": "2023-07-19T14:33:37.076237Z",
"url": "https://files.pythonhosted.org/packages/7d/a3/37aea2869a78f01cc5c468ffd7b56cd1f480e50c8057cce9beda6420135b/giant_newsletter-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-19 14:33:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "giantmade",
"github_project": "giant-newsletter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "giant-newsletter"
}
JSON
