{ "info": { "author": "Rob Moorman", "author_email": "rob@moori.nl", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Framework :: Wagtail", "Framework :: Wagtail :: 1", "Framework :: Wagtail :: 2", "Operating System :: Unix", "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" ], "description": "# Wagtail-bakery\n\nA set of helpers for baking your Django Wagtail site out as flat files.\n\n[![Build Status](https://travis-ci.org/wagtail/wagtail-bakery.svg?branch=master)](https://travis-ci.org/wagtail/wagtail-bakery)\n[![Coverage Status](https://coveralls.io/repos/github/moorinteractive/wagtail-bakery/badge.svg?branch=master)](https://coveralls.io/github/moorinteractive/wagtail-bakery?branch=master)\n\n* Issues: [https://github.com/wagtail/wagtail-bakery/issues](https://github.com/wagtail/wagtail-bakery/issues)\n* Testing: [https://travis-ci.org/wagtail/wagtail-bakery](https://travis-ci.org/wagtail/wagtail-bakery)\n* Coverage: [https://coveralls.io/github/moorinteractive/wagtail-bakery](https://coveralls.io/github/moorinteractive/wagtail-bakery)\n\nWagtail-bakery is built on top of [Django bakery](https://github.com/datadesk/django-bakery). Please read their [documentation](https://django-bakery.readthedocs.io/en/latest/) for detailed configuration and how to build default Django flat files. Yes. Wagtail-bakery is not limited to build Wagtail pages specifically, mixed content is possible!\n\n## Features\n\n* Single management command that will build your Wagtail site out as flat files\n* Support for multisite, [theming](https://github.com/moorinteractive/wagtail-themes) and [multilingual](http://docs.wagtail.io/en/latest/advanced_topics/i18n/index.html) setup\n* Support for `i18n_patterns`\n* Support for generating a static API\n* Ready to use Wagtail Buildable views to build all your (un)published pages at once (no extra code required!)\n\n## Installation\n\n```\npip install wagtail-bakery\n```\n\nAdd `bakery` and `wagtailbakery` to your `INSTALLED_APPS` setting.\n\n```python\nINSTALLED_APPS = (\n # ...\n 'bakery',\n 'wagtailbakery',\n)\n```\n\n## Configuration\n\nDefine whether you want to build multiple sites or the default site (see examples for impact on directory output), by default this settings is `False`.\n\n```python\nBAKERY_MULTISITE = True\n```\n\nAdd the build directory where you want to be the site be built as flat files.\n\n```python\nBUILD_DIR = '/tmp/build/'\n```\n\nAs you may know with Django bakery, the trickiest part is to make your current models/pages buildable with [Buildable views](https://django-bakery.readthedocs.io/en/latest/buildableviews.html). As Django Wagtail uses only the `Page` model at their lowest level, you can use at least one of the already present Buildable views provided by Wagtail bakery.\n\nBuild all published public pages (use for production).\n\n```python\nBAKERY_VIEWS = (\n\t'wagtailbakery.views.AllPublishedPagesView',\n)\n```\n\nBuild all published and unpublished public pages (use for staging/acceptance).\n\n```python\nBAKERY_VIEWS = (\n\t'wagtailbakery.views.AllPagesView',\n)\n```\n\nTo build static JSON files representing your site's API, use the following views:\n\n```python\nBAKERY_VIEWS = (\n\t'wagtailbakery.api_views.PagesAPIDetailView',\n\t'wagtailbakery.api_views.PagesAPIListingView',\n\t'wagtailbakery.api_views.TypedPagesAPIListingView',\n)\n```\n\nThe API views use Wagtail's V2 API module. To configure the data that is rendered by these views, please refer to Wagtail's [V2 API configuration guide](http://docs.wagtail.io/en/stable/advanced_topics/api/v2/configuration.html).\n\n## Usage\n\nBuild the site out as flat files by running the `build` management command.\n\n```\nmanage.py build\n```\n\nIf you want to check how your static website will look, use the `buildserver` command after you have build your static files once.\n\n```\nmanage.py buildserver\n```\n\n## Examples\n\nIn the [examples](https://github.com/wagtail/wagtail-bakery/tree/master/examples) directory you can find a Wagtail setup with fixtures for a single site as well as a multisite setup.\n\nCreate a virtualenv and go to one of the examples, you can use the `Make` command to install all requirements, load fixtures and run the server.\n\nAs described in the usage section, use `manage.py build` to build out the example as static files.\n\n**Build output with `BAKERY_MULTISITE=True`**:\n\n```\nbuild/example.com/index.html\nbuild/example.com/about/index.html\nbuild/example.com/blog/index.html\nbuild/example.com/blog/example/index.html\nbuild/static/\n```\n\n**Build output with `BAKERY_MULTISITE=False` (default)**:\n\n```\nbuild/index.html\nbuild/about/index.html\nbuild/blog/index.html\nbuild/blog/example/index.html\nbuild/static/\n```\n\n## Troubleshooting\n\nFor issues [please submit an issue](https://github.com/wagtail/wagtail-bakery/issues/new) on GitHub.\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/1.1.3`) for the release of the new version.\n1. Update the version number in `setup.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.\n\n## Credits\n\nThanks to [@mhnbcu](https://github.com/mhnbcu/wagtailbakery) for bringing this\nidea up initially, and [Django Bakery](https://github.com/datadesk/django-bakery)\nfor providing the initial bakery package.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "wagtail-bakery", "package_url": "https://pypi.org/project/wagtail-bakery/", "platform": "", "project_url": "https://pypi.org/project/wagtail-bakery/", "project_urls": null, "release_url": "https://pypi.org/project/wagtail-bakery/0.3.0/", "requires_dist": null, "requires_python": "", "summary": "A set of helpers for baking your Django Wagtail site out as flat files.", "version": "0.3.0" }, "last_serial": 4276799, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "6a527c062fef034b2203c1dabce48e10", "sha256": "b143407d074c9463d5de6774c53ade6cf1944de244b8bc8e273e30f33632b53d" }, "downloads": -1, "filename": "wagtail_bakery-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6a527c062fef034b2203c1dabce48e10", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5828, "upload_time": "2017-04-11T18:20:35", "url": "https://files.pythonhosted.org/packages/f7/7a/f0a9f79d32101ca941db7c2614669473839cdf34605c6c51645465b8545b/wagtail_bakery-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "796eac6a148fefebe6a6a64cf29a8a98", "sha256": "6dcbf0689e4d933b733dd1baf53813e46d81761690c1c3818a17578266e2ee14" }, "downloads": -1, "filename": "wagtail-bakery-0.1.0.tar.gz", "has_sig": false, "md5_digest": "796eac6a148fefebe6a6a64cf29a8a98", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4918, "upload_time": "2017-04-11T18:20:37", "url": "https://files.pythonhosted.org/packages/1a/80/f656941b3886e1d5d575c3209d5fe7785984da1cb11ed08291572bb1cf84/wagtail-bakery-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "d640413140d607f38746f6589b2a82e3", "sha256": "c83111d92e90efa8631bcb21c60ca5509220e545ddf12d163ef229f6fedb95ad" }, "downloads": -1, "filename": "wagtail_bakery-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d640413140d607f38746f6589b2a82e3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7782, "upload_time": "2018-01-19T08:53:00", "url": "https://files.pythonhosted.org/packages/e3/e9/9759188728356409c4babf7a85b785802bdb167aa6d4951143fff717afff/wagtail_bakery-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5ef1a17a6af98148429a1d45e7a2c224", "sha256": "3fc91e65ff639607c276491bc9dc205f474ab24cba7afaad26ee4295a4bcb773" }, "downloads": -1, "filename": "wagtail-bakery-0.2.0.tar.gz", "has_sig": false, "md5_digest": "5ef1a17a6af98148429a1d45e7a2c224", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6407, "upload_time": "2018-01-19T08:53:01", "url": "https://files.pythonhosted.org/packages/6c/3d/e7c0b40283bf7641ea097a8a1c867e9fe8fa7d7611fcde045a1c90b70ae0/wagtail-bakery-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "b2b2a05d992c7424934d9cd450aba73b", "sha256": "46dd6d31f2305094945eb3a9ee7fc8dbeca778fe13cd96b2f245a22467412390" }, "downloads": -1, "filename": "wagtail-bakery-0.3.0.tar.gz", "has_sig": false, "md5_digest": "b2b2a05d992c7424934d9cd450aba73b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8235, "upload_time": "2018-09-16T15:23:54", "url": "https://files.pythonhosted.org/packages/11/e3/f4b09541a3ea2528bd2ed8abe737dc7f8b9541cdbc2e33dea19c1dac798c/wagtail-bakery-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b2b2a05d992c7424934d9cd450aba73b", "sha256": "46dd6d31f2305094945eb3a9ee7fc8dbeca778fe13cd96b2f245a22467412390" }, "downloads": -1, "filename": "wagtail-bakery-0.3.0.tar.gz", "has_sig": false, "md5_digest": "b2b2a05d992c7424934d9cd450aba73b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8235, "upload_time": "2018-09-16T15:23:54", "url": "https://files.pythonhosted.org/packages/11/e3/f4b09541a3ea2528bd2ed8abe737dc7f8b9541cdbc2e33dea19c1dac798c/wagtail-bakery-0.3.0.tar.gz" } ] }