{ "info": { "author": "Tom Dyson", "author_email": "tom+wagtailnetlify@torchbox.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Framework :: Wagtail", "Framework :: Wagtail :: 1", "Framework :: Wagtail :: 2", "Intended Audience :: Developers", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "# wagtail-netlify\n\n[![PyPI version](https://badge.fury.io/py/wagtailnetlify.svg)](https://badge.fury.io/py/wagtailnetlify)\n\nDeploy your Wagtail site on Netlify. Features include:\n\n - automatic deployment when pages are published\n - a new `netlify` management command\n - conversion of Wagtail redirects to Netlify's format\n\n![Screencast demo](https://tom.s3.amazonaws.com/wagtail-netlify.gif)\n\n## Installation\n\n1. Install and configure [Wagtail Bakery](https://github.com/moorinteractive/wagtail-bakery), if you haven't already.\n2. Install [Netlify CLI v2.x](https://www.netlify.com/docs/cli/#installation), if you haven't already.\n3. Install Wagtail-Netlify via pip (with `pip install wagtailnetlify`).\n\n## Configuration\n\n1. Add `wagtailnetlify` to your `INSTALLED_APPS`.\n2. Run the migrations: `./manage.py migrate wagtailnetlify`.\n3. Add `NETLIFY_PATH` to your settings.\n\nCheck the [Settings](#settings) section below for more customisation options.\n\n## Usage\n\nIf `NETLIFY_AUTO_DEPLOY` is set to `True`, Wagtail will automatically deploy your site every time a page is published.\n\n*or*\n\nTo deploy changes manually, use `./manage.py netlify`.\n\n## Settings\n\n### `NETLIFY_PATH`\n\nThe path to the Netlify CLI. *Hint: type `which netlify` to check the location.*\n\n### `NETLIFY_SITE_ID`\n\n**Default: `None`**\n\nIf set, deploy to that specific Netlify site.\n\nIf not set, the Netlify CLI might prompt you to select one.\n\n### `NETLIFY_API_TOKEN`\n\n**Default: `None`**\n\nIf set, the Netlify CLI will not prompt you to click the authentication link in the console. It can be useful when deployed to a remote server where you don't see the console output.\n\nConnect to your Netlify account to [generate a token](https://app.netlify.com/account/applications) and then set the settings. *Warning: You should never check credentials in your version control system. Use [environment variables](https://django-environ.readthedocs.io/en/latest/) or [local settings file](http://techstream.org/Bits/Local-Settings-in-django) instead.*\n\n### `NETLIFY_AUTO_DEPLOY`\n\n**Default: `True`**\n\nWhether to automatically deploy your site to Netlify every time you publish a page. This make take between a few seconds and a few minutes, depending on the size of your site, and the number of pages which are affected by your change.\n\n### `NETLIFY_DEPLOY_FUNCTION`\n\n**Default: `wagtailnetlify.models.deploy`**\n\nThe function to be called when a deploy is triggered (excluding when triggered manually with the `./manage.py netlify` command). It can be useful if you want to use your own task runner (like Celery) instead of the built-in threading model.\n\nThe function needs to be a valid [Django signal receiver](https://docs.djangoproject.com/en/2.1/topics/signals/#receiver-functions).\n\n### Optional admin view\n\nNetlify can send a webhook after a successful deployment. This app provides an endpoint for that webhook and an admin view of completed deployments. To enable this view:\n\n1. Add `wagtail.contrib.modeladmin` to your `INSTALLED_APPS`\n1. Update your project's `urls.py`:\n\n```python\n# in your imports\nfrom wagtailnetlify import views as netlify_views\n\n# in urlpatterns, before including wagtail_urls\nurl(r'^netlify/', netlify_views.success_hook, name='netlify'),\n```\n\n3. In Netlify's admin interface for your app, add http://yourdomain/netlify/success as a URL to notify for the outgoing webhook on *Deploy succeeded* events (in Settings / Build & deploy / Deploy notifications).\n\nThe view will be available under `Settings / Deployments` in your site's admin.\n\n## Development\n\n### Releases\n\n1. Ensure you have the latest versions of `pip`, `setuptools` and `twine` installed in your virtual environment.\n1. Create a new branch (e.g. `release/v1.1.3`) for the release of the new version.\n1. Update the version number in `wagtailnetlify/__init__.py` following [Semantic Versioning](http://semver.org/spec/v2.0.0.html).\n1. Update `CHANGELOG.md`.\n1. On GitHub, create a pull request and squash merge it.\n1. Checkout and pull the `master` branch locally.\n1. (Optional) If you need to verify anything, use `make publish-test` to upload to https://test.pypi.org and enter your PyPi *test* credentials as needed.\n1. Use `make publish` and enter your PyPi credentials as needed.\n1. On GitHub, create a release and a tag for the new version.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/tomdyson/wagtail-netlify", "keywords": "development", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "wagtailnetlify", "package_url": "https://pypi.org/project/wagtailnetlify/", "platform": "", "project_url": "https://pypi.org/project/wagtailnetlify/", "project_urls": { "Homepage": "https://github.com/tomdyson/wagtail-netlify" }, "release_url": "https://pypi.org/project/wagtailnetlify/0.3/", "requires_dist": null, "requires_python": "", "summary": "Deploy Wagtail sites to Netlify", "version": "0.3" }, "last_serial": 4804414, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "a155cf1562b2be84c91ac487f175ed46", "sha256": "572cdd403200aff2d6267939c29c12b5a1072a1abd15569514fd05ee34e8a49a" }, "downloads": -1, "filename": "wagtailnetlify-0.1.tar.gz", "has_sig": false, "md5_digest": "a155cf1562b2be84c91ac487f175ed46", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6397, "upload_time": "2018-09-16T16:25:56", "url": "https://files.pythonhosted.org/packages/aa/db/abd7dc280a4fb74e4a84086a6686c46d2e61bfc087cb3e86d60bea2bfcf1/wagtailnetlify-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "11bc41d2d832f4b27cdc393fad5a9f09", "sha256": "371429c1aa43c17747f6bcc34476c6b6a6eb67511c51b7f36f5fe7a8b503a35f" }, "downloads": -1, "filename": "wagtailnetlify-0.2.tar.gz", "has_sig": false, "md5_digest": "11bc41d2d832f4b27cdc393fad5a9f09", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6487, "upload_time": "2019-01-27T07:29:46", "url": "https://files.pythonhosted.org/packages/6c/29/e0f4f9e85d05189f6f82775f2b7381b73c3ca04fd2c540b52d90c7c97acb/wagtailnetlify-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "96989c1a5766db6e118b9f83cf6d85a8", "sha256": "37f1edc2e4086feb65b3bc111d80c0788ab1c2fc05f9e28be2ffe46cda4c0e27" }, "downloads": -1, "filename": "wagtailnetlify-0.3.tar.gz", "has_sig": false, "md5_digest": "96989c1a5766db6e118b9f83cf6d85a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7091, "upload_time": "2019-02-11T06:43:33", "url": "https://files.pythonhosted.org/packages/7c/fb/a25c927b6193f9ba162d0cb67a11640ac89b2d7bf212e35205199a9b5723/wagtailnetlify-0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "96989c1a5766db6e118b9f83cf6d85a8", "sha256": "37f1edc2e4086feb65b3bc111d80c0788ab1c2fc05f9e28be2ffe46cda4c0e27" }, "downloads": -1, "filename": "wagtailnetlify-0.3.tar.gz", "has_sig": false, "md5_digest": "96989c1a5766db6e118b9f83cf6d85a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7091, "upload_time": "2019-02-11T06:43:33", "url": "https://files.pythonhosted.org/packages/7c/fb/a25c927b6193f9ba162d0cb67a11640ac89b2d7bf212e35205199a9b5723/wagtailnetlify-0.3.tar.gz" } ] }