Metadata-Version: 2.1
Name: wagtail-bakery
Version: 0.3.0
Summary: A set of helpers for baking your Django Wagtail site out as flat files.
Home-page: UNKNOWN
Author: Rob Moorman
Author-email: rob@moori.nl
License: MIT
Description: # Wagtail-bakery
        
        A set of helpers for baking your Django Wagtail site out as flat files.
        
        [![Build Status](https://travis-ci.org/wagtail/wagtail-bakery.svg?branch=master)](https://travis-ci.org/wagtail/wagtail-bakery)
        [![Coverage Status](https://coveralls.io/repos/github/moorinteractive/wagtail-bakery/badge.svg?branch=master)](https://coveralls.io/github/moorinteractive/wagtail-bakery?branch=master)
        
        * Issues: [https://github.com/wagtail/wagtail-bakery/issues](https://github.com/wagtail/wagtail-bakery/issues)
        * Testing: [https://travis-ci.org/wagtail/wagtail-bakery](https://travis-ci.org/wagtail/wagtail-bakery)
        * Coverage: [https://coveralls.io/github/moorinteractive/wagtail-bakery](https://coveralls.io/github/moorinteractive/wagtail-bakery)
        
        Wagtail-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!
        
        ## Features
        
        * Single management command that will build your Wagtail site out as flat files
        * Support for multisite, [theming](https://github.com/moorinteractive/wagtail-themes) and [multilingual](http://docs.wagtail.io/en/latest/advanced_topics/i18n/index.html) setup
        * Support for `i18n_patterns`
        * Support for generating a static API
        * Ready to use Wagtail Buildable views to build all your (un)published pages at once (no extra code required!)
        
        ## Installation
        
        ```
        pip install wagtail-bakery
        ```
        
        Add `bakery` and `wagtailbakery` to your `INSTALLED_APPS` setting.
        
        ```python
        INSTALLED_APPS = (
            # ...
            'bakery',
            'wagtailbakery',
        )
        ```
        
        ## Configuration
        
        Define whether you want to build multiple sites or the default site (see examples for impact on directory output), by default this settings is `False`.
        
        ```python
        BAKERY_MULTISITE = True
        ```
        
        Add the build directory where you want to be the site be built as flat files.
        
        ```python
        BUILD_DIR = '/tmp/build/'
        ```
        
        As 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.
        
        Build all published public pages (use for production).
        
        ```python
        BAKERY_VIEWS = (
        	'wagtailbakery.views.AllPublishedPagesView',
        )
        ```
        
        Build all published and unpublished public pages (use for staging/acceptance).
        
        ```python
        BAKERY_VIEWS = (
        	'wagtailbakery.views.AllPagesView',
        )
        ```
        
        To build static JSON files representing your site's API, use the following views:
        
        ```python
        BAKERY_VIEWS = (
        	'wagtailbakery.api_views.PagesAPIDetailView',
        	'wagtailbakery.api_views.PagesAPIListingView',
        	'wagtailbakery.api_views.TypedPagesAPIListingView',
        )
        ```
        
        The 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).
        
        ## Usage
        
        Build the site out as flat files by running the `build` management command.
        
        ```
        manage.py build
        ```
        
        If you want to check how your static website will look, use the `buildserver` command after you have build your static files once.
        
        ```
        manage.py buildserver
        ```
        
        ## Examples
        
        In 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.
        
        Create 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.
        
        As described in the usage section, use `manage.py build` to build out the example as static files.
        
        **Build output with `BAKERY_MULTISITE=True`**:
        
        ```
        build/example.com/index.html
        build/example.com/about/index.html
        build/example.com/blog/index.html
        build/example.com/blog/example/index.html
        build/static/
        ```
        
        **Build output with `BAKERY_MULTISITE=False` (default)**:
        
        ```
        build/index.html
        build/about/index.html
        build/blog/index.html
        build/blog/example/index.html
        build/static/
        ```
        
        ## Troubleshooting
        
        For issues [please submit an issue](https://github.com/wagtail/wagtail-bakery/issues/new) on GitHub.
        
        ## Development
        
        ### Releases
        
        1. Ensure you have the latest versions of `pip`, `setuptools` and `twine` installed in your virtual environment.
        1. Create a new branch (e.g. `release/1.1.3`) for the release of the new version.
        1. Update the version number in `setup.py` following [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
        1. Update `CHANGELOG.md`.
        1. On GitHub, create a pull request and squash merge it.
        1. Checkout and pull the `master` branch locally.
        1. (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.
        1. Use `make publish` and enter your PyPi credentials as needed.
        1. On GitHub, create a release and a tag for the new version.
        
        ## Credits
        
        Thanks to [@mhnbcu](https://github.com/mhnbcu/wagtailbakery) for bringing this
        idea up initially, and [Django Bakery](https://github.com/datadesk/django-bakery)
        for providing the initial bakery package.
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 1
Classifier: Framework :: Wagtail :: 2
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Provides-Extra: test
